Updated module versions and README (#52)

* updating rockspec for new versions/release

* removing macos build

* Update README.md

Author: FourierTransformer

.github/workflows/create-binaries.yml

@@ -7,30 +7,32 @@ on:
   pull_request:
 
 jobs:
-  macos:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos, macos-arm64]
-        include:
-        - os: macos
-          runner: macos-13
-        - os: macos-arm64
-          runner: macos-latest
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.runner }}
-    steps:
-      # Checks-out the repository under $GITHUB_WORKSPACE.
-      - uses: actions/checkout@v4
-      - name: Build teal-language-server (${{ matrix.os }})
-        shell: bash
-        run: |
-          ./scripts/create_binary.sh
-      - uses: actions/upload-artifact@v4
-        if: always()
-        with:
-          name: tls-${{matrix.os}}
-          path: "./tls"
+  # Not doing macos for now, we can get back to it in https://github.com/teal-language/teal-language-server/issues/53
+  # macos:
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       os: [macos, macos-arm64]
+  #       include:
+  #       - os: macos
+  #         runner: macos-13
+  #       - os: macos-arm64
+  #         runner: macos-latest
+  #   name: ${{ matrix.os }}
+  #   runs-on: ${{ matrix.runner }}
+  #   steps:
+  #     # Checks-out the repository under $GITHUB_WORKSPACE.
+  #     - uses: actions/checkout@v4
+  #     - name: Build teal-language-server (${{ matrix.os }})
+  #       shell: bash
+  #       run: |
+  #         ./scripts/create_binary.sh
+  #         codesign -s - "./tls/bin/lua"
+  #     - uses: actions/upload-artifact@v4
+  #       if: always()
+  #       with:
+  #         name: tls-${{matrix.os}}
+  #         path: "./tls"
 
   windows:
     strategy:
@@ -40,7 +42,7 @@ jobs:
       # waiting on new luarocks release for fix, so we don't need to install via choco
       - name: install tree-sitter-cli
         run: | 
-          choco install tree-sitter --version 0.24.4
+          choco install tree-sitter --version 0.24.7
       - name: verify tree-sitter-cli is installed on path
         run: tree-sitter --version
 
@@ -51,7 +53,7 @@ jobs:
       - uses: luarocks/gh-actions-luarocks@v5
 
       - name: luarocks workaround for tree-sitter
-        run: luarocks config --lua-version 5.4 rocks_provided.tree-sitter-cli 0.24.4-2
+        run: luarocks config --lua-version 5.4 rocks_provided.tree-sitter-cli 0.24.7-2
 
       - name: Build teal-language-server
         run: | 

README.md

@@ -1,18 +1,21 @@
+[![test](https://github.com/teal-language/teal-language-server/actions/workflows/test.yml/badge.svg)](https://github.com/teal-language/teal-language-server/actions/workflows/test.yml)
 
 # Teal Language Server
 
 A language server for the [Teal language](https://github.com/teal-language/tl)
 
-[![test](https://github.com/teal-language/teal-language-server/actions/workflows/test.yml/badge.svg)](https://github.com/teal-language/teal-language-server/actions/workflows/test.yml)
 
-# Installation
+## Installation
 
-### From luarocks
+### From luarocks (Linux and macOS)
 
 * `luarocks install teal-language-server`
-* `teal-language-server`
+* The `teal-language-server` program should be installed
 
-Tested on Windows, Linux and macOS
+Tested on Linux and macOS. It's currently a bit of a struggle to install via LuaRocks on Windows. We recommend using the binaries from the release on Windows.
+
+### From GitHub Release Binaries (Windows)
+We provide binaries for Windows on our [GitHub Release](https://github.com/teal-language/teal-language-server/releases) page. You should be able to download and extract the the latest version from there.
 
 ### From source
 
@@ -21,14 +24,14 @@ Tested on Windows, Linux and macOS
   * `scripts/setup_local_luarocks`
   * `./lua_modules/bin/teal-language-server`
 
-# Features
+## Features
 
 * Go to definition (`textDocument/definition`)
 * Linting (`textDocument/publishDiagnostics`)
 * Intellisense (`textDocument/completion`)
 * Hover (`textDocument/hover`)
 
-# Editor Setup
+## Editor Setup
 
 ### Neovim
 
@@ -37,10 +40,14 @@ Install the [lspconfig plugin](https://github.com/neovim/nvim-lspconfig) and put
 ```lua
 local lspconfig = require("lspconfig")
 
+-- as long as teal-language-server is in your PATH this should work
 lspconfig.teal_ls.setup {}
+
+-- if it's not in your path, you can specify where teal-languag-server is by setting cmd. For example on Windows:
+-- lspconfig.teal_ls.setup({cmd = { 'C:\\opt\\tls-windows\\bin\\teal-language-server.bat' },})
 ```
 
-# Usage
+## Usage
 
 ```
 teal-language-server [--verbose=true] [--log-mode=none|by_proj_path|by_date]
@@ -50,5 +57,5 @@ Note:
 
 * All args are optional
 * By default, logging is 'none' which disables logging completely
-* When logging is set to by_proj_path or by_date, the log is output to `[User Home Directory]/.cache/teal-language-server`
+* When logging is set to `by_proj_path` or `by_date`, the log is output to `[User Home Directory]/.cache/teal-language-server`
 

luarocks.lock

@@ -1,20 +1,19 @@
 return {
    build_dependencies = {
       luafilesystem = "1.8.0-1",
-      ["luarocks-build-tree-sitter-cli"] = "0.0.2-1",
       ["luarocks-build-treesitter-parser"] = "6.0.0-1"
    },
    dependencies = {
       argparse = "0.7.1-1",
       compat53 = "0.14.4-1",
       inspect = "3.1.3-0",
-      ["ltreesitter-ts"] = "0.0.1-1",
+      ltreesitter = "0.1.0-1",
       ["lua-cjson"] = "2.1.0.10-1",
       luafilesystem = "1.8.0-1",
       lusc_luv = "4.0.1-1",
-      luv = "1.50.0-1",
-      tl = "0.24.4-1",
-      ["tree-sitter-cli"] = "0.24.4-2",
-      ["tree-sitter-teal"] = "0.0.33-1"
+      luv = "1.51.0-0",
+      tl = "0.24.5-1",
+      ["tree-sitter-cli"] = "0.24.7-2",
+      ["tree-sitter-teal"] = "0.0.34-1"
    },
 }

scripts/create_binary.sh

@@ -13,7 +13,8 @@ hererocks -l "@v5.4.7" -r "@v3.11.1" tls
 source tls/bin/activate
 luarocks make
 
-# TODO: see if we can just make this a build dependency?
+# tree-sitter-cli can't be added temporarily (as like a build dep),
+# so we can just remove it since we don't need it after the fact
 luarocks remove --force tree-sitter-cli
 
 rm -f ./tls/bin/activate* ./tls/bin/get_deactivated_path.lua

teal-language-server-0.1.1-1.rockspec teal-language-server-0.1.2-1.rockspecteal-language-server-0.1.1-1.rockspec renamed to teal-language-server-0.1.2-1.rockspec

@@ -1,11 +1,11 @@
 rockspec_format = "3.0"
 
 package = "teal-language-server"
-version = "0.1.1-1"
+version = "0.1.2-1"
 
 source = {
    url = "git+https://github.com/teal-language/teal-language-server.git",
-   tag = "0.1.1"
+   tag = "0.1.2"
 }
 
 description = {
@@ -21,15 +21,16 @@ build_dependencies = {
 
 dependencies = {
    "luafilesystem",
-   "tl == 0.24.4",
+   "tl == 0.24.5",
    "lua-cjson",
    "argparse",
    "inspect",
-   "luv ~> 1",
+   "luv == 1.51.0",
    "lusc_luv >= 4.0",
-   "ltreesitter-ts == 0.0.1", -- can be removed when ltreesitter updates
-   "tree-sitter-cli == 0.24.4",
-   "tree-sitter-teal == 0.0.33",
+   "ltreesitter == 0.1.0", 
+   -- can update tree-sitter-cli version once tree-sitter-teal gets a new release
+   "tree-sitter-cli == 0.24.7", -- can't really be  a build dep, even though it's uneeded after install
+   "tree-sitter-teal == 0.0.34",
 }
 
 test_dependencies = { "busted~>2" }