Improve developer experience (#100)

* Make it easy to parse examples locally again

* Use correct linguist attributes for vendored files

* Ignore local test files

* Run github actions on developer branches

* Don't try to publish in forked repositories

* Run example tests in parallel

* Fix generate command

.gitattributes

@@ -2,15 +2,15 @@
 
 grammars/ocaml/src/*.json linguist-generated
 grammars/ocaml/src/parser.c linguist-generated
-grammars/ocaml/src/tree_sitter/* linguist-generated
+grammars/ocaml/src/tree_sitter/* linguist-vendored
 
 grammars/interface/src/*.json linguist-generated
 grammars/interface/src/parser.c linguist-generated
-grammars/interface/src/tree_sitter/* linguist-generated
+grammars/interface/src/tree_sitter/* linguist-vendored
 
 grammars/type/src/*.json linguist-generated
 grammars/type/src/parser.c linguist-generated
-grammars/type/src/tree_sitter/* linguist-generated
+grammars/type/src/tree_sitter/* linguist-vendored
 
 bindings/** linguist-generated
 binding.gyp linguist-generated

.github/workflows/ci.yml

@@ -1,23 +1,6 @@
 name: CI
 
-on:
-  push:
-    branches: [master]
-    paths:
-      - "scripts.js"
-      - "common/*"
-      - "grammars/*/grammar.js"
-      - "grammars/*/src/**"
-      - "bindings/**"
-      - "binding.gyp"
-  pull_request:
-    paths:
-      - "scripts.js"
-      - "common/*"
-      - "grammars/*/grammar.js"
-      - "grammars/*/src/**"
-      - "bindings/**"
-      - "binding.gyp"
+on: [push, pull_request]
 
 concurrency:
   group: ${{github.workflow}}-${{github.ref}}
@@ -31,46 +14,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-    env:
-      REPOSITORIES: |
-        0install/0install@225587e
-        BinaryAnalysisPlatform/bap@f969db3
-        janestreet/base@1311ac1
-        dbuenzli/cmdliner@c229193
-        ocaml/dune@58d1cd3
-        ocaml-multicore/eio@14ae3cf
-        ocsigen/js_of_ocaml@d2cf189
-        garrigue/lablgtk@e2d564b
-        ocsigen/lwt@73f1a0f
-        melange-re/melange@01d6ba4
-        ocaml/merlin@b274d31
-        ocaml/ocaml@18c4510
-        mirage/ocaml-cohttp@cf2ae33
-        ocaml/ocaml-lsp@ad20957
-        ocaml-ppx/ocamlformat@6ce00bf
-        ocaml/opam@eafdc81
-        owlbarn/owl@c66069e
-        ocaml-ppx/ppxlib@455f217
-        facebook/pyre-check@5cd77ed
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Set up tree-sitter
         uses: tree-sitter/setup-action/cli@v1
-      - name: Set up examples
-        shell: bash
-        run: |
-          while IFS='@' read -r repo_url repo_sha || [ -n "$repo_url" ]; do
-            if [ -z "$repo_url" ]; then
-              continue
-            fi
-            repo_name=$(basename "$repo_url")
-            git clone --filter=blob:none --no-checkout "https://github.com/$repo_url" "examples/$repo_name"
-            (
-              cd "examples/$repo_name"
-              git checkout "$repo_sha"
-            )
-          done <<< "$REPOSITORIES"
       - name: Run tests
         uses: tree-sitter/parser-test-action@v2
         with:
@@ -79,8 +27,21 @@ jobs:
           test-python: true
           test-go: true
           test-swift: ${{runner.os == 'macOS'}}
+  parse-examples:
+    name: Parse examples
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up tree-sitter
+        uses: tree-sitter/setup-action/cli@v1
       - name: Parse examples
-        id: test
         uses: tree-sitter/parse-action@v4
         with:
           files-list: test/files.txt

.github/workflows/publish.yml

@@ -10,14 +10,17 @@ concurrency:
 
 jobs:
   npm:
+    if: github.repository_owner == 'tree-sitter'
     uses: tree-sitter/workflows/.github/workflows/package-npm.yml@main
     secrets:
       NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
   crates:
+    if: github.repository_owner == 'tree-sitter'
     uses: tree-sitter/workflows/.github/workflows/package-crates.yml@main
     secrets:
       CARGO_REGISTRY_TOKEN: ${{secrets.CARGO_REGISTRY_TOKEN}}
   pypi:
+    if: github.repository_owner == 'tree-sitter'
     uses: tree-sitter/workflows/.github/workflows/package-pypi.yml@main
     secrets:
       PYPI_API_TOKEN: ${{secrets.PYPI_API_TOKEN}}

.gitignore

@@ -29,10 +29,11 @@ dist/
 *.dll
 *.pc
 
-# Example dirs
-/examples/*/
-
 # Grammar volatiles
 *.wasm
 *.obj
 *.o
+
+# Test files
+/test.ml
+/test.mli

.gitmodules

@@ -0,0 +1,57 @@
+[submodule "examples/0install"]
+	path = examples/0install
+	url = https://github.com/0install/0install
+[submodule "examples/bap"]
+	path = examples/bap
+	url = https://github.com/BinaryAnalysisPlatform/bap
+[submodule "examples/cmdliner"]
+	path = examples/cmdliner
+	url = https://github.com/dbuenzli/cmdliner
+[submodule "examples/pyre-check"]
+	path = examples/pyre-check
+	url = https://github.com/facebook/pyre-check
+[submodule "examples/lablgtk"]
+	path = examples/lablgtk
+	url = https://github.com/garrigue/lablgtk
+[submodule "examples/base"]
+	path = examples/base
+	url = https://github.com/janestreet/base
+[submodule "examples/melange"]
+	path = examples/melange
+	url = https://github.com/melange-re/melange
+[submodule "examples/ocaml-cohttp"]
+	path = examples/ocaml-cohttp
+	url = https://github.com/mirage/ocaml-cohttp
+[submodule "examples/dune"]
+	path = examples/dune
+	url = https://github.com/ocaml/dune
+[submodule "examples/merlin"]
+	path = examples/merlin
+	url = https://github.com/ocaml/merlin
+[submodule "examples/ocaml"]
+	path = examples/ocaml
+	url = https://github.com/ocaml/ocaml
+[submodule "examples/ocaml-lsp"]
+	path = examples/ocaml-lsp
+	url = https://github.com/ocaml/ocaml-lsp
+[submodule "examples/opam"]
+	path = examples/opam
+	url = https://github.com/ocaml/opam
+[submodule "examples/eio"]
+	path = examples/eio
+	url = https://github.com/ocaml-multicore/eio
+[submodule "examples/ocamlformat"]
+	path = examples/ocamlformat
+	url = https://github.com/ocaml-ppx/ocamlformat
+[submodule "examples/ppxlib"]
+	path = examples/ppxlib
+	url = https://github.com/ocaml-ppx/ppxlib
+[submodule "examples/js_of_ocaml"]
+	path = examples/js_of_ocaml
+	url = https://github.com/ocsigen/js_of_ocaml
+[submodule "examples/lwt"]
+	path = examples/lwt
+	url = https://github.com/ocsigen/lwt
+[submodule "examples/owl"]
+	path = examples/owl
+	url = https://github.com/owlbarn/owl

package.json

@@ -41,10 +41,11 @@
   },
   "scripts": {
     "install": "node-gyp-build",
-    "generate": "for dir in ocaml ocaml_interface ocaml_type; do cd $dir && tree-sitter generate --no-bindings && cd ..; done",
+    "generate": "for dir in grammars/ocaml grammars/interface grammars/type; do cd $dir; tree-sitter generate --no-bindings; cd -; done",
     "prestart": "tree-sitter build ocaml --wasm -o ocaml/tree-sitter-ocaml.wasm",
     "start": "tree-sitter playground --grammar-path ocaml",
-    "test": "node --test bindings/node/*_test.js"
+    "test": "node --test bindings/node/*_test.js",
+    "parse-examples": "test/parse-examples.sh"
   },
   "tree-sitter": [
     {