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 2 commits
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
19 changes: 13 additions & 6 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,12 +9,17 @@
"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/types/adblocker.d.cts"
},
"import": {
"default": "./dist/adblocker.js",
"types": "./dist/types/adblocker.d.ts"
}
},
"main": "dist/cjs/adblocker.cjs",
"module": "dist/esm/adblocker.js",
"main": "dist/adblocker.cjs",
"module": "dist/adblocker.js",
"types": "dist/types/adblocker.d.ts",
"files": [
"LICENSE",
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-copy": "^3.5.0",
"ts-node": "^10.9.1",
"typescript": "^5.5.2"
},
Expand Down
21 changes: 17 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,20 @@

import resolve from '@rollup/plugin-node-resolve';
import terser from '@rollup/plugin-terser';
import typescript from '@rollup/plugin-typescript';
import copy from 'rollup-plugin-copy';

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 +31,32 @@ 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
copy({
targets: [
{ src: 'dist/types/adblocker.d.ts', dest: 'dist/types', rename: 'adblocker.d.cts' },
],
hook: 'writeBundle',
}),
],
},
];
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",
"declarationDir": "./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
79 changes: 75 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
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-copy: "npm:^3.5.0"
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 @@ -2162,6 +2164,25 @@ __metadata:
languageName: node
linkType: hard

"@types/fs-extra@npm:^8.0.1":
version: 8.1.5
resolution: "@types/fs-extra@npm:8.1.5"
dependencies:
"@types/node": "npm:*"
checksum: 10/565d9e55cd05064b3ab272b8748ed512b8fa5cddc23fd32b0d5f147f9ea3a45981577c4478b5060cae7b3d914c508bd2ea97eb84d9c1fa6f967982c892e4ab26
languageName: node
linkType: hard

"@types/glob@npm:^7.1.1":
version: 7.2.0
resolution: "@types/glob@npm:7.2.0"
dependencies:
"@types/minimatch": "npm:*"
"@types/node": "npm:*"
checksum: 10/6ae717fedfdfdad25f3d5a568323926c64f52ef35897bcac8aca8e19bc50c0bd84630bbd063e5d52078b2137d8e7d3c26eabebd1a2f03ff350fff8a91e79fc19
languageName: node
linkType: hard

"@types/har-format@npm:*":
version: 1.2.15
resolution: "@types/har-format@npm:1.2.15"
Expand Down Expand Up @@ -2196,6 +2217,13 @@ __metadata:
languageName: node
linkType: hard

"@types/minimatch@npm:*":
version: 5.1.2
resolution: "@types/minimatch@npm:5.1.2"
checksum: 10/94db5060d20df2b80d77b74dd384df3115f01889b5b6c40fa2dfa27cfc03a68fb0ff7c1f2a0366070263eb2e9d6bfd8c87111d4bc3ae93c3f291297c1bf56c85
languageName: node
linkType: hard

"@types/minimatch@npm:^3.0.3":
version: 3.0.5
resolution: "@types/minimatch@npm:3.0.5"
Expand Down Expand Up @@ -3407,6 +3435,13 @@ __metadata:
languageName: node
linkType: hard

"colorette@npm:^1.1.0":
version: 1.4.0
resolution: "colorette@npm:1.4.0"
checksum: 10/c8d6c8c3ef5a99acfc3dd9a68f48019f1479ec347551387e4a1762e40f69e98ce19d4dc321ffb4919d1f28a7bdc90c39d4e9a901f4c474fd2124ad93a00c0454
languageName: node
linkType: hard

"columnify@npm:1.6.0":
version: 1.6.0
resolution: "columnify@npm:1.6.0"
Expand Down Expand Up @@ -4551,7 +4586,7 @@ __metadata:
languageName: node
linkType: hard

"fast-glob@npm:^3.1.1, fast-glob@npm:^3.2.9":
"fast-glob@npm:^3.0.3, fast-glob@npm:^3.1.1, fast-glob@npm:^3.2.9":
version: 3.3.2
resolution: "fast-glob@npm:3.3.2"
dependencies:
Expand Down Expand Up @@ -5197,6 +5232,22 @@ __metadata:
languageName: node
linkType: hard

"globby@npm:10.0.1":
version: 10.0.1
resolution: "globby@npm:10.0.1"
dependencies:
"@types/glob": "npm:^7.1.1"
array-union: "npm:^2.1.0"
dir-glob: "npm:^3.0.1"
fast-glob: "npm:^3.0.3"
glob: "npm:^7.1.3"
ignore: "npm:^5.1.1"
merge2: "npm:^1.2.3"
slash: "npm:^3.0.0"
checksum: 10/ea724a820d7d4eafc5aa3882d667a7ef3505b3018652b2658185d58752f122b75d3370086e4d4a7b1bbcdf8c2e700e5709a48db189a930df37005e1b3c86c256
languageName: node
linkType: hard

"globby@npm:11.1.0, globby@npm:^11.1.0":
version: 11.1.0
resolution: "globby@npm:11.1.0"
Expand Down Expand Up @@ -5500,7 +5551,7 @@ __metadata:
languageName: node
linkType: hard

"ignore@npm:^5.0.4, ignore@npm:^5.2.0, ignore@npm:^5.3.1":
"ignore@npm:^5.0.4, ignore@npm:^5.1.1, ignore@npm:^5.2.0, ignore@npm:^5.3.1":
version: 5.3.1
resolution: "ignore@npm:5.3.1"
checksum: 10/0a884c2fbc8c316f0b9f92beaf84464253b73230a4d4d286697be45fca081199191ca33e1c2e82d9e5f851f5e9a48a78e25a35c951e7eb41e59f150db3530065
Expand Down Expand Up @@ -5784,6 +5835,13 @@ __metadata:
languageName: node
linkType: hard

"is-plain-object@npm:^3.0.0":
version: 3.0.1
resolution: "is-plain-object@npm:3.0.1"
checksum: 10/d13fe75db350d4ac669595cdfe0242ae87fcecddf2bca858d2dd443a6ed6eb1f69951fac8c2fa85b16106c6b0d7738fea86c2aca2ecee7fd61de15c1574f2cc5
languageName: node
linkType: hard

"is-plain-object@npm:^5.0.0":
version: 5.0.0
resolution: "is-plain-object@npm:5.0.0"
Expand Down Expand Up @@ -6699,7 +6757,7 @@ __metadata:
languageName: node
linkType: hard

"merge2@npm:^1.3.0, merge2@npm:^1.4.1":
"merge2@npm:^1.2.3, merge2@npm:^1.3.0, merge2@npm:^1.4.1":
version: 1.4.1
resolution: "merge2@npm:1.4.1"
checksum: 10/7268db63ed5169466540b6fb947aec313200bcf6d40c5ab722c22e242f651994619bcd85601602972d3c85bd2cc45a358a4c61937e9f11a061919a1da569b0c2
Expand Down Expand Up @@ -8693,6 +8751,19 @@ __metadata:
languageName: node
linkType: hard

"rollup-plugin-copy@npm:^3.5.0":
version: 3.5.0
resolution: "rollup-plugin-copy@npm:3.5.0"
dependencies:
"@types/fs-extra": "npm:^8.0.1"
colorette: "npm:^1.1.0"
fs-extra: "npm:^8.1.0"
globby: "npm:10.0.1"
is-plain-object: "npm:^3.0.0"
checksum: 10/706ba6bd2052b95d1037f12963ff4b50749730f18aefad10544f9574aff7c035c88c5dd9ae1f0c0408cf09862e595a0ea4d68e13c2717addaea2bda3ade0d0e0
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