feat(action): reuse args from package.json #106
Merged
Conversation
This file contains 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
QuiiBz
requested changes
Nov 28, 2024
README.md
Outdated
| @@ -33,6 +33,8 @@ npx sherif@latest | |||
|
|
|||
| We recommend running Sherif in your CI once [all errors are fixed](#autofix). Run it by **specifying a version instead of latest**. This is useful to prevent regressions (e.g. when adding a library to a package but forgetting to update the version in other packages of the monorepo). | |||
|
|
|||
| By default, it will search for a `sherif` script in the root `package.json` and try to use the same arguments, so you can avoid repeating yourself. But you can override this behaviour with the `args` param. | |||
There was a problem hiding this comment.
Suggested change
| By default, it will search for a `sherif` script in the root `package.json` and try to use the same arguments, so you can avoid repeating yourself. But you can override this behaviour with the `args` param. | |
| When using the GitHub Action, it will search for a `sherif` script in the root `package.json` and use the same arguments automatically to avoid repeating them twice. You can override this behaviour with the `args` parameter. |
action/index.ts
Outdated
Comment on lines
133
to
138
| core.info('No scripts found in package.json'); | ||
| return; | ||
| } | ||
|
|
||
| if (!('sherif' in packageJson.scripts)) { | ||
| core.info('No sherif script found in package.json'); |
There was a problem hiding this comment.
I don't think we need to log here, it could get noisy for nothing.
| } | ||
|
|
||
| // Select the args of the sherif script | ||
| const regexResult = /sherif\s([a-zA-Z\s\.-]*)(?=\s&&|$)/g.exec( |
There was a problem hiding this comment.
Can you add a comment to explain what this regex does?
action/index.ts
Outdated
| ); | ||
| if (regexResult && regexResult.length > 1) { | ||
| const args = regexResult[1]; | ||
| core.info(`Found args "${args}" package.json`); |
There was a problem hiding this comment.
Suggested change
| core.info(`Found args "${args}" package.json`); | |
| core.info(`Using the arguments "${args}" from the root package.json`); |
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.
If the action doesn't have the
argsparam, and the root package.json contains a script called "sherif", pass the arguments of the sherif script to the action to avoid repeating the same args in the root package.json and the action