types alongside js files and publint

AcalaNetwork · Nov 28, 2023 · 2a0f3bb · 2a0f3bb
1 parent 7cbacd1
commit 2a0f3bb
Show file tree

Hide file tree

Showing 14 changed files with 52 additions and 79 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -39,6 +39,7 @@ jobs:
     - run: yarn build-wasm
     - run: yarn lint
     - run: yarn build
+    - run: yarn publint
     - run: yarn test
       timeout-minutes: 30
 

diff --git a/executor/package.json b/executor/package.json
@@ -31,15 +31,12 @@
 	],
 	"require": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./pkg/chopsticks_executor.d.ts",
 	"exports": {
 		".": {
-			"require": "./dist/cjs/index.js",
+			"types": "./pkg/chopsticks_executor.d.ts",
 			"module": "./dist/esm/index.js",
-			"default": "./dist/esm/index.js",
-			"types": "./pkg/chopsticks_executor.d.ts"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+			"require": "./dist/cjs/index.js",
+			"default": "./dist/esm/index.js"
+		}
 	}
 }
diff --git a/package.json b/package.json
@@ -25,7 +25,8 @@
 		"docs:prep": "yarn workspaces foreach --all -pvit run docs:prep && cp docs/* docs-src",
 		"docs:dev": "yarn docs:prep && vitepress dev",
 		"docs:build": "yarn docs:prep && vitepress build",
-		"docs:preview": "yarn docs:build && vitepress preview"
+		"docs:preview": "yarn docs:build && vitepress preview",
+		"publint": "sh ./publint.sh"
 	},
 	"engines": {
 		"node": ">=v18"

diff --git a/packages/chopsticks/package.json b/packages/chopsticks/package.json
@@ -6,11 +6,10 @@
 	"bin": "./chopsticks.cjs",
 	"type": "module",
 	"scripts": {
-		"clean": "rm -rf dist",
-		"build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs --copy-files && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm --copy-files",
-		"build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types",
+		"clean": "rm -rf dist tsconfig.tsbuildinfo",
+		"build": "yarn clean && yarn build:cjs && yarn build:esm",
+		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs --copy-files && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm --copy-files && tsc -p tsconfig.json --declarationDir dist/esm",
 		"docs:prep": "typedoc"
 	},
 	"dependencies": {
@@ -46,38 +45,30 @@
 	"files": [
 		"dist/esm/**",
 		"dist/cjs/**",
-		"dist/types/**",
 		"chopsticks.cjs"
 	],
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.js",
 			"import": "./dist/esm/index.js",
 			"default": "./dist/esm/index.js"
 		},
 		"./*": {
-			"types": "./dist/types/*.d.ts",
 			"require": "./dist/cjs/*.js",
 			"import": "./dist/esm/*.js",
 			"default": "./dist/esm/*.js"
 		},
 		"./plugins/*": {
-			"types": "./dist/types/plugins/*.d.ts",
 			"require": "./dist/cjs/plugins/*.js",
 			"import": "./dist/esm/plugins/*.js",
 			"default": "./dist/esm/plugins/*.js"
 		},
 		"./utils/*": {
-			"types": "./dist/types/utils/*.d.ts",
 			"require": "./dist/cjs/utils/*.js",
 			"import": "./dist/esm/utils/*.js",
 			"default": "./dist/esm/utils/*.js"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+		}
 	}
 }
diff --git a/packages/chopsticks/tsconfig.json b/packages/chopsticks/tsconfig.json
@@ -2,7 +2,8 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"rootDir": "src",
-		"declarationDir": "dist/types"
+		"emitDeclarationOnly": true,
+		"declarationDir": "dist/esm"
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/**/*.test.ts"],

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -5,11 +5,10 @@
 	"license": "Apache-2.0",
 	"type": "module",
 	"scripts": {
-		"clean": "rm -rf dist",
-		"build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm",
-		"build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types",
+		"clean": "rm -rf dist tsconfig.tsbuildinfo",
+		"build": "yarn clean && yarn build:cjs && yarn build:esm",
+		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm && tsc -p tsconfig.json --declarationDir dist/esm",
 		"docs:prep": "typedoc"
 	},
 	"dependencies": {
@@ -38,27 +37,21 @@
 	},
 	"files": [
 		"dist/esm/**",
-		"dist/cjs/**",
-		"dist/types/**"
+		"dist/cjs/**"
 	],
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.js",
 			"import": "./dist/esm/index.js",
 			"default": "./dist/esm/index.js"
 		},
 		"./*": {
-			"types": "./dist/types/*.d.ts",
 			"require": "./dist/cjs/*.js",
 			"import": "./dist/esm/*.js",
 			"default": "./dist/esm/*.js"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+		}
 	},
 	"browser": {
 		"./dist/cjs/wasm-executor/node-worker.js": "./dist/cjs/wasm-executor/browser-worker.js",

diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -2,7 +2,8 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"rootDir": "src",
-		"declarationDir": "dist/types"
+		"emitDeclarationOnly": true,
+		"declarationDir": "dist/esm"
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/**/*.test.ts"]

diff --git a/packages/db/package.json b/packages/db/package.json
@@ -5,11 +5,10 @@
 	"license": "Apache-2.0",
 	"type": "module",
 	"scripts": {
-		"clean": "rm -rf dist",
-		"build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm",
-		"build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types"
+		"clean": "rm -rf dist tsconfig.tsbuildinfo",
+		"build": "yarn clean && yarn build:cjs && yarn build:esm",
+		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm && tsc -p tsconfig.json --declarationDir dist/esm"
 	},
 	"dependencies": {
 		"@acala-network/chopsticks-core": "workspace:*",
@@ -25,26 +24,20 @@
 	},
 	"files": [
 		"dist/esm/**",
-		"dist/cjs/**",
-		"dist/types/**"
+		"dist/cjs/**"
 	],
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.js",
 			"import": "./dist/esm/index.js",
 			"default": "./dist/esm/index.js"
 		},
 		"./*": {
-			"types": "./dist/types/*.d.ts",
 			"require": "./dist/cjs/*.js",
 			"import": "./dist/esm/*.js",
 			"default": "./dist/esm/*.js"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+		}
 	}
 }
diff --git a/packages/db/tsconfig.json b/packages/db/tsconfig.json
@@ -2,7 +2,8 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"rootDir": "src",
-		"declarationDir": "dist/types"
+		"emitDeclarationOnly": true,
+		"declarationDir": "dist/esm"
 	},
 	"include": ["src/**/*.ts"],
 	"exclude": ["src/**/*.test.ts"],

diff --git a/packages/testing/package.json b/packages/testing/package.json
@@ -5,11 +5,10 @@
 	"license": "Apache-2.0",
 	"type": "module",
 	"scripts": {
-		"clean": "rm -rf dist",
-		"build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm",
-		"build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types"
+		"clean": "rm -rf dist tsconfig.tsbuildinfo",
+		"build": "yarn clean && yarn build:cjs && yarn build:esm",
+		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm && tsc -p tsconfig.json --declarationDir dist/esm"
 	},
 	"dependencies": {
 		"@acala-network/chopsticks-utils": "workspace:*",
@@ -27,26 +26,20 @@
 	},
 	"files": [
 		"dist/esm/**",
-		"dist/cjs/**",
-		"dist/types/**"
+		"dist/cjs/**"
 	],
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.js",
 			"import": "./dist/esm/index.js",
 			"default": "./dist/esm/index.js"
 		},
 		"./*": {
-			"types": "./dist/types/*.d.ts",
 			"require": "./dist/cjs/*.js",
 			"import": "./dist/esm/*.js",
 			"default": "./dist/esm/*.js"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+		}
 	}
 }
diff --git a/packages/testing/tsconfig.json b/packages/testing/tsconfig.json
@@ -2,7 +2,8 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"rootDir": "src",
-		"declarationDir": "dist/types"
+		"emitDeclarationOnly": true,
+		"declarationDir": "dist/esm"
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/**/*.test.ts"],

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -5,11 +5,10 @@
 	"license": "Apache-2.0",
 	"type": "module",
 	"scripts": {
-		"clean": "rm -rf dist",
-		"build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
-		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm",
-		"build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types"
+		"clean": "rm -rf dist tsconfig.tsbuildinfo",
+		"build": "yarn clean && yarn build:cjs && yarn build:esm",
+		"build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+		"build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm && tsc -p tsconfig.json --declarationDir dist/esm"
 	},
 	"dependencies": {
 		"@acala-network/chopsticks": "workspace:*",
@@ -23,26 +22,20 @@
 	},
 	"files": [
 		"dist/esm/**",
-		"dist/cjs/**",
-		"dist/types/**"
+		"dist/cjs/**"
 	],
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
-			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.js",
 			"import": "./dist/esm/index.js",
 			"default": "./dist/esm/index.js"
 		},
 		"./*": {
-			"types": "./dist/types/*.d.ts",
 			"require": "./dist/cjs/*.js",
 			"import": "./dist/esm/*.js",
 			"default": "./dist/esm/*.js"
-		},
-		"./package.json": "./package.json",
-		"./package.cjs.json": "./dist/cjs/package.json"
+		}
 	}
 }
diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json
@@ -2,7 +2,8 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"rootDir": "src",
-		"declarationDir": "dist/types"
+		"emitDeclarationOnly": true,
+		"declarationDir": "dist/esm"
 	},
 	"include": ["src/**/*"],
 	"exclude": ["src/**/*.test.ts"],

diff --git a/publint.sh b/publint.sh
@@ -0,0 +1,6 @@
+npx publint run --strict executor
+npx publint run --strict packages/core
+npx publint run --strict packages/db
+npx publint run --strict packages/chopsticks
+npx publint run --strict packages/testing
+npx publint run --strict packages/utils