nanos-lint 2.5.0 → 2.6.1

package/README.md

@@ -1,6 +1,7 @@
 # nanos-lint
 
 [![CI](https://github.com/vugi99/nanos-lint/actions/workflows/ci.yml/badge.svg)](https://github.com/vugi99/nanos-lint/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/nanos-lint.svg)](https://www.npmjs.com/package/nanos-lint)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D24-brightgreen.svg)](https://nodejs.org/)
 [![Lua Version](https://img.shields.io/badge/Lua-5.4.9-blue.svg)](https://www.lua.org/manual/5.4/)
 [![LuaLS Version](https://img.shields.io/badge/LuaLS-3.19.1-brightgreen.svg)](https://github.com/LuaLS/lua-language-server)
@@ -95,10 +96,12 @@ jobs:
 | `path` | Path to workspace directory or Lua file to check | `.` |
 | `checklevel` | Minimum severity to report (`Error`, `Warning`, `Information`, `Hint`) | `Warning` |
 | `config` | Path to a custom `.luarc.json` configuration file | `""` |
+| `annotations` | Path to a custom `annotations.lua` file | `""` |
 | `ignore` | Files or directories to ignore (supports glob patterns, newline or comma separated) | `""` |
 | `luals-version` | Version of `lua-language-server` to use | `latest` |
 | `fail-on-error` | Fail the workflow step if diagnostics are found | `true` |
 | `quiet` | Suppress progress messages | `false` |
+| `cache` | Whether to cache the LuaLS binary and annotations across workflow runs | `true` |
 
 When running inside GitHub Actions, `nanos-lint` automatically outputs **workflow annotations** (`::error` / `::warning`) that appear inline on PR diffs.
 
@@ -113,6 +116,7 @@ COMMANDS:
   check [path]             Check a workspace or Lua file (default)
   init [path]              Scaffold a .luarc.json configuration in the workspace (copies definitions to .nanos-lint/)
   download-luals [version] Download and cache the LuaLS binary
+  clean-cache, clean       Clear the nanos-lint cache directory
   help, --help, -h         Show help message
   version, --version, -v   Show version information
 
@@ -120,6 +124,7 @@ OPTIONS:
   -i, --ignore <pattern>   Files or directories to ignore (supports globs, repeatable, comma/newline-separated)
   --checklevel=<level>     Minimum diagnostic level: Error, Warning, Information, Hint (default: Warning)
   --config=<path>          Path to custom .luarc.json configuration file
+  --annotations=<path>     Path to custom annotations.lua file
   --format=<format>        Output format: pretty, json, github (default: pretty)
   --github                 Output in GitHub Actions format (shortcut for --format=github)
   --luals-version=<ver>    Version of LuaLS to use (default: latest)
@@ -133,6 +138,8 @@ OPTIONS:
 | Variable | Description |
 | :--- | :--- |
 | `LUALS_BIN` | Explicit path to a pre-installed `lua-language-server` binary |
+| `NANOS_ANNOTATIONS_PATH`, `NANOS_ANNOTATIONS` | Explicit path to a custom `annotations.lua` file |
+| `GITHUB_TOKEN` | GitHub personal access token used for authenticated GitHub API requests (avoids unauthenticated rate limits) |
 | `NO_COLOR` | Disables ANSI color output when set to any non-empty value |
 | `FORCE_COLOR` | Forces ANSI color output even in non-TTY environments |
 
@@ -165,41 +172,38 @@ npx nanos-lint init --force
 
 ---
 
-## Standalone Binary Distributions (Offline / CD)
+## Pre-packaged Release Distributions (Offline / CD)
 
-For environments without Node.js, pre-packaged release bundles containing the compiled `lua-language-server` binary and nanos-lint wrapper are available on the [Releases](https://github.com/vugi99/nanos-lint/releases) page:
+Pre-packaged release bundles containing the platform's `lua-language-server` binary, vendored `annotations.lua`, and the nanos-lint CLI wrapper are available on the [Releases](https://github.com/vugi99/nanos-lint/releases) page:
 
 - `nanos-lint-<version>-windows-x64.zip`
 - `nanos-lint-<version>-linux-x64.tar.gz`
 
-Simply extract the archive and run `./nanos-lint` (Linux) or `nanos-lint.cmd` (Windows).
+These bundles are fully self-contained and ready for offline CI/CD environments with Node.js installed, eliminating the need to download LuaLS or annotations at runtime. Simply extract the archive and run `./nanos-lint` (Linux) or `nanos-lint.cmd` (Windows).
 
 ---
 
 ## Development
 
 ```bash
-# Clone with submodules
-git clone --recursive https://github.com/vugi99/nanos-lint.git
+# Clone the repository
+git clone https://github.com/vugi99/nanos-lint.git
 cd nanos-lint
 
 # Install dependencies
 npm install
 
-# Update annotations submodule from upstream
-git submodule update --remote --merge
-
 # Run ESLint
 npm run lint
 
 # Run type check
 npm run typecheck
 
-# Run Vitest test suite (unit + live LuaLS integration tests)
-npm test
-
 # Build distribution bundle
 npm run build
+
+# Run Vitest test suite with coverage (unit + live LuaLS integration tests)
+npm run test:coverage
 ```
 
 See [AGENTS.md](AGENTS.md) for development philosophy and quality gate requirements.

package/action.yml

@@ -18,6 +18,10 @@ inputs:
     description: 'Path to a custom .luarc.json configuration file'
     required: false
     default: ''
+  annotations:
+    description: 'Path to a custom annotations.lua file'
+    required: false
+    default: ''
   luals-version:
     description: 'Version of LuaLS to use (or "latest")'
     required: false
@@ -34,6 +38,10 @@ inputs:
     description: 'Files or directories to ignore (supports glob patterns, multiple entries can be newline or comma separated)'
     required: false
     default: ''
+  cache:
+    description: 'Whether to cache the LuaLS binary and annotations across workflow runs'
+    required: false
+    default: 'true'
 
 runs:
   using: 'composite'
@@ -43,12 +51,26 @@ runs:
       with:
         node-version: '24'
 
+    - name: Cache LuaLS binary and annotations
+      if: ${{ inputs.cache != 'false' }}
+      uses: actions/cache@v6
+      with:
+        path: |
+          ~/.cache/nanos-lint
+          ~/AppData/Local/nanos-lint
+          ~/Library/Caches/nanos-lint
+        key: nanos-lint-${{ runner.os }}-${{ inputs.luals-version }}
+        restore-keys: |
+          nanos-lint-${{ runner.os }}-${{ inputs.luals-version }}-
+          nanos-lint-${{ runner.os }}-
+
     - name: Run nanos-lint
       shell: bash
       env:
         INPUT_PATH: ${{ inputs.path }}
         INPUT_CHECKLEVEL: ${{ inputs.checklevel }}
         INPUT_CONFIG: ${{ inputs.config }}
+        INPUT_ANNOTATIONS: ${{ inputs.annotations }}
         INPUT_LUALS_VERSION: ${{ inputs.luals-version }}
         INPUT_FAIL_ON_ERROR: ${{ inputs.fail-on-error }}
         INPUT_QUIET: ${{ inputs.quiet }}
@@ -61,6 +83,10 @@ runs:
           ARGS+=("--config=$INPUT_CONFIG")
         fi
 
+        if [ -n "$INPUT_ANNOTATIONS" ]; then
+          ARGS+=("--annotations=$INPUT_ANNOTATIONS")
+        fi
+
         if [ -n "$INPUT_IGNORE" ]; then
           while IFS= read -r line || [ -n "$line" ]; do
             trimmed=$(echo "$line" | xargs)
@@ -81,7 +107,7 @@ runs:
         if [ -f "$ACTION_PATH/dist/cli.js" ]; then
           node "$ACTION_PATH/dist/cli.js" "${ARGS[@]}"
         else
-          npx --yes nanos-lint@^2.1.0 "${ARGS[@]}"
+          npx --yes nanos-lint@^2.6.1 "${ARGS[@]}"
         fi