Merge pull request #133 from github/init-project-command

Add command to initialize new project

Author: Hendrik van Antwerpen

tree-sitter-stack-graphs/CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Added
 
 - Builtins can be explicitly supplied using the `--builtins` flag. If the given path does not have a file extension, the file extension of the language is implicitly added.
+- A new `init` command can be used to generate new tree-sitter-stack-graphs projects for NPM distributed Tree-sitter grammars.
 
 #### Changed
 

tree-sitter-stack-graphs/Cargo.toml

@@ -22,14 +22,16 @@ name = "tree-sitter-stack-graphs"
 required-features = ["cli"]
 
 [features]
-cli = ["clap", "colored", "env_logger", "stack-graphs/json", "tree-sitter-config", "walkdir"]
+cli = ["clap", "colored", "dialoguer", "env_logger", "indoc", "stack-graphs/json", "tree-sitter-config", "walkdir"]
 
 [dependencies]
 anyhow = "1.0"
 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"

tree-sitter-stack-graphs/README.md

@@ -6,6 +6,7 @@ The `tree-sitter-stack-graphs` crate lets you create stack graphs using the
 [tree-sitter]: https://tree-sitter.github.io/
 
 - [API documentation](https://docs.rs/tree-sitter-stack-graphs/)
+- [Examples](https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/)
 - [Release notes](https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/CHANGELOG.md)
 
 ## Usage
@@ -32,6 +33,14 @@ $ cargo install --features cli tree-sitter-stack-graphs
 $ tree-sitter-stack-graphs --help
 ```
 
+Alternatively, the program can be invoked via NPM as follows:
+
+``` sh
+$ 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.
+
 ## Development
 
 The project is written in Rust, and requires a recent version installed.