ci: update scripts for documentation changes (#9055)

* ci: update scripts for documentation changes * refactor: use tsconfig files Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Jan 17, 2023 · 56ef3ad · 56ef3ad · vercel · Jan 17, 2023
1 parent 2e48faf
commit 56ef3ad
Show file tree

Hide file tree

Showing 29 changed files with 123 additions and 19 deletions.
diff --git a/packages/brokers/package.json b/packages/brokers/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"fmt": "yarn format",

diff --git a/packages/brokers/tsconfig.docs.json b/packages/brokers/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/builders/package.json b/packages/builders/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\" && yarn downlevel-dts ./dist-docs ./dist-docs",
+		"build:docs": "tsc -p tsconfig.docs.json && yarn downlevel-dts ./dist-docs ./dist-docs",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"fmt": "yarn format",

diff --git a/packages/builders/tsconfig.docs.json b/packages/builders/tsconfig.docs.json
@@ -0,0 +1,8 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs",
+		"exactOptionalPropertyTypes": false
+	}
+}
diff --git a/packages/collection/package.json b/packages/collection/package.json
@@ -5,15 +5,14 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"fmt": "yarn format",
 		"docs": "yarn build:docs && api-extractor run --local",
 		"prepack": "yarn lint && yarn test && yarn build",
 		"changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/collection/*'",
-		"release": "cliff-jumper",
-		"docs:declarations": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist\""
+		"release": "cliff-jumper"
 	},
 	"main": "./dist/index.js",
 	"module": "./dist/index.mjs",

diff --git a/packages/collection/tsconfig.docs.json b/packages/collection/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --fix --format=pretty",
 		"docs": "yarn build:docs && api-extractor run --local",

diff --git a/packages/core/tsconfig.docs.json b/packages/core/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/formatters/package.json b/packages/formatters/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"docs": "yarn build:docs && api-extractor run --local",

diff --git a/packages/formatters/tsconfig.docs.json b/packages/formatters/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/next/package.json b/packages/next/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"docs": "yarn build:docs && api-extractor run --local",

diff --git a/packages/next/tsconfig.docs.json b/packages/next/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/proxy/package.json b/packages/proxy/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"fmt": "yarn format",

diff --git a/packages/proxy/tsconfig.docs.json b/packages/proxy/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/rest/package.json b/packages/rest/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"fmt": "yarn format",

diff --git a/packages/rest/tsconfig.docs.json b/packages/rest/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/scripts/src/createPackage.ts b/packages/scripts/src/createPackage.ts
@@ -4,6 +4,7 @@ import { chdir } from 'node:process';
 import { copy } from 'fs-extra';
 import { parse as parseYAML, stringify as stringifyYAML } from 'yaml';
 import cliffJumperJSON from './template/.cliff-jumperrc.json';
+import apiExtractorJSON from './template/api-extractor.json';
 import templateJSON from './template/template.package.json';
 
 interface LabelerData {
@@ -52,6 +53,15 @@ export async function createPackage(packageName: string, packageDescription?: st
 
 	await writeFile('.cliff-jumperrc.json', JSON.stringify(newCliffJumperJSON, null, 2));
 
+	// Update api-extractor.json
+	const newApiExtractorJSON = { ...apiExtractorJSON };
+	newApiExtractorJSON.docModel.projectFolderUrl = newApiExtractorJSON.docModel.projectFolderUrl.replace(
+		'{name}',
+		packageName,
+	);
+
+	await writeFile('api-extractor.json', JSON.stringify(newApiExtractorJSON, null, 2));
+
 	// Move to github directory
 	chdir(join('..', '..', '.github'));
 

diff --git a/packages/scripts/src/template/api-extractor.json b/packages/scripts/src/template/api-extractor.json
@@ -0,0 +1,6 @@
+{
+	"extends": "../../api-extractor.json",
+	"docModel": {
+		"projectFolderUrl": "https://github.com/discordjs/discord.js/tree/main/packages/{name}"
+	}
+}
diff --git a/packages/scripts/src/template/default/api-extractor.json b/packages/scripts/src/template/default/api-extractor.json
diff --git a/packages/scripts/src/template/default/tsconfig.docs.json b/packages/scripts/src/template/default/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/scripts/src/template/template.package.json b/packages/scripts/src/template/template.package.json
@@ -5,9 +5,10 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
-		"docs": "api-extractor run --local",
+		"docs": "yarn build:docs && api-extractor run --local",
 		"prepack": "yarn build && yarn lint",
 		"changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/{name}/*'",
 		"release": "cliff-jumper"

diff --git a/packages/util/package.json b/packages/util/package.json
@@ -4,7 +4,7 @@
 	"description": "Utilities shared across Discord.js packages",
 	"scripts": {
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"test": "vitest run && tsd",
 		"lint": "prettier --check . && TIMING=1 eslint src --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && TIMING=1 eslint src --ext .mjs,.js,.ts --fix --format=pretty",

diff --git a/packages/util/tsconfig.docs.json b/packages/util/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/voice/package.json b/packages/voice/package.json
@@ -4,7 +4,7 @@
 	"description": "Implementation of the Discord Voice API for node.js",
 	"scripts": {
 		"build": "tsup && node scripts/postbuild.mjs",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"test": "jest --coverage",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",

diff --git a/packages/voice/tsconfig.docs.json b/packages/voice/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/packages/ws/package.json b/packages/ws/package.json
@@ -5,7 +5,7 @@
 	"scripts": {
 		"test": "vitest run",
 		"build": "tsup",
-		"build:docs": "tsc --emitDeclarationOnly --declarationMap --skipLibCheck --outDir \"dist-docs\"",
+		"build:docs": "tsc -p tsconfig.docs.json",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty",
 		"docs": "yarn build:docs && api-extractor run --local",

diff --git a/packages/ws/tsconfig.docs.json b/packages/ws/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../tsconfig.docs.json",
+	"include": ["src/**/*.ts"],
+	"compilerOptions": {
+		"outDir": "dist-docs"
+	}
+}
diff --git a/tsconfig.docs.json b/tsconfig.docs.json
@@ -0,0 +1,7 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"emitDeclarationOnly": true,
+		"skipLibCheck": true
+	}
+}
diff --git a/turbo.json b/turbo.json
@@ -130,8 +130,7 @@
 			"outputs": []
 		},
 		"docs": {
-			"dependsOn": ["^build"],
-			"outputs": ["../../api-extractor.json", "api-extractor.json", "docs/**", "tsconfig.json"]
+			"outputs": ["../../api-extractor.json", "api-extractor.json", "docs/**", "tsconfig.json", "dist-docs"]
 		},
 		"changelog": {
 			"outputs": ["cliff.toml", "CHANGELOG.md"]