nuxt-ignis 0.5.0-rc.1 → 0.5.0-rc.2

package/bin/setup.js

@@ -1,56 +1,119 @@
 #!/usr/bin/env node
 
-import { createFileFromWebTemplate, promptUser, showMessage, updateConfigFile, updateJsonFile, updateTextFile } from 'elrh-cosca'
+import {
+  createFileFromWebTemplate, deletePath, getPackageManager, hasJsonKey,
+  pathExists, promptUser, removeFromJsonFile, showMessage,
+  updateConfigFile, updateJsonFile, updateTextFile,
+} from 'elrh-cosca'
 
 /**
  * CLI tool to setup Nuxt Ignis for a new project.
  *
- * Usage: `npx nuxt-ignis setup` in target folder.
+ * Usage: `npx nuxt-ignis setup [true|false]` in target folder.
  *
- * Has two modes:
- * - automatic - no prompts except the first one
- * - interactive - with prompts for each step
+ * The script will first ask whether to run in "auto" mode (no prompts, force = true) or "manual" mode (with prompts, force = false). If `autoRun = true` is passed, no prompt will be shown.
+ *
+ * The script will:
+ *  1) add `nuxt-ignis` into `package.json` dependencies, remove `nuxt`, `vue` and `vue-router` if present and adjust `pnpm` settings if `pnpm` is used
+ *  2) add `extends: ['nuxt-ignis']` to `nuxt.config.ts`
+ *  3) create/update `.npmrc` file (only if pnpm is used)
+ *  4) update `.gitignore` file
+ *  5) create default `vitest.config.ts` file and add test-related scripts into `package.json`
+ *  6) clear node_modules and lock file(s)
  */
-async function nuxtIgnisSetup() {
+export async function nuxtIgnisSetup(autoRun = false) {
   showMessage('NUXT IGNIS SETUP')
   showMessage('This CLI tool will help you include Nuxt Ignis in your project.')
   showMessage('Refer to the documentation for more information.', 2)
 
-  const auto = await promptUser('Do you want to set everything up automatically (no more prompts)?')
+  const isAutoRun = autoRun || await promptUser('Do you want to set everything up automatically (no more prompts)?')
   showMessage('')
 
+  const packageManager = getPackageManager()
+
   // 1.1 - add nuxt-ignis dependency
   try {
-    await updateJsonFile('package.json', 'dependencies', { 'nuxt-ignis': '0.5.0-rc.1' },
-      auto, 'This will add \'nuxt-ignis\' dependency to your \'package.json\'. Proceed?')
+    await updateJsonFile('package.json', 'dependencies', { 'nuxt-ignis': '0.5.0-rc.2' },
+      isAutoRun, 'This will add \'nuxt-ignis\' dependency to your \'package.json\'. Proceed?')
   } catch (error) {
     console.error('Error adding \'nuxt-ignis\' dependency:\n', error.message)
   }
 
-  // 1.2 - adjust pnpm settings
-  const pnpmSettings = auto || await promptUser('This will adjust pnpm settings in your \'package.json\'. Proceed?')
-  if (pnpmSettings) {
-    try {
-      await updateJsonFile('package.json', 'pnpm', {
-        onlyBuiltDependencies: [
-          '@parcel/watcher',
-          '@tailwindcss/oxide',
-          'better-sqlite3',
-          'esbuild',
-          'maplibre-gl',
-          'puppeteer',
-          'sharp',
-          'unrs-resolver',
-          'vue-demi',
-        ],
-      }, true)
-    } catch (error) {
-      console.error('Error adjusting pnpm settings:\n', error.message)
+  // 1.2 - remove now obsolete nuxt, vue and vue-router
+  const removeDeps = isAutoRun || await promptUser('As \'nuxt-ignis\' provides \'nuxt\', \'vue\' and \'vue-router\' dependencies out of the box, do you want to remove them from your \'package.json\' to avoid duplications and possible version clashes?')
+  if (removeDeps) {
+    if (hasJsonKey('package.json', 'dependencies.nuxt')) {
+      try {
+        await removeFromJsonFile('package.json', 'dependencies.nuxt', true)
+      } catch (error) {
+        console.error('Error removing \'nuxt\' dependency:\n', error.message)
+      }
     }
-    try {
-      await updateJsonFile('package.json', 'packageManager', 'pnpm@10.17.0', true)
-    } catch (error) {
-      console.error('Error setting packageManager:\n', error.message)
+    if (hasJsonKey('package.json', 'dependencies.vue')) {
+      try {
+        await removeFromJsonFile('package.json', 'dependencies.vue', true)
+      } catch (error) {
+        console.error('Error removing \'vue\' dependency:\n', error.message)
+      }
+    }
+    if (hasJsonKey('package.json', 'dependencies.vue-router')) {
+      try {
+        await removeFromJsonFile('package.json', 'dependencies.vue-router', true)
+      } catch (error) {
+        console.error('Error removing \'vue-router\' dependency:\n', error.message)
+      }
+    }
+    if (hasJsonKey('package.json', 'devDependencies.nuxt')) {
+      try {
+        await removeFromJsonFile('package.json', 'devDependencies.nuxt', true)
+      } catch (error) {
+        console.error('Error removing \'nuxt\' devDependency:\n', error.message)
+      }
+    }
+    if (hasJsonKey('package.json', 'devDependencies.vue')) {
+      try {
+        await removeFromJsonFile('package.json', 'devDependencies.vue', true)
+      } catch (error) {
+        console.error('Error removing \'vue\' devDependency:\n', error.message)
+      }
+    }
+    if (hasJsonKey('package.json', 'devDependencies.vue-router')) {
+      try {
+        await removeFromJsonFile('package.json', 'devDependencies.vue-router', true)
+      } catch (error) {
+        console.error('Error removing \'vue-router\' devDependency:\n', error.message)
+      }
+    }
+  }
+
+  // 1.3 - adjust pnpm settings
+  if (packageManager === 'pnpm') {
+    const pnpmSettings = isAutoRun || await promptUser('This will adjust pnpm settings in your \'package.json\'. Proceed?')
+    if (pnpmSettings) {
+      try {
+        // allow related build scripts
+        await updateJsonFile('package.json', 'pnpm', {
+          onlyBuiltDependencies: [
+            '@parcel/watcher',
+            '@tailwindcss/oxide',
+            'better-sqlite3',
+            'esbuild',
+            'maplibre-gl',
+            'puppeteer',
+            'sharp',
+            'unrs-resolver',
+            'vue-demi',
+          ],
+        }, true)
+      } catch (error) {
+        console.error('Error adjusting pnpm settings:\n', error.message)
+      }
+      // set pnpm as package manager
+      try {
+        await updateJsonFile('package.json', 'packageManager', 'pnpm@10.18.0', true)
+      } catch (error) {
+        console.error('Error setting packageManager:\n', error.message)
+      }
     }
   }
 
@@ -60,17 +123,24 @@ async function nuxtIgnisSetup() {
       extends: [
         'nuxt-ignis',
       ],
-    }, auto, 'This will add \'nuxt-ignis\' module to your \'nuxt.config.ts\'. Continue?')
+    }, isAutoRun, 'This will add \'nuxt-ignis\' module to your \'nuxt.config.ts\'. Continue?')
   } catch (error) {
     console.error('Error enabling \'nuxt-ignis\' module:\n', error.message)
   }
 
-  // 3 - .npmrc file
-  try {
-    await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-ignis/refs/heads/main/core/.npmrc',
-      '.npmrc', auto, 'This will set \'.npmrc\' file for your project. Continue?')
-  } catch (error) {
-    console.error('Error setting .npmrc file:\n', error.message)
+  // 3 - .npmrc file (only if pnpm is used)
+  if (packageManager === 'pnpm') {
+    try {
+      if (pathExists('.npmrc')) {
+        await updateTextFile('.npmrc', ['shamefully-hoist=true'], isAutoRun,
+          'This will adjust \'.npmrc\' file in your project. Continue?')
+      } else {
+        await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-ignis/refs/tags/v0.4.0/core/.npmrc',
+          '.npmrc', isAutoRun, 'This will add \'.npmrc\' file for your project. Continue?')
+      }
+    } catch (error) {
+      console.error('Error setting \'.npmrc\':\n', error.message)
+    }
   }
 
   // 4 - .gitignore file
@@ -80,13 +150,106 @@ async function nuxtIgnisSetup() {
       '# Nuxt Ignis files',
       '# configuration overview created upon Nuxt Ignis start',
       '_ignis-config.json',
-    ], auto, 'This will add Nuxt Ignis-related entries into your \'.gitignore\'. Continue?')
+    ], isAutoRun, 'This will add Nuxt Ignis-related entries into your \'.gitignore\'. Continue?')
   } catch (error) {
     console.error('Error updating .gitignore file:\n', error.message)
   }
-}
 
-nuxtIgnisSetup().catch((err) => {
-  console.error(err)
-  process.exit(1)
-})
+  // 5) nuxt-spec related setup
+  const setupNuxtSpec = isAutoRun || await promptUser('Nuxt Ignis comes with support for testing. Do you want to set up the default test settings now?')
+  if (setupNuxtSpec) {
+    // create vitest.config.ts
+    try {
+      await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/tags/v0.1.12/config/vitest.config.ts.template',
+        'vitest.config.ts', true, 'This will create a new \'vitest.config.ts\' file for your project. Continue?')
+    } catch (error) {
+      console.error('Error setting up \'vitest.config.ts\':\n', error.message)
+    }
+
+    // add scripts for running tests into package.json
+    try {
+      await updateJsonFile('package.json', 'scripts', {
+        'test': 'vitest run',
+        'test-u': 'vitest run -u',
+        'test-i': 'vitest',
+      }, true, 'This will adjust the test-related commands in your \'package.json\'. Continue?')
+    } catch (error) {
+      console.error('Error adjusting scripts in \'package.json\':\n', error.message)
+    }
+
+    // create sample test files
+    const createSampleTests = isAutoRun || await promptUser('Do you want to create sample tests in \'/test\' folder?')
+    if (createSampleTests) {
+      try {
+        await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/tags/v0.1.12/test/e2e/nuxt-e2e.test.ts',
+          'test/e2e/nuxt-e2e.test.ts', true)
+      } catch (error) {
+        console.error('Error setting up \'nuxt-e2e.test.ts\':\n', error.message)
+      }
+      try {
+        await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/tags/v0.1.12/test/nuxt/nuxt-unit.test.ts',
+          'test/nuxt/nuxt-unit.test.ts', true)
+      } catch (error) {
+        console.error('Error setting up \'nuxt-unit.test.ts\':\n', error.message)
+      }
+      try {
+        await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/tags/v0.1.12/test/unit/vitest.test.ts',
+          'test/unit/vitest.test.ts', true)
+      } catch (error) {
+        console.error('Error setting up \'vitest.test.ts\':\n', error.message)
+      }
+    }
+  }
+
+  // 6) clear node_modules and lock file(s)
+  const prepareForReinstall = isAutoRun || await promptUser('Dependencies should be re-installed now. Do you want to remove node_modules and the lock file?')
+  if (prepareForReinstall) {
+    if (pathExists('node_modules')) {
+      try {
+        await deletePath('node_modules', true)
+      } catch (error) {
+        console.error('Error deleting \'node_modules\':\n', error.message)
+      }
+    }
+    if (pathExists('package-lock.json')) {
+      try {
+        await deletePath('package-lock.json', true)
+      } catch (error) {
+        console.error('Error deleting \'package-lock.json\':\n', error.message)
+      }
+    }
+    if (pathExists('pnpm-lock.yaml')) {
+      try {
+        await deletePath('pnpm-lock.yaml', true)
+      } catch (error) {
+        console.error('Error deleting \'pnpm-lock.yaml\':\n', error.message)
+      }
+    }
+    if (pathExists('yarn.lock')) {
+      try {
+        await deletePath('yarn.lock', true)
+      } catch (error) {
+        console.error('Error deleting \'yarn.lock\':\n', error.message)
+      }
+    }
+    if (pathExists('bun.lockb')) {
+      try {
+        await deletePath('bun.lockb', true)
+      } catch (error) {
+        console.error('Error deleting \'bun.lockb\':\n', error.message)
+      }
+    }
+    if (pathExists('deno.lock')) {
+      try {
+        await deletePath('deno.lock', true)
+      } catch (error) {
+        console.error('Error deleting \'deno.lock\':\n', error.message)
+      }
+    }
+  }
+
+  // 7) inform user
+  showMessage('')
+  showMessage('NUXT IGNIS SETUP COMPLETE', 2)
+  showMessage(`Proceed with \`${packageManager} install\` to get started.`)
+}

package/features.ts

@@ -10,7 +10,11 @@ import type { NuxtConfig } from 'nuxt/schema'
 
 const currentDir = dirname(fileURLToPath(import.meta.url))
 
-export function setFeatures(): NuxtConfig {
+// core function to determine effective config for the current Nuxt app instance
+// custom settings are based on passed in environment variables
+// and will be defu-merged with provided defaults
+// printOverview = true is used in tests to capture console output
+export function setFeatures(printOverview: boolean = false): { nuxtConfig: NuxtConfig, overview: string } {
   // list of optional extra features
   const extras = [] as string[]
   // list of Nuxt-related settings
@@ -271,7 +275,7 @@ export function setFeatures(): NuxtConfig {
             log.debug(`Nuxt Content file ${file.id} processed with elrh-pslo`)
           },
         },
-      }, nuxtConfig)
+      }, nuxtConfig) as NuxtConfig
     }
   }
 
@@ -351,10 +355,8 @@ export function setFeatures(): NuxtConfig {
   }
 
   // 6. verify results
-  // TODO why this run twice? (SSR?)
-
-  let overview = `Nuxt Ignis will start using following settings:\n`
-  overview += `App title: ${appTitle}\n`
+  // return as string to be logged in 'schema:resolved' hook (to prevent multiple logs)
+  let overview = `App title: ${appTitle}\n`
   overview += `Modules: ${nuxtConfig.modules!.join(', ')}\n`
   if (extras.length > 0) {
     overview += `Extras: ${extras.join(', ')}\n`
@@ -362,7 +364,14 @@ export function setFeatures(): NuxtConfig {
   if (nuxt.length > 0) {
     overview += `Nuxt: ${nuxt.join(', ')}\n`
   }
-  log.info(overview)
 
-  return nuxtConfig
+  // used in tests to capture console output
+  if (printOverview) {
+    log.info('Nuxt Ignis will start using following settings:\n' + overview)
+  }
+
+  return {
+    nuxtConfig,
+    overview,
+  }
 }

package/nuxt.config.ts

@@ -1,6 +1,7 @@
 import { writeFileSync, existsSync, mkdirSync } from 'fs'
 import { dirname } from 'path'
 import { defu } from 'defu'
+import { log } from './app/utils/consola'
 import { setFeatures } from './features'
 import type { NuxtConfig } from '@nuxt/schema'
 
@@ -121,21 +122,25 @@ const baseConfig: NuxtConfig = {
   },
   hooks: {
     'schema:resolved'() {
-      const currentConfig = JSON.stringify(currentFeatures, null, 2)
-      const outPath = './public/_ignis-config.json'
+      // write current config to file (for use in app)
+      const configObject = JSON.stringify(currentFeatures.nuxtConfig, null, 2)
 
+      const outPath = './public/_ignis-config.json'
       const outDir = dirname(outPath)
       if (!existsSync(outDir)) {
         mkdirSync(outDir, { recursive: true })
       }
 
-      writeFileSync(outPath, currentConfig)
+      writeFileSync(outPath, configObject)
+
+      // display settings overview in console (just once)
+      log.info('\nNuxt Ignis will start using following settings:\n' + currentFeatures.overview)
     },
   },
 }
 
 // to avoid type inference issues
-const effectiveConfig = defu(currentFeatures, baseConfig) as NuxtConfig
+const effectiveConfig = defu(currentFeatures.nuxtConfig, baseConfig) as NuxtConfig
 
 // https://nuxt.com/docs/getting-started/configuration#nuxt-configuration
 // using spread operator to avoid Proxy issues

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-ignis",
-  "version": "0.5.0-rc.1",
+  "version": "0.5.0-rc.2",
   "description": "A ready-to-use setup for your next application in Nuxt",
   "keywords": [
     "nuxt",
@@ -11,7 +11,7 @@
     "nuxt-layer"
   ],
   "author": "Alois Seckar <alois.seckar@gmail.com>",
-  "homepage": "https://github.com/AloisSeckar/nuxt-ignis",
+  "homepage": "https://nuxt-ignis.com/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AloisSeckar/nuxt-ignis.git"
@@ -27,9 +27,7 @@
     "node": "^20.19.0 || >=22.12.0"
   },
   "bin": {
-    "setup": "./bin/setup.js",
-    "set-css": "./bin/set-css.js",
-    "set-eslint": "./bin/set-eslint.js"
+    "nuxt-ignis": "./bin/cli.js"
   },
   "dependencies": {
     "@formkit/nuxt": "1.6.9",
@@ -38,38 +36,38 @@
     "@nuxt/eslint": "1.9.0",
     "@nuxt/fonts": "0.11.4",
     "@nuxt/image": "1.11.0",
-    "@nuxt/scripts": "0.11.13",
-    "@nuxt/ui": "3.3.4",
-    "@nuxtjs/i18n": "10.1.0",
+    "@nuxt/scripts": "0.13.0",
+    "@nuxt/ui": "3.3.6",
+    "@nuxtjs/i18n": "10.1.1",
     "@nuxtjs/seo": "3.2.2",
     "@nuxtjs/supabase": "1.6.2",
     "@nuxtjs/tailwindcss": "6.14.0",
     "@pinia/nuxt": "0.11.2",
-    "@tailwindcss/vite": "4.1.13",
-    "@vueform/nuxt": "1.20.0",
+    "@tailwindcss/vite": "4.1.14",
+    "@vueform/nuxt": "1.21.0",
     "@vueuse/core": "13.9.0",
     "@vueuse/nuxt": "13.9.0",
     "better-sqlite3": "12.2.0",
     "consola": "3.4.2",
     "date-fns": "4.1.0",
     "defu": "6.1.4",
-    "elrh-cosca": "0.2.8",
+    "elrh-cosca": "0.3.4",
     "elrh-pslo": "1.1.6",
     "magic-regexp": "0.10.0",
-    "nuxt": "4.1.2",
+    "nuxt": "4.1.3",
     "nuxt-auth-utils": "0.5.25",
     "nuxt-charts": "0.2.4",
     "nuxt-neon": "0.7.0",
     "nuxt-security": "2.4.0",
-    "nuxt-spec": "0.1.8",
+    "nuxt-spec": "0.1.12",
     "open-props": "1.7.16",
     "pinia": "3.0.3",
     "postcss-jit-props": "1.0.16",
-    "typescript": "5.9.2",
+    "typescript": "5.9.3",
     "valibot": "1.1.0",
-    "vue": "3.5.21",
-    "vue-router": "4.5.1",
-    "zod": "4.1.11"
+    "vue": "3.5.22",
+    "vue-router": "4.6.3",
+    "zod": "4.1.12"
   },
   "scripts": {
     "analyze": "nuxt analyze",