fix: Enhance builtin rules resolution and update README documentation - #1
Merged
Merged
Conversation
The npm/npx-installed viewer ships only the viewer, not the engine's ruleset, so the old `../lib/rules`-next-to-the-CLI default never resolved for npm users and the CLI hard-failed. Resolve `--builtin-rules` in priority order: explicit flag, then `../lib/rules` next to the `opentaint` engine binary found on PATH (when that dir exists), then the CLI-relative path (the bundled-with-engine layout). This makes the common `--sarif`-only invocation work whenever the engine is installed. Also document npx vs. global-install CLI usage in the README and update the `--help`/options-table defaults to match.
Restructure the README to match the seqra/opentaint style: centered logo, tagline, badges, and demo screenshot up front; a short bold-bulleted "Why"; and a tight Quick Start. Lead every user-facing flow with npx / the opentaint-viewer CLI (full commands, no ellipses); the demo now scans seqra/java-spring-demo and views it via npx instead of `npm run dev`. Describe taint in plain language — "untrusted input" and "dangerous call" rather than source/sink. Tuck the depth (full CLI options table, the legacy `npm run gen` build, and dev scripts/stack) into <details> so nothing accurate is lost.
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
1 participant
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.
No description provided.