lint: allow skuba.template.js in template repositories#2515
Open
KSHITIZ6341 wants to merge 1 commit into
Open
Conversation
🦋 Changeset detectedLatest commit: ce60264 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
no-skuba-template-jsto pass in source template repositories that do not havepackage.json#skubametadataFixes #1379.
Good catch by @72636c: source templates intentionally retain
skuba.template.js, while generated projects receivepackage.json#skubametadata duringskuba init.Root cause
The internal lint treated the presence of
skuba.template.jsas evidence of an incomplete generated project in every repository. That same file is expected in source template repositories, so linting skuba's templates produced a false positive.The rule now uses the consumer manifest metadata written during project initialisation to distinguish generated projects from source templates before checking for the template file.
Compatibility
There is no API change. Generated projects with
package.json#skubacontinue to fail lint when a leftoverskuba.template.jsis present; source template repositories without that metadata now pass.Checks
pnpm formatpnpm lintpnpm buildpnpm test(67 files, 846 tests)pnpm exec vitest run src/cli/lint/internalLints/noSkubaTemplateJs.test.ts(6 tests)pnpm --filter '!./template/**' test:cipnpm test:template greeterpnpm test:template oss-npm-packageThe full root
pnpm test:cirun passed 867 of 869 tests locally. Twoformat.int.test.tssnapshots differed only in ANSI colour codes under the local terminal and Node 24.14.0; the repository targets Node 24.18 and CI will provide the authoritative integration result.