nuxt-spec 0.1.10 → 0.1.11

package/README.md

@@ -36,7 +36,7 @@ If you don't want to use the CLI tool, or you want to understand its flow better
 1) Add following dependency into your `package.json`:
 
 ```
-"nuxt-spec": "0.1.10"
+"nuxt-spec": "0.1.11"
 ```
 
 2) Add following section into your `nuxt.config.ts`:
@@ -73,6 +73,20 @@ export default loadVitestConfig({
 }
 ```
 
+6) (Optional) Setup file structures for tests as follows:
+
+```
+test/
+├── e2e/
+│   └── nuxt-e2e.test.ts
+├── nuxt/
+│   └── nuxt-unit.test.ts
+└── unit/
+    └── vitest.test.ts
+```
+
+You can use sample files from the [project repository](https://github.com/AloisSeckar/nuxt-spec/tree/v0.1.11/test).
+
 ### Install and execute
 
 Whether you used the CLI tool or did the manual setup, you are ready to install and run the tests.
@@ -230,11 +244,11 @@ Planned future development:
 - reason about (not) using Vitest browser mode (or make it optional)
 - solution for visual testing - either [backstopjs](https://www.npmjs.com/package/backstopjs) or Vitest's native (currently experimental)
 
-See [CHANGELOG.md](https://github.com/AloisSeckar/nuxt-spec/blob/main/CHANGELOG.md) for the latest updates and features.
+See [CHANGELOG.md](https://github.com/AloisSeckar/nuxt-spec/blob/v0.1.11/CHANGELOG.md) for the latest updates and features.
 
 ## Configuration
 
-By default, `nuxt-spec` uses Vitest configuration defined in [`/config/index.mjs`](https://github.com/AloisSeckar/nuxt-spec/blob/main/config/index.mjs). The configuration is based on [Nuxt team recommendations](https://nuxt.com/docs/4.x/getting-started/testing) and our best judgement.
+By default, `nuxt-spec` uses Vitest configuration defined in [`/config/index.mjs`](https://github.com/AloisSeckar/nuxt-spec/blob/v0.1.11/config/index.mjs). The configuration is based on [Nuxt team recommendations](https://nuxt.com/docs/4.x/getting-started/testing) and our best judgement.
 
 To add/override your custom config, you can create (or scaffold via CLI tool) a file named `vitest.config.ts` in the root of your project with the following content:
 

package/bin/setup.js

@@ -14,10 +14,11 @@ import {
  * Then it:
  *  1) adds `nuxt-spec` into `package.json` dependencies and removes `nuxt`, `vue` and `vue-router` if present
  *  2) adds `extends: ['nuxt-spec']` to `nuxt.config.ts`
- *  3) creates/updates `.npmrc` file
+ *  3) creates/updates `.npmrc` file (only if pnpm is used)
  *  4) creates default `vitest.config.ts` file
  *  5) adds test-related scripts and pnpm approved build scripts (if using pnpm) in `package.json`
- *  6) clear node_modules and lock file(s)
+ *  6) creates sample test files
+ *  7) clear node_modules and lock file(s)
  *
  * @param {boolean} autoRun - Whether to run the setup automatically without any prompts (defaults to false).
  */
@@ -29,12 +30,14 @@ export async function specSetup(autoRun = false) {
   const isAutoRun = autoRun || await promptUser('Do you want to set everything up automatically (no more prompts)?')
   showMessage('')
 
+  const packageManager = getPackageManager()
+
   // 1) manage dependencies in package.json
 
   // add nuxt-spec
   try {
     await updateJsonFile('package.json', 'dependencies', {
-      'nuxt-spec': '0.1.10',
+      'nuxt-spec': '0.1.11',
     }, isAutoRun, 'This will add \'nuxt-spec\' dependency to your \'package.json\'. Continue?')
   } catch (error) {
     console.error('Error adding \'nuxt-spec\' dependency:\n', error.message)
@@ -98,21 +101,23 @@ export async function specSetup(autoRun = false) {
     console.error('Error updating \'nuxt.config.ts\':\n', error.message)
   }
 
-  // 3) .npmrc file
-  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-spec/refs/heads/main/.npmrc',
-        '.npmrc', isAutoRun, 'This will add \'.npmrc\' file for your project. Continue?')
+  // 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-spec/refs/tags/v0.1.11/.npmrc',
+          '.npmrc', isAutoRun, 'This will add \'.npmrc\' file for your project. Continue?')
+      }
+    } catch (error) {
+      console.error('Error setting up \'.npmrc\':\n', error.message)
     }
-  } catch (error) {
-    console.error('Error setting up \'.npmrc\':\n', error.message)
   }
 
   // 4) create vitest.config.ts
   try {
-    await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/heads/main/config/vitest.config.ts.template',
+    await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/tags/v0.1.11/config/vitest.config.ts.template',
       'vitest.config.ts', isAutoRun, '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)
@@ -132,7 +137,7 @@ export async function specSetup(autoRun = false) {
   }
 
   // add pnpm approved build scripts
-  if (getPackageManager() === 'pnpm') {
+  if (packageManager === 'pnpm') {
     try {
       await updateJsonFile('package.json', 'pnpm', {
         onlyBuiltDependencies: [
@@ -146,7 +151,30 @@ export async function specSetup(autoRun = false) {
     }
   }
 
-  // 6) clear node_modules and lock file(s)
+  // 6) 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.11/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.11/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.11/test/unit/vitest.test.ts',
+        'test/unit/vitest.test.ts', true)
+    } catch (error) {
+      console.error('Error setting up \'vitest.test.ts\':\n', error.message)
+    }
+  }
+
+  // 7) 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')) {
@@ -184,11 +212,17 @@ export async function specSetup(autoRun = false) {
         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 SPEC SETUP COMPLETE', 2)
-  showMessage(`Proceed with \`${getPackageManager()} install\` to get started.`)
-
+  showMessage(`Proceed with \`${packageManager} install\` to get started.`)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-spec",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Test-pack layer for Nuxt Applications",
   "repository": "github:AloisSeckar/nuxt-spec",
   "license": "MIT",