nuxt-spec 0.1.2 → 0.1.4

package/README.md

@@ -14,7 +14,7 @@ Aside from being "forked" and used as you seem fit, `nuxt-spec` is also availabl
 
 1) Add following dependency into your `package.json`:
 ```
-"nuxt-spec": "0.1.2"
+"nuxt-spec": "0.1.4"
 ```
 
 2) Add following section into your `nuxt.config.ts`:
@@ -79,12 +79,12 @@ See [CHANGELOG.md](https://github.com/AloisSeckar/nuxt-spec/blob/main/CHANGELOG.
 
 ## Configuration
 
-By default, `nuxt-spec` uses Vitest configuration defined in [`/utils/vitest-config.ts`](https://github.com/AloisSeckar/nuxt-spec/blob/main/utils/vitest-config.ts). 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/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.
 
-To add/override your custom config, you can create a file named `vitest.config.ts` in the root of your project with the following content:
+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:
 
 ```ts
-import { loadVitestConfig } from './app/utils/vitest-config'
+import { loadVitestConfig } from 'nuxt-spec/config'
 
 export default loadVitestConfig({
   // your custom config here

package/bin/spec-setup.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 // CLI tool to scaffold default `vitest.config.ts` file
 // and to add test-related commands in `package.json`
@@ -9,7 +9,7 @@ import { updatePackageJsonScripts } from './utils/modify-scripts.js'
 
 async function main() {
   // 1) create vitest.config.ts
-  await createFileFromTemplate('../vitest.config.ts', 'vitest.config.ts')
+  await createFileFromTemplate('../config/vitest.config.ts.template', 'vitest.config.ts')
 
   // 2) modify scripts in package.json
   await updatePackageJsonScripts({

package/{app/utils/vitest-config.ts → config/index.mjs}

@@ -11,6 +11,15 @@ export async function loadVitestConfig(userVitestConfig) {
   return defu(userVitestConfig, defineConfig({
     test: {
       projects: [
+        // default fallback to catch tests in /test folder
+        {
+          test: {
+            name: 'node',
+            include: ['test/*.{test,spec}.ts'],
+            environment: 'node',
+          },
+        },
+        // proposed setup for unit and e2e tests
         {
           test: {
             name: 'node',
@@ -18,6 +27,7 @@ export async function loadVitestConfig(userVitestConfig) {
             environment: 'node',
           },
         },
+        // proposed setup for Nuxt
         await defineVitestProject({
           test: {
             name: 'nuxt',

package/config/vitest.config.ts.template

@@ -0,0 +1,5 @@
+import { loadVitestConfig } from 'nuxt-spec/config'
+
+export default loadVitestConfig({
+  // custom config here
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-spec",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Test-pack layer for Nuxt Applications",
   "repository": "github:AloisSeckar/nuxt-spec",
   "license": "MIT",
@@ -9,6 +9,18 @@
   "bin": {
     "spec-setup": "./bin/spec-setup.js"
   },
+  "exports": {
+    "./config": {
+      "import": "./config/index.mjs",
+      "default": "./config/index.mjs"
+    }
+  },
+  "files": [
+    "app",
+    "bin",
+    "config",
+    "public"
+  ],
   "dependencies": {
     "@nuxt/test-utils": "3.19.2",
     "@vue/test-utils": "2.4.6",

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/.vscode/settings.json

@@ -1,9 +0,0 @@
-{
-    // enable auto-linting
-    "editor.codeActionsOnSave": {
-        "source.fixAll": "explicit",
-        "source.fixAll.eslint": "explicit"
-    },
-    // ESlint flat config
-    "eslint.useFlatConfig": true
-}

package/CHANGELOG.md

@@ -1,27 +0,0 @@
-# Changelog
-
-Overview of the newest features in Nuxt Spec.
-
-## 0.1.2
-
-**2025-08-09**
-
-- fix: target path for scaffolded `vitest.config.ts` (#3)
-
-## 0.1.1
-
-**2025-08-09**
-
-- feat: CLI tool for scaffolding `vitest.config.ts` and test-related scripts in `package.json`
-- docs: added `CHANGELOG.md` and fixed link to `playwright-core`
-
-## 0.1.0
-
-**2025-08-08**
-
-- initial release [v0.1.0](https://github.com/AloisSeckar/nuxt-spec/releases/tag/v0.1.0)
-- key features:
-  - Nuxt base layer for testing
-  - Nuxt v4 and Vitest v4 compatibility
-  - Integrated `vitest`, `@vitest/browser`, `happy-dom`, `playwright-core`, `@vue/test-utils`, `@nuxt/test-utils`
-  - Support for custom configuration via `loadVitestConfig` function in `vitest.config.ts`

package/eslint.config.mjs

@@ -1,37 +0,0 @@
-import withNuxt from './.nuxt/eslint.config.mjs'
-
-// config is being passed as an array of separate objects
-// as suggested here: https://github.com/nuxt/eslint/discussions/413
-
-export default withNuxt([
-
-  // `rules` section can follow, where you can change default eslint behaviour if needed
-  // you can adjust or even turn off some rules if you cannot or don't want to satisfy them
-  {
-    rules: {
-      // the default for this rule is "1", but I find it too restrictive
-      // https://eslint.vuejs.org/rules/max-attributes-per-line.html
-      'vue/max-attributes-per-line': ['error', {
-        singleline: {
-          max: 4,
-        },
-        multiline: {
-          max: 3,
-        },
-      }],
-      // the default rule forces newline after "else"
-      // I prefer using "} else {" on single row
-      'vue/html-closing-bracket-newline': [
-        'error',
-        {
-          multiline: 'never',
-          selfClosingTag: {
-            multiline: 'never',
-          },
-        },
-      ],
-      '@stylistic/brace-style': 'off',
-    },
-  },
-
-])

package/test/e2e/nuxt-e2e.test.ts

@@ -1,21 +0,0 @@
-import { setup, $fetch, createPage, url } from '@nuxt/test-utils/e2e'
-import { describe, expect, test } from 'vitest'
-
-describe('NuxtTestComponent E2E test', async () => {
-  // setup app.vue in headless browser
-  await setup()
-
-  test('component renders in browser', async () => {
-    // fetch for the rendered value
-    const html = await $fetch('/')
-    expect(html).toContain('Test Component')
-  })
-
-  test('with playwright', async () => {
-    // render page in headless browser
-    const page = await createPage()
-    await page.goto(url('/'), { waitUntil: 'hydration' })
-    const hasText = await page.getByText('Test Component').isVisible()
-    expect(hasText).toBeTruthy()
-  })
-})

package/test/nuxt/nuxt-unit.test.ts

@@ -1,28 +0,0 @@
-import { describe, test, expect } from 'vitest'
-import { mount } from '@vue/test-utils'
-import { mountSuspended } from '@nuxt/test-utils/runtime'
-import NuxtTestComponent from '../../app/components/NuxtTestComponent.vue'
-
-const text = 'custom-text'
-
-describe('NuxtTestComponent', () => {
-  test('component mounts and renders text properly', () => {
-    const wrapper = mount(NuxtTestComponent, {
-      propsData: {
-        text,
-      },
-    })
-    expect(wrapper.text()).toContain(text)
-  })
-})
-
-describe('NuxtTestComponentSuspended', () => {
-  test('component mounts using mountSuspended and renders text properly', async () => {
-    const component = await mountSuspended(NuxtTestComponent, {
-      props: {
-        text,
-      },
-    })
-    expect(component.html()).toContain(text)
-  })
-})

package/test/unit/vitest.test.ts

@@ -1,5 +0,0 @@
-import { expect, test } from 'vitest'
-
-test('vitest should run', () => {
-  expect(1).toBe(1)
-})

package/tsconfig.json

@@ -1,7 +0,0 @@
-// https://nuxt.com/docs/guide/directory-structure/tsconfig
-{
-  "extends": "./.nuxt/tsconfig.json",
-  "compilerOptions": {
-    "noUncheckedIndexedAccess": true
-  }
-}

package/vitest.config.ts

@@ -1,8 +0,0 @@
-// custom Vitest configuration wrapper that allows custom user config
-// to be merged with defaults provided by nuxt-spec package
-
-import { loadVitestConfig } from './app/utils/vitest-config'
-
-export default loadVitestConfig({
-  // custom config here
-})