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

Jump to bottom

Typescript declarations in cts and mts formats #4061

Closed
wants to merge 3 commits into from
Closed

Typescript declarations in cts and mts formats #4061

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33f8dee
Typescript declarations in cts and mts formats
chrmod Jul 2, 2024
19ece25
Replace rollup plugin dts with copy
chrmod Jul 3, 2024
bd5e447
Completes build config update (#4075)
seia-soto Jul 9, 2024
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
21 changes: 14 additions & 7 deletions packages/adblocker-extended-selectors/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@
"license": "MPL-2.0",
"type": "module",
"exports": {
"require": "./dist/cjs/adblocker.cjs",
"import": "./dist/esm/adblocker.js",
"types": "./dist/types/adblocker.d.ts"
"require": {
"default": "./dist/adblocker.cjs",
"types": "./dist/adblocker.d.cts"
},
"import": {
"default": "./dist/adblocker.js",
"types": "./dist/adblocker.d.mts"
}
},
"main": "dist/cjs/adblocker.cjs",
"module": "dist/esm/adblocker.js",
"types": "dist/types/adblocker.d.ts",
"main": "dist/adblocker.cjs",
"module": "dist/adblocker.js",
"types": "dist/adblocker.d.ts",
"files": [
"LICENSE",
"dist"
Expand All @@ -31,7 +36,7 @@
"scripts": {
"clean": "rimraf dist coverage",
"lint": "eslint src adblocker.ts",
"build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript",
"build": "rollup --config ./rollup.config.ts --configPlugin typescript",
"test": "nyc mocha --config ../../.mocharc.json"
},
"bugs": {
Expand All @@ -40,6 +45,7 @@
"devDependencies": {
"@rollup/plugin-node-resolve": "^15.2.3",
"@rollup/plugin-terser": "^0.4.4",
"@rollup/plugin-typescript": "^11.1.6",
"@types/chai": "^4.3.6",
"@types/jsdom": "^21.1.3",
"@types/mocha": "^10.0.1",
Expand All @@ -51,6 +57,7 @@
"nyc": "^17.0.0",
"rimraf": "^5.0.1",
"rollup": "^4.17.2",
"rollup-plugin-dts": "^6.1.1",
"ts-node": "^10.9.1",
"typescript": "^5.5.2"
},
Expand Down
27 changes: 23 additions & 4 deletions packages/adblocker-extended-selectors/rollup.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,21 @@

import resolve from '@rollup/plugin-node-resolve';
import terser from '@rollup/plugin-terser';
import typescript from '@rollup/plugin-typescript';
import { dts } from 'rollup-plugin-dts';


export default [
{
input: './dist/src/adblocker.js',
input: './adblocker.ts',
output: {
file: './dist/adblocker.umd.min.js',
format: 'umd',
name: 'adblocker',
sourcemap: true,
},
plugins: [
typescript(),
resolve(),
terser({
output: {
Expand All @@ -28,22 +32,37 @@ export default [
],
},
{
input: './dist/src/adblocker.js',
input: './adblocker.ts',
output: [
{
dir: './dist/esm',
dir: './dist',
format: 'esm',
preserveModules: true,
entryFileNames: '[name].js',
sourcemap: true,
},
{
dir: './dist/cjs',
dir: './dist',
format: 'cjs',
preserveModules: true,
entryFileNames: '[name].cjs',
chrmod marked this conversation as resolved.
Show resolved Hide resolved
sourcemap: true,
},
],
plugins: [
// compilerOptions are here a workaround for @rollup/plugin-typescript not being able to emit declarations
typescript({ compilerOptions: { declarationDir: './dist/types' } }),
chrmod marked this conversation as resolved.
Show resolved Hide resolved
],
},
{
input: 'dist/types/adblocker.d.ts',
output: [
{ file: `dist/adblocker.d.cts` },
{ file: `dist/adblocker.d.mts` },
{ file: `dist/adblocker.d.ts` },
chrmod marked this conversation as resolved.
Show resolved Hide resolved
],
plugins: [
dts(),
],
}
];
8 changes: 2 additions & 6 deletions packages/adblocker-extended-selectors/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
"outDir": "./dist/src",
"declarationDir": "./dist/types",
"outDir": "./dist",
},
"include": [
"./adblocker.ts",
"./src/parse.ts",
"./src/types.ts",
"./src/eval.ts",
"./src/extended.ts"
"./src/*.ts",
]
}
2 changes: 0 additions & 2 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
"compilerOptions": {
"composite": true,
"declaration": true,
"declarationMap": true,
"sourceMap": true,
"target": "es2018",
"module": "preserve",
"moduleResolution": "Bundler",
Expand Down
24 changes: 21 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ __metadata:
languageName: node
linkType: hard

"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.24.7":
"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.24.2, @babel/code-frame@npm:^7.24.7":
version: 7.24.7
resolution: "@babel/code-frame@npm:7.24.7"
dependencies:
Expand Down Expand Up @@ -453,6 +453,7 @@ __metadata:
dependencies:
"@rollup/plugin-node-resolve": "npm:^15.2.3"
"@rollup/plugin-terser": "npm:^0.4.4"
"@rollup/plugin-typescript": "npm:^11.1.6"
"@types/chai": "npm:^4.3.6"
"@types/jsdom": "npm:^21.1.3"
"@types/mocha": "npm:^10.0.1"
Expand All @@ -464,6 +465,7 @@ __metadata:
nyc: "npm:^17.0.0"
rimraf: "npm:^5.0.1"
rollup: "npm:^4.17.2"
rollup-plugin-dts: "npm:^6.1.1"
ts-node: "npm:^10.9.1"
typescript: "npm:^5.5.2"
languageName: unknown
Expand Down Expand Up @@ -1757,7 +1759,7 @@ __metadata:
languageName: node
linkType: hard

"@rollup/plugin-typescript@npm:^11.1.3":
"@rollup/plugin-typescript@npm:^11.1.3, @rollup/plugin-typescript@npm:^11.1.6":
version: 11.1.6
resolution: "@rollup/plugin-typescript@npm:11.1.6"
dependencies:
Expand Down Expand Up @@ -6579,7 +6581,7 @@ __metadata:
languageName: node
linkType: hard

"magic-string@npm:^0.30.3":
"magic-string@npm:^0.30.10, magic-string@npm:^0.30.3":
version: 0.30.10
resolution: "magic-string@npm:0.30.10"
dependencies:
Expand Down Expand Up @@ -8693,6 +8695,22 @@ __metadata:
languageName: node
linkType: hard

"rollup-plugin-dts@npm:^6.1.1":
version: 6.1.1
resolution: "rollup-plugin-dts@npm:6.1.1"
dependencies:
"@babel/code-frame": "npm:^7.24.2"
magic-string: "npm:^0.30.10"
peerDependencies:
rollup: ^3.29.4 || ^4
typescript: ^4.5 || ^5.0
dependenciesMeta:
"@babel/code-frame":
optional: true
checksum: 10/8a66833a5af32f77d9bbc746339097d4af2382e5160f7629d85dcecb4efad12cbfebd37c79147fa688f073c333d71f53135e08a225a3fc3e9a3b3f92c46b2381
languageName: node
linkType: hard

"rollup@npm:^4.0.2, rollup@npm:^4.17.2":
version: 4.18.0
resolution: "rollup@npm:4.18.0"
Expand Down
Loading