Merge pull request #182 from github/update-init-command

Generate Cargo projects with `init`

Author: Hendrik van Antwerpen

languages/tree-sitter-stack-graphs-typescript/README.md

@@ -42,6 +42,8 @@ The project is organized as follows:
 - Builtins sources and configuration are defined in `src/builtins.ts` and `builtins.cfg` respectively.
 - Tests are put into the `test` directory.
 
+### Building and Running Tests
+
 Build the project by running:
 
 ``` sh
@@ -70,10 +72,15 @@ Sources are formatted using the standard Rust formatted, which is applied by run
 $ cargo fmt
 ```
 
-The stack graph rules are written in [tree-sitter-graph][], which provides a VSCode
-extension for syntax highlighting.
+### Writing TSG
+
+The stack graph rules are written in [tree-sitter-graph][]. Checkout the [examples][],
+which contain self-contained TSG rules for specific language features. A VSCode
+[extension][] is available that provides syntax highlighting for TSG files.
 
 [tree-sitter-graph]: https://github.com/tree-sitter/tree-sitter-graph
+[examples]: https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/
+[extension]: https://marketplace.visualstudio.com/items?itemName=tree-sitter.tree-sitter-graph
 
 Parse and test a single file by executing the following commands:
 
@@ -82,8 +89,7 @@ $ cargo run --features cli -- parse FILES...
 $ cargo run --features cli -- test TESTFILES...
 ```
 
-Additional flags can be passed to these commands as well. For example, to generate
-a visualization for the test, execute:
+Generate a visualization to debug failing tests by passing the `-V` flag:
 
 ``` sh
 $ cargo run --features cli -- test -V TESTFILES...

tree-sitter-stack-graphs/Cargo.toml

@@ -22,20 +22,32 @@ name = "tree-sitter-stack-graphs"
 required-features = ["cli"]
 
 [features]
-cli = ["clap", "colored", "dialoguer", "env_logger", "indoc", "pathdiff", "stack-graphs/json", "tree-sitter-config", "walkdir"]
+cli = [
+  "chrono",
+  "clap",
+  "colored",
+  "dialoguer",
+  "env_logger",
+  "indoc",
+  "pathdiff",
+  "stack-graphs/json",
+  "tree-sitter-config",
+  "walkdir"
+]
 
 [dependencies]
 anyhow = "1.0"
+chrono = { version = "0.4", optional = true }
 clap = { version = "3", optional = true, features=["derive"] }
 colored = { version = "2.0", optional = true }
 controlled-option = ">=0.4"
 dialoguer = { version = "0.10", optional = true }
 env_logger = { version = "0.9", optional = true }
 indoc = { version = "1.0", optional = true }
 itertools = "0.10"
-lazy_static = "1.4"
 log = "0.4"
 lsp-positions = { version="0.3", path="../lsp-positions" }
+once_cell = "1"
 pathdiff = { version = "0.2.1", optional = true }
 regex = "1"
 rust-ini = "0.18"

tree-sitter-stack-graphs/README.md

@@ -39,7 +39,22 @@ Alternatively, the program can be invoked via NPM as follows:
 $ npx tree-sitter-stack-graphs
 ```
 
-Check out our [examples](https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/) for more details on how to work with the CLI.
+## Getting Started
+
+Starting a new project to develop stack graph definitions for your favourite language
+is as easy as running the `init` command:
+
+``` sh
+$ tree-sitter-stack-graphs init PROJECT_DIR
+```
+
+Answer the questions to provide information about the language, the grammar dependency, and
+the project and hit `Generate` to generate the new project. Check out `PROJECT_DIR/README.md`
+to find out how to start developing.
+
+Also check out our [examples][] for more details on how to work with the CLI.
+
+[examples]: https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/
 
 ## Development