Add Yarn-related rules #39
Conversation
For a given project, we want to ensure that it is using the same Yarn
version as the module template, that Yarn is configured exactly the same
way as in the module template, and that all of the Yarn-related files
are present, including the Yarn "binary" in `.yarn/releases` and the
plugins in `.yarn/plugins`. We also want to ensure that the version we
recommend users install in the README matches the same version as the
module template.
To accomplish this, this commit adds six new rules:
- `all-yarn-modern-files-conform`
- This checks that `.yarnrc.yml` is present and matches the module
template, and any files in the template's `.yarn/plugins` and
`.yarn/releases` directories are present in the project and match.
- `classic-yarn-config-file-absent`
- This checks that `.yarnrc`, which is the configuration file for Yarn
Classic, is not present.
- `package-manager-conforms`
- This checks that the `packageManager` field in the project's
`package.json` is the same as that of the module template's.
- `readme-lists-correct-yarn-version`
- This checks that the Yarn version in the project's README is the
same as that of the module template's.
- `require-readme`
- This checks that the project has a README.
- `require-valid-package-manifest`
- This checks the project has a `package.json` and that the
JSON-parsed content of this file matches a known shape.
mcmire
force-pushed
the
add-yarn-rules
branch
from
412f05c
to
a2f2d7d
Compare
src/rules/helpers.ts
Outdated
| * @param ruleExecutionArguments - Rule execution arguments. | ||
| * @returns Either a successful or failed result. | ||
| */ | ||
| export async function fileConforms( |
There was a problem hiding this comment.
These last three functions appear to be missing tests
There was a problem hiding this comment.
Tests added here: b683cd0
| /Install \[Yarn [^[\]]+\]\([^()]+\)/u, | ||
| ); | ||
| if (!match?.[0]) { | ||
| throw new Error( |
There was a problem hiding this comment.
This will break the process by throwing an error! The consuming project won't be able to analyse because of the issue in template. How about displaying an non-breaking error (say fail) / warning instead?
There was a problem hiding this comment.
My thought was a rule should only fail if the project does not meet whatever condition is being checked. In this case, we can't even run the rule, because the thing we're using as a point of comparison doesn't exist in the module template. I felt like this was a bug in the rule and not a deficiency in the project itself, so throwing an error seemed more appropriate so that it stood out and hopefully we could be notified of the problem and fix the bug.
That said, you are totally right that throwing an error would prevent other rules from being run, which doesn't seem ideal. I would probably need to fix this in execute-rules.ts.
Printing a warning (and returning a passing result) seems like a good solution for now, and then I can follow this up with another PR to properly address this. I've made this change here: ae3da2c
There was a problem hiding this comment.
yeah! It's tricky here!!
My point is that, even when there's a error we should gracefully convey to the user rather than aborting the running process. When we see here, there's a issue with the template project rather than the issue in the tool itself!! It would be great, if we can find a way to differentiate that to the user.
|
Overall looks neat! Left few minor suggestions / comments. |
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
This reverts commit ae3da2c.
This reverts commit e1fe878.
…yAndContentsConform
|
I believe I've addressed all of the feedback now. |
For a given project, we want to ensure that it is using the same Yarn version as the module template, that Yarn is configured exactly the same way as in the module template, and that all of the Yarn-related files are present, including the Yarn "binary" in
.yarn/releasesand the plugins in.yarn/plugins. We also want to ensure that the version we recommend users install in the README matches the same version as the module template.To accomplish this, this commit adds six new rules:
all-yarn-modern-files-conform.yarnrc.ymlis present and matches the module template, and any files in the template's.yarn/pluginsand.yarn/releasesdirectories are present in the project and match.classic-yarn-config-file-absent.yarnrc, which is the configuration file for Yarn Classic, is not present.package-manager-conformspackageManagerfield in the project'spackage.jsonis the same as that of the module template's.readme-lists-correct-yarn-versionrequire-readmerequire-valid-package-manifestpackage.jsonand that the JSON-parsed content of this file matches a known shape.Fixes #11.
Fixes #23.