Merge pull request #164 from github/release-tree-sitter-stack-graphs-typescript

Release tree-sitter-stack-graphs-typescript v0.1.0

Author: Hendrik van Antwerpen

.github/workflows/publish-tree-sitter-stack-graphs-typescript.yml

@@ -0,0 +1,45 @@
+name: Publish tree-sitter-stack-graphs-typescript release
+
+on:
+  push:
+    tags:
+      - tree-sitter-stack-graphs-typescript-v*
+
+jobs:
+  publish-crate:
+    runs-on: ubuntu-latest
+    env:
+      CARGO_TERM_COLOR: always
+      CARGO_INCREMENTAL: 0
+      CRATE_DIR: './languages/tree-sitter-stack-graphs-typescript'
+    steps:
+      - name: Install Rust environment
+        uses: hecrj/setup-rust-action@v1
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      # TODO Verify the crate version matches the tag
+      - name: Test crate
+        run: cargo test --all-features
+        working-directory: ${{ env.CRATE_DIR }}
+      - name: Verify publish crate
+        run: cargo publish --dry-run
+        working-directory: ${{ env.CRATE_DIR }}
+      - name: Publish crate
+        run: cargo publish
+        working-directory: ${{ env.CRATE_DIR }}
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+  create-release:
+    needs: publish-crate
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Create GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          body: |
+            Find more info on all releases at https://crates.io/crates/tree-sitter-stack-graphs-typescript.
+          token: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- Stack graph rules, tests, and basic `tsconfig.json` and `package.json` analysis.

languages/tree-sitter-stack-graphs-typescript/Cargo.toml

@@ -11,6 +11,7 @@ edition = "2018"
 [[bin]]
 name = "tree-sitter-stack-graphs-typescript"
 path = "rust/bin.rs"
+required-features = ["cli"]
 
 [lib]
 path = "rust/lib.rs"
@@ -20,14 +21,20 @@ test = false
 name = "test"
 path = "rust/test.rs"
 harness = false
+required-features = ["test"] # should be a forced feature, but Cargo does not support those
+
+[features]
+default = ["test"] # test is enabled by default because we cannot specify it as a forced featured for [[test]] above
+cli = ["anyhow", "clap", "tree-sitter-stack-graphs/cli"]
+test = ["anyhow", "tree-sitter-stack-graphs/cli"]
 
 [dependencies]
-anyhow = "1.0"
-clap = "3"
+anyhow = { version = "1.0", optional = true }
+clap = { version = "3", optional = true }
 glob = "0.3"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 stack-graphs = { version = "0.10", path = "../../stack-graphs" }
-tree-sitter-stack-graphs = { version = "0.6", path = "../../tree-sitter-stack-graphs", features=["cli"] }
-tree-sitter-typescript = { git = "https://github.com/tree-sitter/tree-sitter-typescript", rev="082da44a5263599186dadafd2c974c19f3a73d28" }
+tree-sitter-stack-graphs = { version = "0.6", path = "../../tree-sitter-stack-graphs" }
+tree-sitter-typescript = "0.20.2"
 tsconfig = "0.1.0"

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

@@ -1,38 +1,98 @@
 # tree-sitter-stack-graphs definition for TypeScript
 
-This project defines tree-sitter-stack-graphs rules for TypeScript using the [tree-sitter-typescript](https://www.npmjs.com/package/tree-sitter-typescript) grammar.
+This project defines tree-sitter-stack-graphs rules for TypeScript using the [tree-sitter-typescript][] grammar.
+
+[tree-sitter-typescript]: https://crates.io/crates/tree-sitter-typescript
+
+## Usage
+
+To use this library, add the following to your `Cargo.toml`:
+
+``` toml
+[dependencies]
+tree-sitter-stack-graphs-typescript = "0.1"
+```
+
+Check out our [documentation](https://docs.rs/tree-sitter-stack-graphs-typescript/*/) for
+more details on how to use this library.
+
+## Command-line Program
+
+The command-line program for `tree-sitter-stack-graphs-typescript` lets you do
+stack graph based analysis and lookup from the command line.
+
+Install the program using `cargo install` as follows:
+
+``` sh
+$ cargo install --features cli tree-sitter-stack-graphs-typescript
+$ tree-sitter-stack-graphs-typescript --help
+```
 
 ## Development
 
+The project is written in Rust, and requires a recent version installed.
+Rust can be installed and updated using [rustup][].
+
+[rustup]: https://rustup.rs/
+
+
 The project is organized as follows:
 
 - The stack graph rules are defined in `src/stack-graphs.tsg`.
 - Builtins sources and configuration are defined in `src/builtins.ts` and `builtins.cfg` respectively.
 - Tests are put into the `test` directory.
 
-Make sure all development dependencies are installed by running:
+Build the project by running:
 
-    npm install
+``` sh
+$ cargo build
+```
 
-Run all tests in the project by executing the following:
+Run the tests as follows:
 
-    npm test
+``` sh
+$ cargo test
+```
 
-Parse and test a single file by executing the following commands:
+The project consists of a library and a CLI.
+By default, running `cargo` only applies to the library.
+To run `cargo` commands on the CLI as well, add `--features cli` or `--all-features`.
 
-    npm run parse-file test/test.ts
-    npm run test-file test/test.ts
+Run the CLI from source as follows:
 
-Additional flags can be passed to these commands as well. For example, to generate a visualization for the test, execute:
+``` sh
+$ cargo run --features cli -- ARGS
+```
 
-    npm run test-file -- -V test/test.ts
+Sources are formatted using the standard Rust formatted, which is applied by running:
 
-To generate the visualization regardless of test outcome, execute:
+``` sh
+$ cargo fmt
+```
+
+The stack graph rules are written in [tree-sitter-graph][], which provides a VSCode
+extension for syntax highlighting.
+
+[tree-sitter-graph]: https://github.com/tree-sitter/tree-sitter-graph
 
-    npm run test-file -- -V --output-mode=always test/test.ts
+Parse and test a single file by executing the following commands:
+
+``` sh
+$ 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:
 
-These commands should be enough for regular development. If necessary, the `tree-sitter-stack-graphs` command can be invoked directly as well, by executing:
+``` sh
+$ cargo run --features cli -- test -V TESTFILES...
+```
+
+To generate the visualization regardless of test outcome, execute:
 
-    npx tree-sitter-stack-graphs
+``` sh
+$ cargo run --features cli -- test -V --output-mode=always TESTFILES...
+```
 
 Go to https://crates.io/crates/tree-sitter-stack-graphs for links to examples and documentation.

…ge-dependency-with-nested-source-root.ts …pendency-with-nested-source-root.ts.skiplanguages/tree-sitter-stack-graphs-typescript/test/projects/package-dependency-with-nested-source-root.ts renamed to languages/tree-sitter-stack-graphs-typescript/test/projects/package-dependency-with-nested-source-root.ts.skip languages/tree-sitter-stack-graphs-typescript/test/projects/package-dependency-with-nested-source-root.ts renamed to languages/tree-sitter-stack-graphs-typescript/test/projects/package-dependency-with-nested-source-root.ts.skip

@@ -84,7 +84,7 @@ impl HasPathKey for PartialPath {
     }
 }
 
-const MAX_SIMILAR_PATH_COUNT: usize = 12;
+const MAX_SIMILAR_PATH_COUNT: usize = 7;
 
 impl<P> CycleDetector<P>
 where