use a script instead of submodules for grammars

.github/workflows/build.yml

@@ -14,8 +14,9 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: true
+
+      - name: Fetch grammars
+        run: ./scripts/grammars sync
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
@@ -53,8 +54,14 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: true
+
+      - name: Fetch grammars (Windows)
+        if: startsWith(matrix.os, 'windows')
+        run: scripts/grammars.cmd sync
+
+      - name: Fetch grammars (Unix)
+        if: startsWith(matrix.os, 'macos') || startsWith(matrix.os, 'ubuntu')
+        run: scripts/grammars sync
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
@@ -97,8 +104,9 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: true
+
+      - name: Fetch grammars
+        run: ./scripts/grammars sync
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
@@ -144,8 +152,9 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: true
+
+      - name: Fetch grammars
+        run: ./scripts/grammars sync
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1

.github/workflows/release.yml

@@ -53,8 +53,14 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: true
+
+      - name: Fetch grammars (Windows)
+        if: startsWith(matrix.os, 'windows')
+        run: scripts/grammars.cmd sync
+
+      - name: Fetch grammars (Unix)
+        if: startsWith(matrix.os, 'macos') || startsWith(matrix.os, 'ubuntu')
+        run: scripts/grammars sync
 
       - name: Install ${{ matrix.rust }} toolchain
         uses: actions-rs/toolchain@v1
@@ -114,8 +120,9 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
-        with:
-          submodules: false
+
+      - name: Fetch grammars
+        uses: ./scripts/grammars sync
 
       - uses: actions/download-artifact@v2
         # with:

README.md

@@ -36,8 +36,9 @@ We provide packaging for various distributions, but here's a quick method to
 build from source.
 
 ```
-git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
+git clone https://github.com/helix-editor/helix
 cd helix
+./scripts/grammars sync
 cargo install --path helix-term
 ```
 

book/src/guides/adding_languages.md

@@ -1,22 +1,15 @@
 # Adding languages
 
-## Submodules
+## Grammars manifest
+
+To add a new language, add a new line to `scripts/revisions.txt` with the
+name of the remote and the revision. Then run
 
-To add a new language, you should first add a tree-sitter submodule. To do this,
-you can run the command
-```sh
-git submodule add -f <repository> helix-syntax/languages/tree-sitter-<name>
-```
-For example, to add tree-sitter-ocaml you would run
-```sh
-git submodule add -f https://github.com/tree-sitter/tree-sitter-ocaml helix-syntax/languages/tree-sitter-ocaml
-```
-Make sure the submodule is shallow by doing
 ```sh
-git config -f .gitmodules submodule.helix-syntax/languages/tree-sitter-<name>.shallow true
+./scripts/grammars sync
 ```
 
-or you can manually add `shallow = true` to `.gitmodules`.
+To download the new grammar.
 
 ## languages.toml
 
@@ -56,14 +49,14 @@ the last matching query supercedes the ones before it. See
 
 ## Common Issues
 
-- If you get errors when building after switching branches, you may have to remove or update tree-sitter submodules. You can update submodules by running
+- If you get errors when building after switching branches, you may have to sync your grammars. You can sync grammars by running
     ```sh
-    git submodule sync; git submodule update --init
+    ./scripts/grammars sync
+    ```
+- If a parser is segfaulting or you want to remove the parser, make sure to remove the grammar repository *and* the compiled parser in `runtime/grammar/<name>.so`. You can remove the grammar repository by running
+    ```sh
+    ./scripts/grammars clean
     ```
-- Make sure to not use the `--remote` flag. To remove submodules look inside the `.gitmodules` and remove directories that are not present inside of it.
-
-- If a parser is segfaulting or you want to remove the parser, make sure to remove the submodule *and* the compiled parser in `runtime/grammar/<name>.so`
-
 - The indents query is `indents.toml`, *not* `indents.scm`. See [this](https://github.com/helix-editor/helix/issues/114) issue for more information.
 
 [treesitter-language-injection]: https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection

book/src/install.md

@@ -39,7 +39,8 @@ sudo dnf install helix
 ## Build from source
 
 ```
-git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
+git clone https://github.com/helix-editor/helix
+./scripts/grammars sync
 cd helix
 cargo install --path helix-term
 ```

helix-core/src/syntax.rs

@@ -209,8 +209,7 @@ impl LanguageConfiguration {
                 &highlights_query,
                 &injections_query,
                 &locals_query,
-            )
-            .unwrap(); // TODO: avoid panic
+            ).unwrap_or_else(|query_error| panic!("Could not parse queries for language {:?}. This can happen if your grammars are out of sync - try running './scripts/grammars sync'. This query could not be parsed: {:?}", self.language_id, query_error));
 
             config.configure(scopes);
             Some(Arc::new(config))