Skip to content
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.

Sign up for GitHub

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

fix: make plugin-kit types usable in CommonJS #143

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

fix: make plugin-kit types usable in CommonJS #143

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
415532e
fix: make `plugin-kit` types usable in CommonJS
fasttime Dec 27, 2024
76528ad
fix
fasttime Dec 27, 2024
5f6e617
use `@eslint/core` as a runtime dependency
fasttime Dec 27, 2024
993bcf8
run type tests sequentially
fasttime Dec 27, 2024
441cb74
add import attribute only to cjs build
fasttime Dec 27, 2024
a3c93b0
replace with Node.js
fasttime Dec 27, 2024
0b6267f
extract `build:cts` to script
fasttime Dec 31, 2024
8d875ca
add file header comment
fasttime Dec 31, 2024
4e554d2
update `@fileoverview`
fasttime Jan 1, 2025
38bc8e9
use `types.cts`
fasttime Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/plugin-kit/build-cts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { readFile, writeFile } from "node:fs/promises";
fasttime marked this conversation as resolved.
Show resolved Hide resolved

const oldSourceText = await readFile("dist/esm/index.d.ts", "utf-8");
const newSourceText = oldSourceText.replaceAll(
'import("./types.ts")',
'import("./types.ts", { with: { "resolution-mode": "import" } })',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious: Will this work with TypeScript 4? And if not, does it matter?

Copy link
Member Author

@fasttime fasttime Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will not work because TypeScript 4 doesn't support import attributes. The alternative would be renaming types.ts to types.cts in dist/cjs and updating the imports in index.d.cts accordingly.

Update:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think renaming to types.cts and updating the references seems like a safer option for best compatibility. What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I switched to importing from types.cts in 38bc8e9. We don't have policy about TypeScript versions support like we have for Node.js versions, but since the import attributes proposal is still not finalized, types.cts looks like a safer choice.

);
await writeFile("dist/cjs/index.d.cts", newSourceText);
2 changes: 1 addition & 1 deletion packages/plugin-kit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"homepage": "https://github.com/eslint/rewrite#readme",
"scripts": {
"build:dedupe-types": "node ../../tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js",
"build:cts": "node -e \"fs.writeFileSync('dist/cjs/index.d.cts', fs.readFileSync('dist/esm/index.d.ts', 'utf-8').replaceAll('import(\\\"./types.ts\\\")', 'import(\\\"./types.ts\\\", { with: { \\\"resolution-mode\\\": \\\"import\\\" } })'))\"",
"build:cts": "node ./build-cts.js",
"build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
"pretest": "npm run build",
"test": "mocha tests/",
Expand Down
Loading