Skip to content

Commit

Permalink
chore: minor housekeeping (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro authored and seren5240 committed Mar 9, 2024
1 parent cea47e5 commit 45180ff
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Note that this codebase isn't yet extensively documented. If you get stuck, plea

If GritQL is failing to match a code snippet, this can typically be fixed simply by adjusting the metavariable grammar for the target language.

Metavariable grammars are found under [./resources/metavariable-grammars]. Typical fixes include:
Metavariable grammars are found under [./resources/metavariable-grammars](./resources/metavariable-grammars). Typical fixes include:
- Adding a new named field for a relevant node you want to manipulate.
- Adding a `grit_metavariable` node as a choice in the corresponding spot where you want to substitute the metavariable.

After making your changes, run the [./resources/edit_grammars.mjs] script to regenerate the matching grammar.
After making your changes, run the [./resources/edit_grammars.mjs](./resources/edit_grammars.mjs) script to regenerate the matching grammar.

## Feature Flags

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ grit check

## Acknowledgements

GritQL uses [tree sitter](https://github.com/tree-sitter/tree-sitter) for all language parsers and benefits greatly from the Rust ecosystem.
GritQL uses [tree-sitter](https://github.com/tree-sitter/tree-sitter) for all language parsers and benefits greatly from the Rust ecosystem.

GritQL is released under the MIT license.

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@
"version": "0.2.2",
"description": "Core GritQL engine and CLI",
"author": "",
"license": "ISC",
"license": "MIT",
"private": true,
"dependencies": {},
"devDependencies": {
"@getgrit/bridge": "*"
},
"scripts": {
"build:watch": "yarn nodemon --ext rs --exec \"yarn build\"",
"build:watch": "nodemon --ext rs --exec \"npm run build\"",
"build:all": "cargo build --release --features grit_alpha --exclude marzano-wasm-bindings",
"build:release": "cargo build --release --features grit_beta --bin marzano",
"build": "yarn build:release",
"build": "npm run build:release",
"release": "./release.sh",
"test:wasm": "cd wasm-bindings && wasm-pack test --node",
"test:watch": "yarn nodemon --ext rs --exec \"cargo test --exclude marzano-wasm-bindings\"",
"test:watch": "nodemon --ext rs --exec \"cargo test --exclude marzano-wasm-bindings\"",
"copy:wasm-parsers": "cp -R wasm-bindings/wasm_parsers ../docs/public && cp -R wasm-bindings/wasm_parsers ../web/public",
"generate:docs": "cargo run --bin marzano --features default,docgen docgen ../docs/src/pages/cli/reference.mdoc",
"generate:wasm-bindings": "cd wasm-bindings && wasm-pack build --target web --out-dir ../../../__generated__/marzano-wasm-bindings && rm -rf ../../../__generated__/marzano-wasm-bindings/.gitignore",
"generate": "yarn generate:docs && yarn generate:wasm-bindings && yarn copy:wasm-parsers",
"generate": "npm run generate:docs && npm run generate:wasm-bindings && npm run copy:wasm-parsers",
"lint:clippy": "cargo clippy -- -D warnings"
}
}

0 comments on commit 45180ff

Please sign in to comment.