Merge pull request #707 from taminomara/codestyle

Add linting for trailing whitespaces, newline symbols, etc.

Author: CppCXY

.github/workflows/build.yml

@@ -81,13 +81,13 @@ jobs:
       - name: Upload
         if: ${{ matrix.cross != 'zigbuild'  }}
         uses: actions/upload-artifact@v4
-        with: 
+        with:
           name: ${{ matrix.crate }}-${{ matrix.platform }}
           path: ${{ github.workspace }}/artifact/
       - name: Upload zigbuild
         if: ${{ matrix.cross == 'zigbuild'  }}
         uses: actions/upload-artifact@v4
-        with: 
+        with:
           name: ${{ matrix.crate }}-${{ matrix.platform }}-glibc.${{ matrix.glibc }}
           path: ${{ github.workspace }}/artifact/
   release:
@@ -136,7 +136,7 @@ jobs:
           7z a emmylua_doc_cli-win32-x64.zip emmylua_doc_cli.exe
       - name: Release
         uses: softprops/action-gh-release@v2
-        with: 
+        with:
           name: emmylua_ls
           draft: false
           generate_release_notes: true

.github/workflows/test.yml

@@ -25,15 +25,17 @@ jobs:
       uses: crate-ci/typos@master
 
   reformat:
-    name: Rustfmt
+    name: Code Style Check
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Install Rust toolchain
       uses: dtolnay/rust-toolchain@stable
-    - name: Run Rustfmt
-      run: cargo fmt --all -- --check
+    - name: Install pre-commit
+      run: pip install pre-commit
+    - name: Run style check
+      run: pre-commit run --all
 
   test:
     runs-on: ubuntu-latest

.github/workflows/upload_cachix.yml

@@ -17,12 +17,12 @@ jobs:
           - nixos-24.11 # remove this when 25.05 is out of beta
           - nixos-unstable
           - nixpkgs-unstable
-          
+
     runs-on: ubuntu-latest
     steps:
     - name: Clone repo
       uses: actions/checkout@v4
-      
+
     - name: Setup Nix
       uses: cachix/install-nix-action@v30
       with:
@@ -34,13 +34,13 @@ jobs:
     - name: Show the current nixpkgs version
       run: |
         nix eval --impure --raw --expr '"Building for nixpkgs " + (import <nixpkgs> { }).lib.version'
-    
+
     - name: Setup Cachix
       uses: cachix/cachix-action@v15
       with:
         name: emmylua-analyzer
         authToken: '${{ secrets.CACHIX }}'
-        
+
     - name: Build emmylua-analyzer
       run: |
         for x in emmylua_{ls,doc_cli,check}; do

.gitignore

@@ -1,4 +1,4 @@
 /target
 .idea
 .cursor
-dhat-heap.json
+dhat-heap.json

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: local
+    hooks:
+      - id: fmt
+        name: fmt
+        description: run cargo fmt
+        entry: cargo fmt
+        language: system
+        types: [ rust ]
+        args: [ "--all" ]
+        pass_filenames: false
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: [ --fix=lf ]
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+        exclude: ^.vscode/
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+        exclude_types: [ rust ]
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: check-vcs-permalinks

.vscode/launch.json

@@ -30,4 +30,4 @@
             "cwd": "${workspaceFolder}"
         },
     ]
-}
+}

.vscode/settings.json

@@ -1 +1,7 @@
-{}
+{
+    "files.eol": "\n",
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "files.trimTrailingWhitespaceInRegexAndStrings": true
+}

CHANGELOG.md

@@ -93,7 +93,7 @@ Note: The built-in formatter is not stylua, but emmyluacodestyle. This feature s
 ---@param f1 fun(...: T...): any
 ---@param ... T...
 function invoke(f1, ...)
-    
+
 end
 
 invoke(function(a, b, c) -- infer as: integer, integer, integer
@@ -279,7 +279,7 @@ Also supports immutability checks for iterator variables in for loop statements.
 ## [0.8.0] - 2025-5-30
 
 ### ✨ Added
-- **New Standard Types**: 
+- **New Standard Types**:
   - `std.Unpack` type for better `unpack` function inference
   - `std.Rawget` type for better `rawget` function inference
 - **Generator Support**: Implementation similar to `luals`
@@ -397,7 +397,7 @@ Global configuration have less priority than the local one
 - **Flow Analyze Algorithm**: Refactor flow analyze algorithm
 
 ### 🐛 Fixed
-- **Self Inference**: Fix some self infer issue 
+- **Self Inference**: Fix some self infer issue
 - **Diagnostic Action**: Fix some diagnostic action issue
 - **Type Check and Completion**: Optimize some type check and completion
 
@@ -429,7 +429,7 @@ Global configuration have less priority than the local one
 
 ### ✨ Added
 - **Re-index Control**: Disable re-index in default, need to enable by `workspace.enableReindex`
-- **New Diagnostics**: Add New Diagnostics `inject_field`, `missing_fields`, `redefined_local`, `undefined_field`, `inject-field`, `missing-global-doc`, 
+- **New Diagnostics**: Add New Diagnostics `inject_field`, `missing_fields`, `redefined_local`, `undefined_field`, `inject-field`, `missing-global-doc`,
 `incomplete-signature-doc`, `circle-doc-class`, `assign-type-mismatch`, `unbalanced_assignments`, `check_return_count`, `duplicate_require`, `circle_doc_class`, `incomplete_signature_doc`, `unnecessary_assert`
 - **Boolean Type Support**: Support `true` and `false` as type
 - **Compact Fun Return Syntax**: Compact luals fun return syntax like: `(name: string, age: number)`
@@ -497,7 +497,7 @@ Global configuration have less priority than the local one
   ```
 - **Enum Type Check Fix**: Fix enum type check
 - **Custom Operator Infer Fix**: Fix custom operator infer
-- **Select Function Fix and Std.Select Type Addition**: Fix select function and add std.Select type 
+- **Select Function Fix and Std.Select Type Addition**: Fix select function and add std.Select type
 - **Union Type Refactor**: Refactor Union type
 - **Description Support for Type**: Add description to type
 - **Multi Union Description Support**: Support description without '#' on multi union
@@ -541,7 +541,7 @@ Global configuration have less priority than the local one
 
 ---
 
-## [0.4.6] 
+## [0.4.6]
 
 ### 🐛 Fixed
 - **Executable File Directory Hierarchy Issue**: Fix issue with executable file directory hierarchy being too deep.

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing
+
+## Crates Overview
+
+Our project is organized into several crates:
+
+| Crate                                                          | Badge                                                                                                                                                   | Description |
+|----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| ----------- |
+| [🔍 **emmylua_parser**](./crates/emmylua_parser)               | [![emmylua_parser](https://img.shields.io/crates/v/emmylua_parser.svg?style=flat-square)](https://crates.io/crates/emmylua_parser)                      | The foundational Rust-based Lua parser engineered for maximum efficiency and accuracy. Powers all downstream analysis tools. |
+| [📑 **emmylua_parser_desc**](./crates/emmylua_parser_desc)     | [![emmylua_parser_desc](https://img.shields.io/crates/v/emmylua_parser_desc.svg?style=flat-square)](https://crates.io/crates/emmylua_parser_desc)       | Extension for EmmyLua-Parser that handles Markdown/RST highlighting in comments. |
+| [🧠 **emmylua_code_analysis**](./crates/emmylua_code_analysis) | [![emmylua_code_analysis](https://img.shields.io/crates/v/emmylua_code_analysis.svg?style=flat-square)](https://crates.io/crates/emmylua_code_analysis) | Advanced semantic analysis engine providing deep code understanding, type inference, and cross-reference resolution. |
+| [🖥️ **emmylua_ls**](./crates/emmylua_ls)                       | [![emmylua_ls](https://img.shields.io/crates/v/emmylua_ls.svg?style=flat-square)](https://crates.io/crates/emmylua_ls)                                  | The complete Language Server Protocol implementation offering rich IDE features across all major editors. |
+| [📚 **emmylua_doc_cli**](./crates/emmylua_doc_cli/)            | [![emmylua_doc_cli](https://img.shields.io/crates/v/emmylua_doc_cli.svg?style=flat-square)](https://crates.io/crates/emmylua_doc_cli)                   | Professional documentation generator creating beautiful, searchable API docs from your Lua code and annotations. |
+| [✅ **emmylua_check**](./crates/emmylua_check)                 | [![emmylua_check](https://img.shields.io/crates/v/emmylua_check.svg?style=flat-square)](https://crates.io/crates/emmylua_check)                         | Comprehensive static analysis tool for code quality assurance, catching bugs before they reach production. |
+
+
+## Testing
+
+We use the standard Rust testing harness, along with assert macros from [`googletest-rust`]:
+
+```shell
+# Run all tests
+cargo test
+
+# Run tests for specific crate
+cargo test -p emmylua_parser
+```
+
+If you're unfamiliar with `googletest-rust`, here's a quick overview:
+
+- Use `googletest::prelude::*` in your test modules, and annotate test functions with `#[gtest]`.
+
+- `assert_that!` checks a condition and panics on error:
+
+  ```rust
+  assert_that!(2 * 2, eq(4));
+  ```
+
+  Prefer `assert_that!(x, eq(y))` to `assert_eq` because the former generates a nice diff for you.
+
+- `expect_that!` checks a condition, marks test as failed on error, and continues execution.
+
+  This is useful when adding multiple test cases to a single `#[gtest]` function:
+
+  ```rust
+  // Both expectations will be evaluated and reported when test fails:
+  expect_that!(2 * 2, ne(4));
+  expect_that!(3 * 3, ne(9));
+  ```
+
+- `verify_that!` checks a condition and returns a `googletest::Result`.
+
+- `OrFail::or_fail` converts any `Optional` and `Result` to a `googletest::Result`. It also adds current location
+  to an error message. We have a wrapper around it called [`check!`].
+
+
+## Code style and formatting
+
+We use [`rustfmt`] and [`pre-commit`] to manage project's code style.
+
+- `rustfmt` formats Rust code. Simply run `cargo fmt --all` to reformat all files.
+
+- `pre-commit` fixes common issues like trailing whitespaces or broken symlinks in all text files.
+
+  To run it,
+
+  1. install [`pre-commit`][pre-commit-install],
+  2. invoke `pre-commit run --all`.
+
+  If it suits your workflow, you can configure PreCommit to run before every commit. To do so, run `pre-commit install`.
+  Note that this is not required because our CI will detect any issues.
+
+[`googletest-rust`]: https://github.com/google/googletest-rust/
+[`rustfmt`]: https://rust-lang.github.io/rustfmt/
+[`pre-commit`]: https://pre-commit.com/#install
+[pre-commit-install]: https://pre-commit.com/#install
+[`check!`]: https://github.com/search?q=repo%3AEmmyLuaLs%2Femmylua-analyzer-rust%20macro_rules!%20check&type=code

Cargo.toml

@@ -15,7 +15,7 @@ emmylua_diagnostic_macro = { path = "crates/emmylua_diagnostic_macro", version =
 # external
 lsp-server = "0.7.7"
 tokio = { version = "1.46", features = ["full"] }
-serde = { version = "1.0.219", features = ["derive"] } 
+serde = { version = "1.0.219", features = ["derive"] }
 serde_json = "1.0.141"
 rowan = { version = "0.16.1" }
 notify = { version = "8.1.0", features = ["serde"] }