[ANE-2701] Make snippet scanning non experimental #1622
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.
Overview
This PR implements the CLI part of ANE-2701
In this PR, we add a new flag,
--snippet-scanand hide and deprecate the--x-snippet-scanflag.The
--x-snippet-scanflag still works, and you can use either--snippet-scanor--x-snippet-scan(or both) to enable snippet scanning.The only difference is that you get a deprecation warning if you use
--x-snippet-scan.At some point in the future we will remove the
--x-snippet-scanflag altogether. Because this is an experimental flag, we will not wait the normal 6 months between deprecation and removal. Instead, the minimum date for removal is one month from when this PR is included in a release.Acceptance criteria
--x-snippet-scanand--snippet-scanflags enable snippet scanning--x-snippet-scan--snippet-scaninstead of--x-snippet-scanfossa analyze --helpno longer mentions--x-snippet-scanfossa analyze --helpshows help for--snippet-scanTesting plan
Run
fossa-dev analyze --snippet-scanandfossa-dev analyze --x-snippet-scanandfossa-dev analyze --snippet-scan --x-snippet-scan. In all cases you should see a successful snippet scan. If you used--x-snippet-scan, you should see a deprecation warning.Run
fossa-dev analyze --help. You should see no mention of--x-snippet-scan. You should see documentation for--snippet-scan.Risks
This is low risk
Metrics
References
Checklist
docs/.docs/README.msand gave consideration to how discoverable or not my documentation is.Changelog.md. If this PR did not mark a release, I added my changes into an## Unreleasedsection at the top..fossa.ymlorfossa-deps.{json.yml}, I updateddocs/references/files/*.schema.jsonAND I have updated example files used byfossa initcommand. You may also need to update these if you have added/removed new dependency type (e.g.pip) or analysis target type (e.g.poetry).docs/references/subcommands/<subcommand>.md.