-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Add a npx hereby validate command to group all repo validations
#64161
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,7 @@ const { values: rawOptions } = parseArgs({ | |
| options: { | ||
| tests: { type: "string", short: "t" }, | ||
| fix: { type: "boolean" }, | ||
| api: { type: "boolean" }, | ||
| debug: { type: "boolean" }, | ||
| dirty: { type: "boolean" }, | ||
| release: { type: "boolean" }, | ||
|
|
@@ -1364,6 +1365,43 @@ async function runFormat() { | |
| await run("dprint", ["fmt"]); | ||
| } | ||
|
|
||
| export const validate = task({ | ||
| name: "validate", | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We have a lot of terms, test, check, validate... Sort of wonder if we should somehow name this with "all" in the name to make it very clear what must be done |
||
| description: "Builds, tests, lints, and formats the repo. Pass --api to include API tests.", | ||
| dependencies: [build], | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't notice this, but yeah build doesn't need to be a dep, right? nothing needs that to have happened? I guess the API does?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The API needs it to work and I have doubts on if lint, test, and format would reliably work in the presence of a non-functioning build.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So right, I was just surprised by it being a dep versus another func call, but it doesn't practically matter. |
||
| run: async () => { | ||
| /** @type {{ name: string; error: unknown }[]} */ | ||
| const failures = []; | ||
| /** @param {string} name @param {() => Promise<void>} action */ | ||
| const runValidation = async (name, action) => { | ||
| try { | ||
| await action(); | ||
| } | ||
| catch (error) { | ||
| failures.push({ name, error }); | ||
| console.error(styleText("red", `${name} failed; continuing validation.`)); | ||
| } | ||
| }; | ||
|
|
||
| await runValidation("test", async () => { | ||
| await runTests(); | ||
| await runTestExtension(); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we take the time now to get these extension tests out too into their own task? I've been wanting |
||
| }); | ||
| if (options.api) { | ||
| await runValidation("test:api", runTestAPI); | ||
| } | ||
| await runValidation("lint", runLint); | ||
| await runValidation("format", runFormat); | ||
|
|
||
| if (failures.length) { | ||
| throw new AggregateError( | ||
| failures.map(failure => failure.error), | ||
| `Validation failed: ${failures.map(failure => failure.name).join(", ")}`, | ||
| ); | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| export const checkFormat = task({ | ||
| name: "check:format", | ||
| description: "Checks that the repo is formatted.", | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the things I want to do in this file is to make it clear that the build, test, lint, just matter when editing the
tscdir.We can probably do that in a followup, as the "CRITICAL" language here should really be in the CCA file instead