Add tsconfig for Vue & CJS (directus#19197)

* Add tsconfig for Vue * Delete tsconfig.json * Use vue tsconfig for composables * Add changeset * Update changeset * Update changeset
luochuanyuewu · Jul 18, 2023 · e583c6b · e583c6b
1 parent 7ebd79a
commit e583c6b
Show file tree

Hide file tree

Showing 42 changed files with 141 additions and 72 deletions.
diff --git a/.changeset/forty-carrots-cover.md b/.changeset/forty-carrots-cover.md
@@ -0,0 +1,30 @@
+---
+"@directus/api": patch
+"@directus/components": patch
+"@directus/composables": patch
+"@directus/constants": patch
+"@directus/data-driver-postgres": patch
+"@directus/data-sql": patch
+"@directus/data": patch
+"@directus/errors": patch
+"@directus/extensions-sdk": patch
+"@directus/pressure": patch
+"@directus/random": patch
+"@directus/release-notes-generator": patch
+"@directus/schema": patch
+"@directus/storage-driver-azure": patch
+"@directus/storage-driver-cloudinary": patch
+"@directus/storage-driver-gcs": patch
+"@directus/storage-driver-local": patch
+"@directus/storage-driver-s3": patch
+"@directus/storage": patch
+"@directus/stores": patch
+"@directus/themes": patch
+"@directus/tsconfig": major
+"@directus/types": patch
+"@directus/update-check": patch
+"@directus/utils": patch
+"@directus/validation": patch
+---
+
+Added tsconfig for Vue & CJS
diff --git a/api/tsconfig.json b/api/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/docs/.vitepress/tsconfig.json b/docs/.vitepress/tsconfig.json
@@ -1,7 +1,4 @@
 {
-	"extends": "@vue/tsconfig/tsconfig.dom.json",
-	"compilerOptions": {
-		"lib": ["esnext", "dom", "dom.iterable"]
-	},
+	"extends": "@directus/tsconfig/vue",
 	"include": ["env.d.ts", "**/*.vue"]
 }
diff --git a/docs/package.json b/docs/package.json
@@ -17,7 +17,7 @@
 	},
 	"devDependencies": {
 		"@directus/format-title": "10.0.0",
-		"@vue/tsconfig": "0.4.0",
+		"@directus/tsconfig": "workspace:*",
 		"eslint-parser-plain": "0.1.0",
 		"eslint-plugin-markdown": "3.0.0",
 		"eslint-plugin-prettier": "npm:@paescuj/[email protected]",

diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/composables/tsconfig.json b/packages/composables/tsconfig.json
@@ -1,8 +1,7 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/vue",
 	"compilerOptions": {
-		"outDir": "dist",
-		"lib": ["es2022", "DOM"]
+		"outDir": "dist"
 	},
 	"include": ["src"],
 	"typedocOptions": {

diff --git a/packages/constants/tsconfig.json b/packages/constants/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/data-driver-postgres/tsconfig.json b/packages/data-driver-postgres/tsconfig.json
@@ -1,3 +1,3 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json"
+	"extends": "@directus/tsconfig/node18-esm"
 }
diff --git a/packages/data-sql/tsconfig.json b/packages/data-sql/tsconfig.json
@@ -1,3 +1,3 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json"
+	"extends": "@directus/tsconfig/node18-esm"
 }
diff --git a/packages/data/tsconfig.json b/packages/data/tsconfig.json
@@ -1,3 +1,3 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json"
+	"extends": "@directus/tsconfig/node18-esm"
 }
diff --git a/packages/errors/tsconfig.json b/packages/errors/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"isolatedModules": true
 	},

diff --git a/packages/extensions-sdk/tsconfig.json b/packages/extensions-sdk/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/pressure/tsconfig.json b/packages/pressure/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/random/tsconfig.json b/packages/random/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/release-notes-generator/src/index.ts b/packages/release-notes-generator/src/index.ts
@@ -1,9 +1,9 @@
 import { appendFileSync } from 'node:fs';
-import { MAIN_PACKAGE } from './constants';
-import { generateMarkdown } from './utils/generate-markdown';
-import { getInfo } from './utils/get-info';
-import { processPackages } from './utils/process-packages';
-import { processReleaseLines } from './utils/process-release-lines';
+import { MAIN_PACKAGE } from './constants.js';
+import { generateMarkdown } from './utils/generate-markdown.js';
+import { getInfo } from './utils/get-info.js';
+import { processPackages } from './utils/process-packages.js';
+import { processReleaseLines } from './utils/process-release-lines.js';
 
 const { defaultChangelogFunctions, changesets } = processReleaseLines();
 

diff --git a/packages/release-notes-generator/src/types.ts b/packages/release-notes-generator/src/types.ts
@@ -1,6 +1,6 @@
 import { getInfo } from '@changesets/get-github-info';
 import type { NewChangesetWithCommit } from '@changesets/types';
-import { TYPE_MAP, UNTYPED_PACKAGES } from './constants';
+import { TYPE_MAP, UNTYPED_PACKAGES } from './constants.js';
 
 type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
 

diff --git a/packages/release-notes-generator/src/utils/generate-markdown.test.ts b/packages/release-notes-generator/src/utils/generate-markdown.test.ts
@@ -1,7 +1,7 @@
 import { describe, expect, test } from 'vitest';
-import { NOTICE_TYPE, TYPE_MAP, UNTYPED_PACKAGES } from '../constants';
-import type { Change, Notice, PackageVersion, Type, UntypedPackage } from '../types';
-import { generateMarkdown } from './generate-markdown';
+import { NOTICE_TYPE, TYPE_MAP, UNTYPED_PACKAGES } from '../constants.js';
+import type { Change, Notice, PackageVersion, Type, UntypedPackage } from '../types.js';
+import { generateMarkdown } from './generate-markdown.js';
 
 const change1: Change = {
 	summary: "Made Directus even more magical\nAnd here's some additional context",

diff --git a/packages/release-notes-generator/src/utils/generate-markdown.ts b/packages/release-notes-generator/src/utils/generate-markdown.ts
@@ -1,5 +1,5 @@
-import { NOTICE_TYPE, REPO, VERSIONS_TITLE } from '../constants';
-import type { Change, Notice, Package, PackageVersion, Type, UntypedPackage } from '../types';
+import { NOTICE_TYPE, REPO, VERSIONS_TITLE } from '../constants.js';
+import type { Change, Notice, Package, PackageVersion, Type, UntypedPackage } from '../types.js';
 
 type Section = Type & { notices: Notice[] };
 

diff --git a/packages/release-notes-generator/src/utils/get-info.ts b/packages/release-notes-generator/src/utils/get-info.ts
@@ -1,7 +1,7 @@
 import { getInfo as getGithubInfo } from '@changesets/get-github-info';
-import { MAIN_PACKAGE, PACKAGE_ORDER, REPO, TYPE_MAP, UNTYPED_PACKAGES } from '../constants';
-import type { Change, Changesets, Notice, Type, UntypedPackage } from '../types';
-import { sortByExternalOrder, sortByObjectValues } from './sort';
+import { MAIN_PACKAGE, PACKAGE_ORDER, REPO, TYPE_MAP, UNTYPED_PACKAGES } from '../constants.js';
+import type { Change, Changesets, Notice, Type, UntypedPackage } from '../types.js';
+import { sortByExternalOrder, sortByObjectValues } from './sort.js';
 
 export async function getInfo(changesets: Changesets): Promise<{
 	types: Type[];

diff --git a/packages/release-notes-generator/src/utils/process-packages.ts b/packages/release-notes-generator/src/utils/process-packages.ts
@@ -2,9 +2,9 @@ import { findWorkspaceDir } from '@pnpm/find-workspace-dir';
 import { Project, findWorkspacePackagesNoCheck } from '@pnpm/find-workspace-packages';
 import { existsSync, unlinkSync } from 'node:fs';
 import { join } from 'node:path';
-import { MAIN_PACKAGE, PACKAGE_ORDER, UNTYPED_PACKAGES } from '../constants';
-import type { PackageVersion } from '../types';
-import { sortByExternalOrder } from './sort';
+import { MAIN_PACKAGE, PACKAGE_ORDER, UNTYPED_PACKAGES } from '../constants.js';
+import type { PackageVersion } from '../types.js';
+import { sortByExternalOrder } from './sort.js';
 
 export async function processPackages(): Promise<{
 	mainVersion: string | undefined;

diff --git a/packages/release-notes-generator/src/utils/process-release-lines.test.ts b/packages/release-notes-generator/src/utils/process-release-lines.test.ts
@@ -1,6 +1,6 @@
 import { NewChangesetWithCommit, VersionType } from '@changesets/types';
 import { expect, test } from 'vitest';
-import { processReleaseLines } from './process-release-lines';
+import { processReleaseLines } from './process-release-lines.js';
 
 test('should process release lines', async () => {
 	const { defaultChangelogFunctions, changesets } = processReleaseLines();

diff --git a/packages/release-notes-generator/src/utils/process-release-lines.ts b/packages/release-notes-generator/src/utils/process-release-lines.ts
@@ -1,5 +1,5 @@
 import type { ChangelogFunctions, GetDependencyReleaseLine, GetReleaseLine } from '@changesets/types';
-import type { Changesets } from '../types';
+import type { Changesets } from '../types.js';
 
 export function processReleaseLines(): { defaultChangelogFunctions: ChangelogFunctions; changesets: Changesets } {
 	const changesets: Changesets = new Map();

diff --git a/packages/release-notes-generator/tsconfig.json b/packages/release-notes-generator/tsconfig.json
@@ -1,8 +1,6 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-cjs",
 	"compilerOptions": {
-		"module": "CommonJS",
-		"verbatimModuleSyntax": false,
 		"outDir": "dist"
 	},
 	"include": ["src"]

diff --git a/packages/schema/tsconfig.json b/packages/schema/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage-driver-azure/tsconfig.json b/packages/storage-driver-azure/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage-driver-cloudinary/tsconfig.json b/packages/storage-driver-cloudinary/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage-driver-gcs/tsconfig.json b/packages/storage-driver-gcs/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage-driver-local/tsconfig.json b/packages/storage-driver-local/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage-driver-s3/tsconfig.json b/packages/storage-driver-s3/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/storage/tsconfig.json b/packages/storage/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/stores/tsconfig.json b/packages/stores/tsconfig.json
@@ -1,8 +1,6 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
-	"compilerOptions": {
-		"lib": ["es2022", "DOM"]
-	},
+	"extends": "@directus/tsconfig/vue",
+	"include": ["src"],
 	"typedocOptions": {
 		"entryPoints": ["./src/index.ts"]
 	}

diff --git a/packages/themes/tsconfig.json b/packages/themes/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/tsconfig/node18-esm.json → packages/tsconfig/base/tsconfig.json b/packages/tsconfig/node18-esm.json → packages/tsconfig/base/tsconfig.json
@@ -1,15 +1,11 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig",
-	"display": "Node 18 ESM",
+	"display": "Base",
 	"compilerOptions": {
-		"lib": ["es2022"],
-		"module": "es2022",
-		"target": "es2022",
 		"strict": true,
 		"esModuleInterop": true,
 		"skipLibCheck": true,
 		"forceConsistentCasingInFileNames": true,
-		"moduleResolution": "NodeNext",
 		"allowUnusedLabels": false,
 		"allowUnreachableCode": false,
 		"exactOptionalPropertyTypes": true,
@@ -20,7 +16,6 @@
 		"noUncheckedIndexedAccess": true,
 		"noUnusedLocals": true,
 		"noUnusedParameters": true,
-		"verbatimModuleSyntax": true,
 		"checkJs": true,
 		"allowSyntheticDefaultImports": true,
 		"declaration": true

diff --git a/packages/tsconfig/node18-cjs/tsconfig.json b/packages/tsconfig/node18-cjs/tsconfig.json
@@ -0,0 +1,10 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"display": "CommonJS",
+	"extends": "../base/tsconfig.json",
+	"compilerOptions": {
+		"module": "CommonJS",
+		"target": "ES2022",
+		"moduleResolution": "NodeNext"
+	}
+}
diff --git a/packages/tsconfig/node18-esm/tsconfig.json b/packages/tsconfig/node18-esm/tsconfig.json
@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"display": "Node 18 ESM",
+	"extends": "../base/tsconfig.json",
+	"compilerOptions": {
+		"module": "ES2022",
+		"target": "ES2022",
+		"moduleResolution": "NodeNext",
+		"verbatimModuleSyntax": true
+	}
+}
diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json
@@ -11,7 +11,10 @@
 	"funding": "https://github.com/directus/directus?sponsor=1",
 	"license": "MIT",
 	"author": "Rijk van Zanten <[email protected]>",
-	"files": [
-		"./node18-esm.json"
-	]
+	"exports": {
+		"./base": "./base/tsconfig.json",
+		"./node18-cjs": "./node18-cjs/tsconfig.json",
+		"./node18-esm": "./node18-esm/tsconfig.json",
+		"./vue": "./vue/tsconfig.json"
+	}
 }
diff --git a/packages/tsconfig/vue/tsconfig.json b/packages/tsconfig/vue/tsconfig.json
@@ -0,0 +1,32 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"display": "Vue",
+	"extends": "../base/tsconfig.json",
+	"compilerOptions": {
+		// It's recommended to author and ship in ES modules.
+		// This recommendation includes environments like Vitest, Vite Config File, Vite SSR, etc.
+		"module": "ES2022",
+
+		// - Vue 3 supports ES2016+
+		// - For Vite, the actual compilation target is determined by the
+		//   `build.target` option in the Vite config.
+		//   So don't change the `target` field here. It has to be
+		//   at least `ES2020` for dynamic `import()`s and `import.meta` to work correctly.
+		"target": "ES2022",
+
+		// Add DOM definitions.
+		"lib": ["ES2022", "DOM", "DOM.Iterable"],
+
+		// Enable some resolution features that are only available in bundlers.
+		"moduleResolution": "bundler",
+		"resolveJsonModule": true,
+
+		// Any imports or exports without a type modifier are left around. This is important for `<script setup>`.
+		// Anything that uses the type modifier is dropped entirely.
+		"verbatimModuleSyntax": true,
+
+		// Required in Vue projects
+		"jsx": "preserve",
+		"jsxImportSource": "vue"
+	}
+}
diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/update-check/tsconfig.json b/packages/update-check/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},

diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json
@@ -1,5 +1,5 @@
 {
-	"extends": "@directus/tsconfig/node18-esm.json",
+	"extends": "@directus/tsconfig/node18-esm",
 	"compilerOptions": {
 		"outDir": "dist"
 	},