Conversation
Replace per-tool install/uninstall lists with single `dotnet tool install -g trash` command. Add Uninstall and Install Locally sections. Update command list to only include implemented tools. Update all example calls from bare `tr<cmd>` to `dotnet trash <alias>` form. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates installation/usage documentation to reflect the unified trash dispatcher, simplifies tool installation/uninstallation instructions, refreshes the documented command list, and bumps the publish script version to 1.0.0.
Changes:
- Replace per-tool install/uninstall instructions with unified
dotnet tool install -g trash/dotnet tool uninstall -g trash, and add local install steps. - Refresh documented command lists and update most examples to use the unified dispatcher form.
- Update
_scripts/publish.shto publish version1.0.0.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 25 comments.
| File | Description |
|---|---|
| src/trash/readme.md | Updates dispatcher README install sections and command examples; currently contains non-runnable dotnet trash ... invocations. |
| readme.md | Simplifies installation instructions and updates command list/examples; several examples reference missing tools (trprint, trst, trstrip) and use dotnet trash ... despite the tool installing as trash. |
| _scripts/publish.sh | Bumps publish version to 1.0.0; still hardcodes version instead of deriving from the csproj. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+27
to
+28
| dotnet trash gen --help | ||
| dotnet trash parse --help |
| ## Example pipeline | ||
|
|
||
| trash trparse -g antlr4 MyGrammar.g4 | trash trtree | ||
| dotnet trash parse -g antlr4 MyGrammar.g4 | dotnet trash tree |
| ## Installation | ||
| ### Requirements | ||
| [Install Dotnet 8.0.x](https://dotnet.microsoft.com/en-us/download) | ||
| [Install Dotnet 10.0.x](https://dotnet.microsoft.com/en-us/download) |
Comment on lines
+59
to
+63
| 1) <a href="src/tranalyze/readme.md">dotnet trash analyze</a> -- Analyze a grammar | ||
| 1) <a href="src/trcaret/readme.md">dotnet trash caret</a> -- Caret operations on a parse tree | ||
| 1) <a href="src/trclonereplace/readme.md">dotnet trash clonereplace</a> -- Clone and replace in a grammar | ||
| 1) <a href="src/trcombine/readme.md">dotnet trash combine</a> -- Combine a split Antlr4 grammar | ||
| 1) <a href="src/trconvert/readme.md">dotnet trash convert</a> -- Convert a grammar from one form to another |
Comment on lines
+64
to
+68
| 1) <a href="src/trcover/readme.md">dotnet trash cover</a> -- Code coverage analysis | ||
| 1) <a href="src/trdot/readme.md">dotnet trash dot</a> -- Print a parse tree in Graphviz Dot format | ||
| 1) <a href="src/trextract/readme.md">dotnet trash extract</a> -- Extract from a parse tree | ||
| 1) <a href="src/trff/readme.md">dotnet trash ff</a> -- Outputs FIRST and FOLLOW sets of a grammar | ||
| 1) <a href="src/trfoldlit/readme.md">dotnet trash foldlit</a> -- Perform fold transform on grammar with literals |
| ### Strip a grammar of all non-essential CFG | ||
|
|
||
| trparse Java9.g4 | trstrip | trtext > Essential-Java9.g4 | ||
| dotnet trash parse Java9.g4 | trstrip | dotnet trash text > Essential-Java9.g4 |
| when super classes are needed for different targets. | ||
|
|
||
| trcombine ArithmeticLexer.g4 ArithmeticParser.g4 | trprint > Arithmetic.g4 | ||
| dotnet trash combine ArithmeticLexer.g4 ArithmeticParser.g4 | trprint > Arithmetic.g4 |
| for the two. | ||
|
|
||
| trparse Arithmetic.g4 | trsplit | trsponge -o true | ||
| dotnet trash parse Arithmetic.g4 | dotnet trash split | dotnet trash sponge -o true |
| make clean; make; make install | ||
|
|
||
| You must have the NET SDK version 8 installed to build and run. | ||
| You must have the NET SDK version 10 installed to build and run. |
Comment on lines
+2
to
4
| version=1.0.0 | ||
| cd src | ||
| dotnet nuget push trash/bin/Release/trash.$version.nupkg --api-key $trashkey --source https://api.nuget.org/v3/index.json |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the README files for the unified trash dispatcher. Replace per-tool install/uninstall lists with a single
dotnet tool install -g trashcommand. Add Uninstall and Install Locally sections. Update the command list to only include implemented tools. Update all example calls from baretr<cmd>todotnet trash <alias>form.