Skip to content
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.

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

feat: Adds typo plugin #544

Closed
wants to merge 1 commit into from
Closed

feat: Adds typo plugin #544

wants to merge 1 commit into from

Conversation

mchernicoff
Copy link
Contributor

Resolves issue #537

Most of the code in plugins/typo/src/ is a refactor of the code found in hipcheck/src/metrics/typo.rs and hipcheck/src/analysis/mod.rs. Some of the internal functions and types have been changed to support a simpler return type. This reflects the fact that he plugin's query does not use any information about what kind of typos were found for each flagged dependency, just which ones were flagged as typos.

The plugin includes a Typos.toml file for supporting JavaScript, copied from config/Typos.toml.

@mchernicoff mchernicoff added type: enhancement New feature or request product: project Relates to the project itself labels Oct 30, 2024
@mchernicoff mchernicoff added this to the 3.8.0 milestone Oct 30, 2024
@mchernicoff mchernicoff requested a review from a team October 30, 2024 02:33
@mchernicoff mchernicoff self-assigned this Oct 30, 2024
@mchernicoff mchernicoff requested review from ninaagrawal and j-lanson and removed request for a team October 30, 2024 02:33
@mchernicoff mchernicoff linked an issue Oct 30, 2024 that may be closed by this pull request
Copy link
Collaborator

@j-lanson j-lanson left a comment

Choose a reason for hiding this comment

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

Requesting a few changes. Also, main is now advanced enough to allow running plugins locally from a .kdl file. Please rebase if you have not and make sure you have successfully executed this plugin before re-requesting review.

plugins/npm_dependencies/plugin.kdl Outdated Show resolved Hide resolved
plugins/typo/src/main.rs Outdated Show resolved Hide resolved
plugins/typo/src/main.rs Outdated Show resolved Hide resolved
plugins/typo/plugin.kdl Outdated Show resolved Hide resolved
@j-lanson
Copy link
Collaborator

Also remove typo from MITRE_LEGACY_PLUGINS both to make it so you can run the analysis as a plugin, and to ensure the plugin gets used going forward.

@mchernicoff mchernicoff force-pushed the mchernicoff/typo-plugin branch 3 times, most recently from a062841 to f88eea1 Compare October 30, 2024 17:51
@j-lanson j-lanson self-requested a review October 30, 2024 18:54
config/Hipcheck.kdl Outdated Show resolved Hide resolved
config/Hipcheck.kdl Outdated Show resolved Hide resolved
config/Hipcheck.kdl Outdated Show resolved Hide resolved
j-lanson
j-lanson previously approved these changes Oct 31, 2024
@mchernicoff mchernicoff added the closed-because: duplicate This issue or pull request already exists label Oct 31, 2024
@mchernicoff mchernicoff deleted the mchernicoff/typo-plugin branch October 31, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed-because: duplicate This issue or pull request already exists product: project Relates to the project itself type: enhancement New feature or request
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

Typo
2 participants