diff --git a/Docker/Dockerfile b/Docker/Dockerfile index ef48ae1..2e1e53d 100644 --- a/Docker/Dockerfile +++ b/Docker/Dockerfile @@ -111,6 +111,10 @@ RUN npm --version RUN java --version # # 5. Cleanup +RUN apt-get autoremove --purge +RUN apt-get autoclean + +RUN rm -rf /var/lib/apt/lists/* RUN rm -rf /tmp/* RUN rm -rf "${NVM_DIR}/.cache" RUN rm /app/requirements.txt diff --git a/Docker/build.sh b/Docker/build.sh index 87f2462..8db7861 100755 --- a/Docker/build.sh +++ b/Docker/build.sh @@ -1,6 +1,6 @@ #!/bin/bash -# . CONFIG.sh +. scripts/CONFIG.sh # set -o xtrace ## To debug scripts # set -o errexit ## To exit on error @@ -8,10 +8,10 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}/.." echo "Working Dir: " $(pwd) - podman build -t newton-lsp -f Docker/Dockerfile . + podman build -t "${CONTAINER}" -f Docker/Dockerfile . } main $@; diff --git a/Docker/reference-servers/LICENSE b/Docker/reference-servers/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/Docker/reference-servers/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Docker/reference-servers/README.md b/Docker/reference-servers/README.md index 7f1cb68..cb83f1c 100644 --- a/Docker/reference-servers/README.md +++ b/Docker/reference-servers/README.md @@ -1,2 +1,2 @@ ## Credit -Files here were copied from https://github.com/lspcontainers/dockerfiles/servers. \ No newline at end of file +Files here were copied from https://github.com/lspcontainers/dockerfiles/. \ No newline at end of file diff --git a/Docker/scripts/CONFIG.sh b/Docker/scripts/CONFIG.sh new file mode 100644 index 0000000..9ccc18c --- /dev/null +++ b/Docker/scripts/CONFIG.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +# set -o xtrace ## To debug scripts +# set -o errexit ## To exit on error +# set -o errunset ## To exit if a variable is referenced but not set + + +CONTAINER="newton-lsp" \ No newline at end of file diff --git a/Docker/scripts/clean.sh b/Docker/scripts/clean.sh index 451769e..102c9ad 100755 --- a/Docker/scripts/clean.sh +++ b/Docker/scripts/clean.sh @@ -1,6 +1,6 @@ #!/bin/bash -# . CONFIG.sh +. CONFIG.sh # set -o xtrace ## To debug scripts # set -o errexit ## To exit on error @@ -8,7 +8,7 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) diff --git a/Docker/scripts/interactive-shell.sh b/Docker/scripts/interactive-shell.sh index b0efe7f..f462082 100755 --- a/Docker/scripts/interactive-shell.sh +++ b/Docker/scripts/interactive-shell.sh @@ -1,6 +1,6 @@ #!/bin/bash -# . CONFIG.sh +. CONFIG.sh # set -o xtrace ## To debug scripts # set -o errexit ## To exit on error @@ -8,11 +8,11 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) - ID=$(podman ps --filter "ancestor=localhost/newton-lsp:latest" --format "{{.ID}}") + ID=$(podman ps --filter "ancestor=localhost/${CONTAINER}:latest" --format "{{.ID}}") if [ "${ID}" == "" ]; then echo "Is not up..." exit 1 diff --git a/Docker/scripts/reset.sh b/Docker/scripts/reset.sh index 63a14c7..9aedc1e 100755 --- a/Docker/scripts/reset.sh +++ b/Docker/scripts/reset.sh @@ -8,7 +8,7 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) @@ -20,6 +20,8 @@ function main() { podman machine stop podman machine reset podman machine init + podman machine set --memory 4096 + # podman machine set --cpus 2 --memory 4096 podman machine start } main $@; diff --git a/Docker/scripts/run.sh b/Docker/scripts/run.sh index f1a0982..562f8cc 100755 --- a/Docker/scripts/run.sh +++ b/Docker/scripts/run.sh @@ -8,7 +8,7 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) diff --git a/Docker/scripts/start.sh b/Docker/scripts/start.sh index 56e2972..fd68d90 100755 --- a/Docker/scripts/start.sh +++ b/Docker/scripts/start.sh @@ -1,6 +1,6 @@ #!/bin/bash -# . CONFIG.sh +. CONFIG.sh # set -o xtrace ## To debug scripts # set -o errexit ## To exit on error @@ -8,11 +8,11 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) - ID=$(podman ps --filter "ancestor=localhost/newton-lsp:latest" --format "{{.ID}}") + ID=$(podman ps --filter "ancestor=localhost/${CONTAINER}:latest" --format "{{.ID}}") if [ "${ID}" != "" ]; then echo "Is up..." exit 1 @@ -32,6 +32,6 @@ function main() { -e JDTLS_DATA_PATH="${JDTLS_CONFIG_PATH}/data" \ -v "${CODE_HOST}":"${CODE_CONTAINER}" \ -v "${CONFIG_HOST}":"${CONFIG_CONTAINER}" \ - newton-lsp:latest + "${CONTAINER}:latest" } main $@; diff --git a/Docker/scripts/stop.sh b/Docker/scripts/stop.sh index 2ec6c42..6f50bd4 100755 --- a/Docker/scripts/stop.sh +++ b/Docker/scripts/stop.sh @@ -1,6 +1,6 @@ #!/bin/bash -# . CONFIG.sh +. CONFIG.sh # set -o xtrace ## To debug scripts # set -o errexit ## To exit on error @@ -8,11 +8,11 @@ function main() { - SCRIPTPATH="$( cd "$(dirname "")" >/dev/null 2>&1 ; pwd -P )" + SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )" cd "${SCRIPTPATH}" echo "Working Dir: " $(pwd) - ID=$(podman ps --filter "ancestor=localhost/newton-lsp:latest" --format "{{.ID}}") + ID=$(podman ps --filter "ancestor=localhost/${CONTAINER}:latest" --format "{{.ID}}") if [ "${ID}" == "" ]; then echo "Is not up..." exit 1 diff --git a/README.md b/README.md index 56f2835..e4ccfa3 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ ## Credit * https://github.com/mkslanc/websockets-ls -* https://github.com/lspcontainers/dockerfiles/servers +* https://github.com/lspcontainers/dockerfiles/ ## Overview -This repo provides a primary Dockerfile (with additional example standalone LSP Dockler files from `lspcontainers`) that packages a number of LSPs and tools into a container along with the src/ folder code. -The code under src/ comes from `websockets-ls` and has been cleaned up and formatted to my style/asthetics as well as modified server list. +This repo provides a primary Dockerfile with additional examples that are seperate in form and structure but useful for reference. +LSP Docker files under `reference-servers` are from `lspcontainers`project that packages a number of LSPs. +The code under src/ comes from `websockets-ls` and has been cleaned up and formatted to my style/asthetics as well as modified server list. (I.E NO structural changes) The code creates a WebSocket bridge to interface with multiple Language Servers through clients via a single WebSocket connection. It supports various language servers concurrently and handles language-specific file extensions and initialization parameters. @@ -20,7 +21,18 @@ It supports various language servers concurrently and handles language-specific - Temporary file creation for `textDocument/didOpen` events. ## Usage -##### Setup 1: +##### Option 1: + +1. Install Podman. +2. Create `opt/` folder in `Docker/` and add any additional programs (lsps) there. +3. Configure the desired language servers in `src/defaultServers.js`. +3. Configure the start script at `Docker/scripts/start.sh` with any additional env args or mount points. +4. Run from `Newton-LSP/` `Docker/build.sh` . +5. Run `Docker/scripts/start.sh` +6. Connect to the WebSocket server on `ws://localhost:9999/`. +7. Transmit LSP messages via the WebSocket connection. + +##### Option 2: 1. Install Node.js. 2. Run 'npm install'. @@ -29,17 +41,6 @@ It supports various language servers concurrently and handles language-specific 5. Connect to the WebSocket server on `ws://localhost:9999/`. 6. Transmit LSP messages via the WebSocket connection. -##### Setup 2: - -1. Install Podman. -2. Create `opt/` folder in `Docker/` and add any additional programs there. -3. Configure the desired language servers in `src/defaultServers.js`. -3. Configure the start script at `Docker/scripts/start.sh` with abny additional env args or mount points. -4. Run from `Newton-LSP/` `Docker/build.sh` . -5. Run `Docker/scripts/start.sh` -6. Connect to the WebSocket server on `ws://localhost:9999/`. -7. Transmit LSP messages via the WebSocket connection. - ## Configuration Add or modify language server configurations in `languageServers.js`: diff --git a/src/LICENSE b/src/LICENSE new file mode 100644 index 0000000..eeed458 --- /dev/null +++ b/src/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Azat Alimov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..7bdca5f --- /dev/null +++ b/src/README.md @@ -0,0 +1,2 @@ +## Credit +Files here were copied from https://github.com/mkslanc/websockets-ls. \ No newline at end of file