Skip to content

Add Go CLI for auditing docs source files on the local filesystem #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 23, 2025
Merged

Add Go CLI for auditing docs source files on the local filesystem #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c3ba2f6
Add audit-cli
dacharyc Oct 17, 2025
99e316f
Add new CLI tool to the parent README.md
dacharyc Oct 17, 2025
e37a21b
Add a --follow-includes flag for the search find-string command
dacharyc Oct 17, 2025
c1884d1
Add a command to visit include paths and output either a list or tree…
dacharyc Oct 17, 2025
887896d
More explicit string matching behavior, a few new flags, and tests
dacharyc Oct 20, 2025
a10620d
Add compare command and file-contents subcommand
dacharyc Oct 20, 2025
a4af8a7
Apply suggestions from review
dacharyc Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ corpus.
database in Atlas.
- `dodec`, or the Database of Devoured Example Code: a query tool that lets us find code examples and related
metadata in the database for reporting or to perform manual updates.
- `audit-cli`: A Go CLI project to help us audit docs content from files on the local filesystem.
- `examples-copier`: a Go app that runs as a GitHub App and copies files from the
source code repo (generated code examples) to multiple target repos and branches.
- `github-check-releases`: a Node.js script that gets the latest release versions
Expand Down
1 change: 1 addition & 0 deletions audit-cli/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
audit-cli
Copy link
Collaborator

@cbullinger cbullinger Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to ignore any generated output?

Copy link
Collaborator Author

@dacharyc dacharyc Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tool doesn't generate any output in any specific directory that can be ignored. If you're generating output, you need to specify a filepath for the generated output. So there aren't any specific patterns to add to the gitignore at this time.

Loading