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.

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

Typescript declarations in cts and mts formats #4061

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ dist
node_modules
.nyc_output
.DS_Store
tsconfig.tsbuildinfo

bench/dataset/chromedriver
bench/dataset/ext.zip
Expand All @@ -11,3 +12,4 @@ bench/.bench.json

.changelog/
.yarn/
.rollup.cache/
3 changes: 1 addition & 2 deletions packages/adblocker-content/.npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
dist/cjs/tsconfig.cjs.tsbuildinfo
dist/es6/tsconfig.es6.tsbuildinfo
tsconfig.tsbuildinfo
22 changes: 14 additions & 8 deletions packages/adblocker-content/package.json
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/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",
"types": "dist/types/adblocker.d.ts",
"main": "./dist/adblocker.cjs",
"module": "./dist/adblocker.js",
"types": "./dist/types/adblocker.d.ts",
"files": [
"LICENSE",
"dist"
Expand All @@ -31,7 +36,7 @@
"scripts": {
"clean": "rimraf dist coverage",
"lint": "eslint adblocker.ts",
"build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript"
"build": "rollup --config ./rollup.config.ts --configPlugin typescript"
},
"bugs": {
"url": "https://github.com/ghostery/adblocker/issues"
Expand All @@ -42,11 +47,12 @@
"devDependencies": {
"@rollup/plugin-node-resolve": "^15.2.1",
"@rollup/plugin-terser": "^0.4.4",
"@rollup/plugin-typescript": "^11.1.3",
"@rollup/plugin-typescript": "^11.1.6",
"@types/node": "^20.6.2",
"eslint": "^9.3.0",
"rimraf": "^5.0.1",
"rollup": "^4.0.2",
"rollup-plugin-copy": "^3.5.0",
"typescript": "^5.5.2"
},
"contributors": [
Expand Down
21 changes: 17 additions & 4 deletions packages/adblocker-content/rollup.config.ts
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',
sourcemap: true,
},
],
plugins: [
// compilerOptions are here a workaround for @rollup/plugin-typescript not being able to emit declarations
typescript({ compilerOptions: { declarationDir: './dist/types' } }),
copy({
targets: [
{ src: './dist/types/adblocker.d.ts', dest: './dist/types', rename: 'adblocker.d.cts' },
],
hook: 'writeBundle',
}),
],
},
];
7 changes: 4 additions & 3 deletions packages/adblocker-content/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
"outDir": "./dist/src",
"declarationDir": "./dist/types",
"outDir": "./dist"
},
"references": [
{ "path": "../adblocker-extended-selectors/tsconfig.json" },
],
"include": ["./adblocker.ts"]
"include": [
"./adblocker.ts"
]
}
2 changes: 0 additions & 2 deletions packages/adblocker-electron-example/index.js

This file was deleted.

6 changes: 3 additions & 3 deletions packages/adblocker-electron-example/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"module": "commonjs",
"noEmit": true,
"composite": true
"module": "nodenext",
"moduleResolution": "nodenext",
"noEmit": true
},
"references": [
{ "path": "../adblocker-electron/tsconfig.json" }
Expand Down
3 changes: 1 addition & 2 deletions packages/adblocker-electron-preload/.npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
dist/cjs/tsconfig.cjs.tsbuildinfo
dist/es6/tsconfig.es6.tsbuildinfo
tsconfig.tsbuildinfo
22 changes: 14 additions & 8 deletions packages/adblocker-electron-preload/package.json
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/preload.cjs",
"import": "./dist/esm/preload.js",
"types": "./dist/types/preload.d.ts"
"require": {
"default": "./dist/preload.cjs",
"types": "./dist/types/preload.d.cts"
},
"import": {
"default": "./dist/preload.js",
"types": "./dist/types/preload.d.ts"
}
},
"main": "dist/preload.cjs",
"module": "dist/esm/preload.js",
"types": "dist/types/preload.d.ts",
"main": "./dist/preload.cjs",
"module": "./dist/preload.js",
"types": "./dist/types/preload.d.ts",
"files": [
"LICENSE",
"dist"
Expand All @@ -34,7 +39,7 @@
"scripts": {
"clean": "rimraf dist coverage",
"lint": "eslint preload.ts",
"build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript"
"build": "rollup --config ./rollup.config.ts --configPlugin typescript"
},
"peerDependencies": {
"electron": ">11"
Expand All @@ -45,12 +50,13 @@
"devDependencies": {
"@rollup/plugin-commonjs": "^26.0.1",
"@rollup/plugin-node-resolve": "^15.2.1",
"@rollup/plugin-typescript": "^11.1.3",
"@rollup/plugin-typescript": "^11.1.6",
"@types/chrome": "^0.0.268",
"electron": "^31.0.0",
"eslint": "^9.3.0",
"rimraf": "^5.0.1",
"rollup": "^4.0.2",
"rollup-plugin-copy": "^3.5.0",
"typescript": "^5.5.2"
},
"contributors": [
Expand Down
20 changes: 15 additions & 5 deletions packages/adblocker-electron-preload/rollup.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@

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

export default {
input: './dist/src/preload.js',
input: './preload.ts',
external: ['electron'],
output: [
{
file: './dist/cjs/preload.cjs',
format: 'commonjs',
file: './dist/preload.js',
format: 'esm',
sourcemap: true,
},
{
file: './dist/esm/preload.cjs',
format: 'esm',
file: './dist/preload.cjs',
format: 'cjs',
sourcemap: true,
},
],
Expand All @@ -29,5 +31,13 @@ export default {
mainFields: ['main'],
}),
commonjs(),
// compilerOptions are here a workaround for @rollup/plugin-typescript not being able to emit declarations
typescript({ compilerOptions: { declarationDir: './dist/types' } }),
copy({
targets: [
{ src: './dist/types/preload.d.ts', dest: './dist/types', rename: 'preload.d.cts' },
],
hook: 'writeBundle',
}),
],
};
3 changes: 1 addition & 2 deletions packages/adblocker-electron-preload/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
"outDir": "./dist/src",
"declarationDir": "./dist/types",
"outDir": "./dist"
},
"references": [
{ "path": "../adblocker-content/tsconfig.json" }
Expand Down
3 changes: 1 addition & 2 deletions packages/adblocker-electron/.npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
dist/cjs/tsconfig.cjs.tsbuildinfo
dist/es6/tsconfig.es6.tsbuildinfo
tsconfig.tsbuildinfo
21 changes: 14 additions & 7 deletions packages/adblocker-electron/package.json
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/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",
"types": "dist/types/adblocker.d.ts",
"main": "./dist/adblocker.cjs",
"module": "./dist/adblocker.js",
"types": "./dist/types/adblocker.d.ts",
"files": [
"LICENSE",
"dist"
Expand All @@ -34,7 +39,7 @@
"scripts": {
"clean": "rimraf dist coverage",
"lint": "eslint 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"
},
"peerDependencies": {
Expand All @@ -48,6 +53,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/mocha": "^10.0.1",
"@types/node": "^20.12.12",
Expand All @@ -58,6 +64,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-electron/rollup.config.ts
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',
sourcemap: true,
},
],
plugins: [
// compilerOptions are here a workaround for @rollup/plugin-typescript not being able to emit declarations
typescript({ compilerOptions: { declarationDir: './dist/types' } }),
copy({
targets: [
{ src: './dist/types/adblocker.d.ts', dest: './dist/types', rename: 'adblocker.d.cts' },
],
hook: 'writeBundle',
}),
],
},
];
3 changes: 1 addition & 2 deletions packages/adblocker-electron/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
"outDir": "./dist/src",
"declarationDir": "./dist/types",
"outDir": "./dist"
},
"references": [
{ "path": "../adblocker/tsconfig.json" },
Expand Down
1 change: 1 addition & 0 deletions packages/adblocker-extended-selectors/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
tsconfig.tsbuildinfo
Loading
Loading