feat: enable features.typescript only when typescript is installe…

…d locally, fix #437
nuxt · Jul 27, 2024 · 77bc797 · 77bc797 · Revadike · Aug 22, 2024
1 parent ebc8f2c
commit 77bc797
Show file tree

Hide file tree

Showing 6 changed files with 450 additions and 23 deletions.
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -65,6 +65,7 @@
     "eslint-plugin-unicorn": "^55.0.0",
     "eslint-plugin-vue": "^9.27.0",
     "globals": "^15.8.0",
+    "local-pkg": "^0.5.0",
     "pathe": "^1.1.2",
     "tslib": "^2.6.3",
     "vue-eslint-parser": "^9.4.3"

diff --git a/packages/eslint-config/src/flat/index.ts b/packages/eslint-config/src/flat/index.ts
@@ -46,7 +46,9 @@ export function createConfigForNuxt(
       ignores(),
       javascript(),
       // Make these imports async, as they are optional and imports plugins
-      import('./configs/typescript').then(m => m.default(resolved)),
+      resolved.features.typescript !== false
+        ? import('./configs/typescript').then(m => m.default(resolved))
+        : undefined,
       import('./configs/vue').then(m => m.default(resolved)),
       import('./configs/import').then(m => m.default(resolved)),
     )

diff --git a/packages/eslint-config/src/flat/types.ts b/packages/eslint-config/src/flat/types.ts
@@ -50,9 +50,9 @@ export interface NuxtESLintFeaturesOptions {
   stylistic?: boolean | StylisticCustomizeOptions<true>
 
   /**
-   * Options for TypeScript setup
+   * Enable TypeScript support. Can also be an object to config the options.
    *
-   * @default true
+   * By default it enables automatic when `typescript` is installed in the project.
    */
   typescript?: boolean | {
     /**

diff --git a/packages/eslint-config/src/flat/utils.ts b/packages/eslint-config/src/flat/utils.ts
@@ -1,3 +1,4 @@
+import { isPackageExists } from 'local-pkg'
 import type { NuxtESLintConfigOptions, NuxtESLintConfigOptionsResolved } from '../flat'
 
 export function removeUndefined<T extends object>(obj: T): T {
@@ -31,7 +32,7 @@ export function resolveOptions(
     features: {
       standalone: true,
       stylistic: false,
-      typescript: true,
+      typescript: isPackageExists('typescript'),
       tooling: false,
       ...config.features,
     },

diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -2,13 +2,16 @@ export default defineNuxtConfig({
   modules: [
     '../packages/module/src/module',
   ],
+
   devtools: {
     enabled: true,
   },
+
   components: [
     '~/components',
     { path: '~/components-prefixed', prefix: 'Prefix' },
   ],
+
   eslint: {
     config: {
       stylistic: true,
@@ -18,4 +21,6 @@ export default defineNuxtConfig({
       fix: true,
     },
   },
+
+  compatibilityDate: '2024-07-27',
 })