Add support for Nim (with tests)

build.rs

@@ -236,6 +236,11 @@ fn main() {
             src_dir: "vendored_parsers/tree-sitter-newick-src",
             extra_files: vec![],
         },
+        TreeSitterParser {
+            name: "tree-sitter-nim",
+            src_dir: "vendored_parsers/tree-sitter-nim-src",
+            extra_files: vec!["scanner.c"],
+        },
         TreeSitterParser {
             name: "tree-sitter-nix",
             src_dir: "vendored_parsers/tree-sitter-nix-src",

sample_files/compare.expected

@@ -157,6 +157,9 @@ a1d520d7a425c9eed529b8b108eaee3e  -
 sample_files/newick_before.nwk sample_files/newick_after.nwk
 0f7bdff87a79f997b850e67d38a1c910  -
 
+sample_files/nim_before.nim sample_files/nim_after.nim
+785647f7b0f04721cc87ded35a1088f9  -
+
 sample_files/nix_before.nix sample_files/nix_after.nix
 e00b95a4cf3fa3edf994155d8656063f  -
 

sample_files/nim_after.nim

@@ -0,0 +1,5 @@
+proc hello(a: string, b: int): string =
+  for i in 0..3:
+    echo "hello ", a, b
+
+hello "world", 69

sample_files/nim_before.nim

@@ -0,0 +1,5 @@
+proc hello(a: string): string =
+  echo "hello ", a
+
+when isMainModule:
+  hello("world")

src/parse/guess_language.rs

@@ -52,6 +52,7 @@ pub(crate) enum Language {
     Lua,
     Make,
     Newick,
+    Nim,
     Nix,
     ObjC,
     OCaml,
@@ -141,6 +142,7 @@ pub(crate) fn language_name(language: Language) -> &'static str {
         Lua => "Lua",
         Make => "Make",
         Newick => "Newick",
+        Nim => "Nim",
         Nix => "Nix",
         ObjC => "Objective-C",
         OCaml => "OCaml",
@@ -320,6 +322,7 @@ pub(crate) fn language_globs(language: Language) -> Vec<glob::Pattern> {
             "mkfile",
         ],
         Newick => &["*.nhx", "*.nwk", "*.nh"],
+        Nim => &["*.nim", "*.nims", "*.nimble"],
         Nix => &["*.nix"],
         ObjC => &["*.m"],
         OCaml => &["*.ml"],

src/parse/tree_sitter_parser.rs

@@ -93,6 +93,7 @@ extern "C" {
     fn tree_sitter_lua() -> ts::Language;
     fn tree_sitter_make() -> ts::Language;
     fn tree_sitter_newick() -> ts::Language;
+    fn tree_sitter_nim() -> ts::Language;
     fn tree_sitter_nix() -> ts::Language;
     fn tree_sitter_objc() -> ts::Language;
     fn tree_sitter_ocaml() -> ts::Language;
@@ -725,6 +726,28 @@ pub(crate) fn from_language(language: guess::Language) -> TreeSitterConfig {
                 sub_languages: vec![],
             }
         }
+        Nim => {
+            let language = unsafe { tree_sitter_nim() };
+            TreeSitterConfig {
+                language,
+                atom_nodes: vec![
+                    "string_expression",
+                    "indented_string_expression",
+                    "long_string_expression",
+                ]
+                .into_iter()
+                .collect(),
+                delimiter_tokens: vec![("{", "}"), ("[", "]"), ("(", ")")]
+                    .into_iter()
+                    .collect(),
+                highlight_query: ts::Query::new(
+                    language,
+                    include_str!("../../vendored_parsers/highlights/nim.scm"),
+                )
+                .unwrap(),
+                sub_languages: vec![],
+            }
+        }
         Nix => {
             let language = unsafe { tree_sitter_nix() };
             TreeSitterConfig {

vendored_parsers/highlights/nim.scm

@@ -0,0 +1 @@
+../tree-sitter-nim/queries/highlights.scm

vendored_parsers/tree-sitter-nim-src

@@ -0,0 +1 @@
+tree-sitter-nim/src

vendored_parsers/tree-sitter-nim/.clang-format

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: None
+#
+# SPDX-License-Identifier: CC0-1.0
+
+---
+Language: Cpp
+BasedOnStyle: Google
+AccessModifierOffset: -2
+AlignAfterOpenBracket: AlwaysBreak
+AlignTrailingComments: true
+BreakBeforeBraces: Stroustrup
+BreakInheritanceList: AfterColon
+BreakConstructorInitializers: AfterColon
+DeriveLineEnding: false
+DerivePointerAlignment: false
+IndentAccessModifiers: false
+IndentCaseLabels: false
+IndentGotoLabels: false
+IndentPPDirectives: AfterHash
+IndentExternBlock: NoIndent
+InsertBraces: true
+PointerAlignment: Left
+SeparateDefinitionBlocks: Always
+SpaceAfterTemplateKeyword: false
+SpacesInContainerLiterals: false
+UseCRLF: false
+BreakAfterAttributes: Always
+AttributeMacros:
+  - "_nonnull_"
+  - "_returns_nonnull_"
+  - "_const_"
+  - "_pure_"
+# vim: set ft=yaml et:

vendored_parsers/tree-sitter-nim/.clangd

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: None
+#
+# SPDX-License-Identifier: CC0-1.0
+
+---
+CompileFlags:
+  Add:
+    - -Wall
+    - -Wextra
+    - -Wpedantic
+    - -Wimplicit-fallthrough
+    - -Wwrite-strings
+    - -Wshadow
+    - -Wundef
+    - -Wformat=2
+    - -Wnull-dereference
+    - -Wno-gnu-zero-variadic-macro-arguments
+    - -fno-exceptions
+    - -xc
+    - -DTREE_SITTER_INTERNAL_BUILD
+
+Diagnostics:
+  ClangTidy:
+    Add:
+    - android-cloexec-*
+    - bugprone-*
+    - cert-*
+    - cppcoreguidelines-*
+    - fuchsia-trailing-return
+    - google-global-names-in-headers
+    - hicpp-*
+    - misc-*
+    - modernize-*
+    - performance-*
+    - readability-*
+    Remove: modernize-use-trailing-return-type
+    CheckOptions:
+      cppcoreguidelines-avoid-do-while.IgnoreMacros: true
+      readability-function-cognitive-complexity.IgnoreMacros: true
+      readability-implicit-bool-conversion.AllowPointerConditions: true
+      readability-identifier-naming.ConstantCase: UPPER_CASE
+      readability-identifier-naming.LocalConstantCase: lower_case
+      readability-identifier-naming.EnumConstantCase: UPPER_CASE
+      readability-identifier-naming.FunctionCase: lower_case
+      readability-identifier-naming.MacroDefinitionCase: UPPER_CASE
+      readability-identifier-naming.VariableCase: lower_case
+  UnusedIncludes: Strict
+
+# vim: set ft=yaml et:

vendored_parsers/tree-sitter-nim/.editorconfig

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: None
+#
+# SPDX-License-Identifier: CC0-1.0
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[src/scanner.cc]
+# So that MSVC knows it's UTF-8
+charset = utf-8-bom

vendored_parsers/tree-sitter-nim/.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "env": {
+    "commonjs": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": ["eslint:recommended"],
+  "overrides": [],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "no-undef": "off",
+    "no-useless-escape": "off"
+  }
+}

vendored_parsers/tree-sitter-nim/.eslintrc.json.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: None
+
+SPDX-License-Identifier: CC0-1.0

vendored_parsers/tree-sitter-nim/.gitattributes

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: None
+#
+# SPDX-License-Identifier: CC0-1.0
+
+src/parser.c -diff linguist-generated=true
+Cargo.lock linguist-generated=true
+package-lock.json linguist-generated=true

vendored_parsers/tree-sitter-nim/.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# Copyright 2023 leorize <[email protected]>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+github: alaviss

vendored_parsers/tree-sitter-nim/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# Copyright 2022 leorize <[email protected]>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

vendored_parsers/tree-sitter-nim/.github/workflows/ci.yml

@@ -0,0 +1,109 @@
+# Copyright 2022 Leorize <[email protected]>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  generate:
+    name: Generate parser
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: "npm"
+          node-version: "16"
+
+      - run: npm ci
+      - run: npm run build
+
+      - name: Upload built parser to artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: parser
+          path: src/parser.c
+
+  compare-parser:
+    needs: [generate]
+    name: Check if generated parser is the same as the PR's
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download generated parser
+        uses: actions/download-artifact@v4
+        with:
+          name: parser
+          path: src/
+      - name: Check for differences with git
+        run: |
+          if ! git diff --exit-code src/parser.c; then
+            echo "::warning file=grammar.js,line=1,title=The generated parser is different from the commit's::Currently this is just a reminder for the repo owner to double check the PR"
+          fi
+
+  tests:
+    needs: [generate]
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    name: Run test suite on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "16"
+          cache: "npm"
+      - name: Download generated parser
+        uses: actions/download-artifact@v4
+        with:
+          name: parser
+          path: src/
+      - run: npm ci
+      - name: Run test suite
+        run: npm test
+        shell: bash
+      - name: Test parsing sample Nim files
+        run: npm exec -- tree-sitter parse -s -t -q 'samples/**/*.nim'
+        shell: bash
+
+  rust:
+    needs: [generate]
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    name: Run rust test build on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download generated parser
+        uses: actions/download-artifact@v4
+        with:
+          name: parser
+          path: src/
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - name: Run test build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+
+  success:
+    needs:
+      - compare-parser
+      - generate
+      - tests
+      - rust
+    if: always()
+    runs-on: ubuntu-latest
+    name: "All checks passed"
+    steps:
+      - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        name: "Previous jobs failed"
+        run: |
+          echo "::error::One of the previous jobs failed"
+          exit 1

vendored_parsers/tree-sitter-nim/.github/workflows/reuse.yml

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+name: REUSE Compliance Check
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: REUSE Compilance Check
+    runs-on: ubuntu-latest
+    steps: 
+    - uses: actions/checkout@v4
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v2

vendored_parsers/tree-sitter-nim/.gitignore

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: CC0-1.0
+# SPDX-FileCopyrightText: None
+
+# Node artifacts
+node_modules/
+build/
+
+# Rust stuff
+debug/
+target/
+
+# C stuff
+.cache/

vendored_parsers/tree-sitter-nim/.neoconf.json

@@ -0,0 +1,9 @@
+{
+  "lspconfig": {
+    "tsserver": {
+      "typescript.format.enable": false,
+      "diagnostics.ignoredCodes": [80001],
+      "completions.completeFunctionCalls": true
+    }
+  }
+}