Merge pull request #174 from link-foundation/issue-166-0169a4dd2a40

Add automatic linter/static checks for all supported languages

Author: konard

.github/workflows/csharp.yml

@@ -47,10 +47,28 @@ jobs:
           echo "isCsFilesChanged=${isCsFilesChanged}" >> $GITHUB_OUTPUT
           echo "isCsFilesChanged: ${isCsFilesChanged}"
 
-  test:
+  lint:
     needs: [findChangedCsFiles]
     if: ${{ needs.findChangedCsFiles.outputs.isCsFilesChanged == 'true' }}
     runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v5
+        with:
+          dotnet-version: '8.0.x'
+      - name: Restore Dependencies
+        run: dotnet restore
+      - name: Check formatting
+        run: dotnet format --verify-no-changes --verbosity diagnostic
+
+  test:
+    needs: [findChangedCsFiles, lint]
+    if: ${{ needs.findChangedCsFiles.outputs.isCsFilesChanged == 'true' }}
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v5
@@ -67,7 +85,6 @@ jobs:
       - name: Test
         run: dotnet test --configuration Release --no-build -f net8
 
-
   pushToNuget:
     runs-on: ubuntu-latest
     timeout-minutes: 15

.github/workflows/js.yml

@@ -47,10 +47,28 @@ jobs:
           echo "isJsFilesChanged=${isJsFilesChanged}" >> $GITHUB_OUTPUT
           echo "isJsFilesChanged: ${isJsFilesChanged}"
 
-  test:
+  lint:
     needs: [findChangedJsFiles]
     if: ${{ needs.findChangedJsFiles.outputs.isJsFilesChanged == 'true' }}
     runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - name: Install Dependencies
+        run: bun install
+      - name: Lint
+        run: bun run lint
+
+  test:
+    needs: [findChangedJsFiles, lint]
+    if: ${{ needs.findChangedJsFiles.outputs.isJsFilesChanged == 'true' }}
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v5

.github/workflows/python.yml

@@ -47,10 +47,34 @@ jobs:
           echo "isPythonFilesChanged=${isPythonFilesChanged}" >> $GITHUB_OUTPUT
           echo "isPythonFilesChanged: ${isPythonFilesChanged}"
 
-  test:
+  lint:
     needs: [findChangedPythonFiles]
     if: ${{ needs.findChangedPythonFiles.outputs.isPythonFilesChanged == 'true' }}
     runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.13'
+      - name: Install linting tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install black isort flake8
+      - name: Check formatting with Black
+        run: black --check --diff .
+      - name: Check import sorting with isort
+        run: isort --check-only --diff .
+      - name: Lint with flake8
+        run: flake8 --max-line-length=120
+
+  test:
+    needs: [findChangedPythonFiles, lint]
+    if: ${{ needs.findChangedPythonFiles.outputs.isPythonFilesChanged == 'true' }}
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v5

.github/workflows/rust.yml

@@ -47,10 +47,38 @@ jobs:
           echo "isRustFilesChanged=${isRustFilesChanged}" >> $GITHUB_OUTPUT
           echo "isRustFilesChanged: ${isRustFilesChanged}"
 
-  test:
+  lint:
     needs: [findChangedRustFiles]
     if: ${{ needs.findChangedRustFiles.outputs.isRustFilesChanged == 'true' }}
     runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+      - name: Cache Cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+      - name: Run Clippy
+        run: cargo clippy --all-targets --all-features -- -D warnings
+
+  test:
+    needs: [findChangedRustFiles, lint]
+    if: ${{ needs.findChangedRustFiles.outputs.isRustFilesChanged == 'true' }}
+    runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
       - uses: actions/checkout@v5

.pre-commit-config.yaml

@@ -49,6 +49,7 @@ repos:
     hooks:
       - id: fmt
       - id: cargo-check
+      - id: clippy
 
   # Markdown
   - repo: https://github.com/igorshubovych/markdownlint-cli

csharp/README.md

@@ -141,6 +141,35 @@ mama has house
 - **IListExtensions.Format()**: Converts list of links back to string format
 - **ILinksGroupListExtensions**: Additional operations for link groups
 
+## Maintenance
+
+### Linting and Formatting
+
+Check code formatting:
+
+```bash
+dotnet format --verify-no-changes --verbosity diagnostic
+```
+
+Auto-fix formatting:
+
+```bash
+dotnet format
+```
+
+### Pre-commit Hooks
+
+This project uses pre-commit hooks. To set up pre-commit hooks locally:
+
+```bash
+# From repository root
+pip install pre-commit
+pre-commit install
+```
+
+Note: C# formatting checks are integrated into the CI pipeline using
+`dotnet format`.
+
 ## Dependencies
 
 - .NET 8.0

js/.eslintrc.json

@@ -0,0 +1,32 @@
+{
+  "env": {
+    "browser": false,
+    "es2021": true,
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "globals": {
+    "describe": "readonly",
+    "test": "readonly",
+    "it": "readonly",
+    "expect": "readonly",
+    "beforeEach": "readonly",
+    "afterEach": "readonly",
+    "beforeAll": "readonly",
+    "afterAll": "readonly"
+  },
+  "rules": {
+    "no-unused-vars": "warn",
+    "no-undef": "error",
+    "semi": ["error", "always"],
+    "quotes": ["warn", "single", { "avoidEscape": true }]
+  },
+  "ignorePatterns": [
+    "dist/",
+    "node_modules/",
+    "src/parser-generated.js"
+  ]
+}

js/README.md

@@ -207,6 +207,33 @@ Container for grouping related links.
 - `src/index.js` - Main entry point
 - `tests/` - Test files
 
+## Maintenance
+
+### Linting
+
+Run ESLint to check for code style issues:
+
+```bash
+bun run lint
+```
+
+Auto-fix linting issues:
+
+```bash
+bun run lint:fix
+```
+
+### Pre-commit Hooks
+
+This project uses pre-commit hooks that automatically run ESLint before commits.
+To set up pre-commit hooks locally:
+
+```bash
+# From repository root
+pip install pre-commit
+pre-commit install
+```
+
 ## Dependencies
 
 - Peggy.js (5.0.6) - Parser generator

js/package.json

@@ -8,7 +8,9 @@
     "build": "bun run build:grammar && bun build src/index.js --outdir=dist --target=node",
     "build:grammar": "peggy --format es -o src/parser-generated.js src/grammar.pegjs",
     "test": "bun test",
-    "test:watch": "bun test --watch"
+    "test:watch": "bun test --watch",
+    "lint": "eslint src/ tests/",
+    "lint:fix": "eslint src/ tests/ --fix"
   },
   "keywords": [
     "lino",
@@ -20,6 +22,7 @@
   "license": "Unlicense",
   "devDependencies": {
     "bun-types": "^1.2.19",
+    "eslint": "^8.56.0",
     "peggy": "^5.0.6"
   },
   "dependencies": {}

python/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+max-line-length = 120
+extend-ignore = E203, W503
+per-file-ignores =
+    # E402: module level import not at top of file - needed for path setup
+    run_tests.py:E402
+    tests/test_links_group.py:E402
+    tests/test_nested_self_reference.py:E402