feat: Prepare lint plugin for publishing#2302
Draft
aleksanderkatan wants to merge 26 commits intomainfrom
Draft
Conversation
|
pkg.pr.new packages benchmark commit |
📊 Bundle Size Comparison
👀 Notable resultsStatic test results:No major changes. Dynamic test results:No major changes. 📋 All resultsClick to reveal the results table (348 entries).
If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu. |
aleksanderkatan
force-pushed
the
feat/prepare-lint-plugin-for-publishing
branch
from
740e38c to
1283689
Compare
…gin-for-publishing
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 22 out of 24 changed files in this pull request and generated 5 comments.
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
packages/eslint-plugin/src/rules/noUnwrappedObjects.ts:11
- The rule’s docs description says it disallows unwrapped objects inside
'use gpu'functions, but the implementation explicitly exempts object literals directly returned from the function (ReturnStatement). Consider updating the description to document this exception so users aren’t confused about whyreturn { ... }isn’t reported.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| export const config = { | ||
| pathRuleDoc(name) { | ||
| const [plugin, rule] = name.split('/'); | ||
| return `packages/eslint-plugin-${plugin}/docs/rules/${rule}.md`; |
There was a problem hiding this comment.
pathRuleDoc currently writes to packages/eslint-plugin-${plugin}/docs/..., which resolves to a non-existent directory (e.g. packages/eslint-plugin-typegpu/...). This will make docs:check/docs:update fail or generate docs in the wrong place; update the path to point at this package’s actual docs directory (e.g. packages/eslint-plugin/docs/rules/... or just docs/rules/...).
Suggested change
| return `packages/eslint-plugin-${plugin}/docs/rules/${rule}.md`; | |
| return `packages/eslint-plugin/docs/rules/${rule}.md`; |
| "prepublishOnly": "pnpm run docs:check && pnpm run test:types && vitest run && pnpm run build" | ||
| }, | ||
| "dependencies": { | ||
| "@typescript-eslint/utils": "^8.53.0" |
There was a problem hiding this comment.
@typescript-eslint/utils is pinned to ^8.53.0 here, but the lockfile importer entry for this package is ^8.57.2. With --frozen-lockfile this mismatch typically fails CI; either bump this dependency specifier to match the lockfile (or regenerate the lockfile so it matches the manifest).
Suggested change
| "@typescript-eslint/utils": "^8.53.0" | |
| "@typescript-eslint/utils": "^8.57.2" |
|
|
||
| </div> | ||
|
|
||
| ## Installataion |
There was a problem hiding this comment.
Typo in section header: Installataion → Installation.
Suggested change
| ## Installataion | |
| ## Installation |
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
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.
Closes #2186
Plugin is published: https://www.npmjs.com/package/eslint-plugin-typegpu
I took inspiration from eslint-plugin-react.