nuxt-spec 0.3.4 → 0.4.0-alpha.1

package/LICENSE

@@ -1,21 +1,21 @@
-# MIT License
-
-Copyright (c) 2025-present Alois Sečkár
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# MIT License
+
+Copyright (c) 2025-present Alois Sečkár
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,13 +1,13 @@
-# Nuxt Spec
-
-![Nuxt Spec](https://github.com/AloisSeckar/nuxt-spec/blob/main/public/nuxt-spec.png)
-
-A _"testing done right"_ Nuxt base layer.
-
-## How to use
-
-See [ONLINE DOCS](https://nuxt-spec.netlify.app) for all the necessary information.
-
-See [CHANGELOG](https://nuxt-spec.netlify.app/3-1-changelog.html) for the full list of changes.
-
-See [CONTRIBUTING](https://nuxt-spec.netlify.app/4-1-contributing.html) if you want to help.
+# Nuxt Spec
+
+![Nuxt Spec](https://github.com/AloisSeckar/nuxt-spec/blob/main/public/nuxt-spec.png)
+
+A _"testing done right"_ Nuxt base layer.
+
+## How to use
+
+See [ONLINE DOCS](https://nuxt-spec.netlify.app) for all the necessary information.
+
+See [CHANGELOG](https://nuxt-spec.netlify.app/3-1-changelog.html) for the full list of changes.
+
+See [CONTRIBUTING](https://nuxt-spec.netlify.app/4-1-contributing.html) if you want to help.

package/app/app.vue

@@ -1,10 +1,10 @@
-<template>
-  <div>
-    <NuxtWelcome />
-    <div>
-      Test-pack layer for <a href="https://nuxt.com/">Nuxt</a> applications
-    </div>
-    <NuxtSpecTestComponent id="test" text="Test Component" />
-    <NuxtSpecApiTestComponent />
-  </div>
-</template>
+<template>
+  <div>
+    <NuxtWelcome />
+    <div>
+      Test-pack layer for <a href="https://nuxt.com/">Nuxt</a> applications
+    </div>
+    <NuxtSpecTestComponent id="test" text="Test Component" />
+    <NuxtSpecApiTestComponent />
+  </div>
+</template>

package/app/components/NuxtSpecApiTestComponent.vue

@@ -1,24 +1,24 @@
-<template>
-  <div>
-    <h2>API Test</h2>
-    <button id="api-fetch" @click="fetchData">
-      Fetch Data
-    </button>
-    <div id="api-result">
-      {{ data }}
-    </div>
-  </div>
-</template>
-
-<script setup lang="ts">
-const data = ref('')
-const fetchData = async () => {
-  try {
-    data.value = await $fetch('https://jsonplaceholder.typicode.com/posts/1')
-    console.debug('Fetched data:', data.value)
-  } catch (error) {
-    data.value = 'Error fetching data'
-    console.error('API fetch error:', error)
-  }
-}
-</script>
+<template>
+  <div>
+    <h2>API Test</h2>
+    <button id="api-fetch" @click="fetchData">
+      Fetch Data
+    </button>
+    <div id="api-result">
+      {{ data }}
+    </div>
+  </div>
+</template>
+
+<script setup lang="ts">
+const data = ref('')
+const fetchData = async () => {
+  try {
+    data.value = await $fetch('https://jsonplaceholder.typicode.com/posts/1')
+    console.debug('Fetched data:', data.value)
+  } catch (error) {
+    data.value = 'Error fetching data'
+    console.error('API fetch error:', error)
+  }
+}
+</script>

package/app/components/NuxtSpecTestComponent.vue

@@ -1,9 +1,9 @@
-<template>
-  <div data-testid="test-component" style="margin: 1rem 0; padding: 0.5rem; border: 1px solid black;">
-    {{ text }}
-  </div>
-</template>
-
-<script setup lang="ts">
-defineProps({ text: { type: String, default: 'nuxt-spec' } })
-</script>
+<template>
+  <div data-testid="test-component" style="margin: 1rem 0; padding: 0.5rem; border: 1px solid black;">
+    {{ text }}
+  </div>
+</template>
+
+<script setup lang="ts">
+defineProps({ text: { type: String, default: 'nuxt-spec' } })
+</script>

package/app/components/index.d.ts

@@ -1,7 +1,7 @@
-// type hint for tsconfig.nuxt-spec.json
-declare module '*.vue' {
-  import type { DefineComponent } from 'vue'
-
-  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>
-  export default component
-}
+// type hint for tsconfig.nuxt-spec.json
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue'
+
+  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>
+  export default component
+}

package/app/components/index.ts

@@ -1,2 +1,2 @@
-export { default as NuxtSpecTestComponent } from './NuxtSpecTestComponent.vue'
-export { default as NuxtSpecApiTestComponent } from './NuxtSpecApiTestComponent.vue'
+export { default as NuxtSpecTestComponent } from './NuxtSpecTestComponent.vue'
+export { default as NuxtSpecApiTestComponent } from './NuxtSpecApiTestComponent.vue'

package/app/utils/vitest-utils.ts

@@ -1,5 +1,5 @@
-// Element.checkVisibility() is not available in Vitest
-global.Element.prototype.checkVisibility = function () {
-  // in tests we always just assume the element is visible
-  return true
-}
+// Element.checkVisibility() is not available in Vitest
+global.Element.prototype.checkVisibility = function () {
+  // in tests we always just assume the element is visible
+  return true
+}

package/bin/_internal/prepublish-check.js

@@ -1,16 +1,16 @@
-#!/usr/bin/env node
-
-import { createInterface } from 'node:readline'
-
-const rl = createInterface({ input: process.stdin, output: process.stdout })
-
-rl.question('Are you sure the current solution was properly tested and verified? (y/n) ', (answer) => {
-  rl.close()
-  if (answer.trim().toLowerCase().startsWith('y')) {
-    console.log('Proceeding with publish...')
-    process.exit(0)
-  } else {
-    console.error('Publish aborted. Please run the tests and try again.')
-    process.exit(1)
-  }
-})
+#!/usr/bin/env node
+
+import { createInterface } from 'node:readline'
+
+const rl = createInterface({ input: process.stdin, output: process.stdout })
+
+rl.question('Are you sure the current solution was properly tested and verified? (y/n) ', (answer) => {
+  rl.close()
+  if (answer.trim().toLowerCase().startsWith('y')) {
+    console.log('Proceeding with publish...')
+    process.exit(0)
+  } else {
+    console.error('Publish aborted. Please run the tests and try again.')
+    process.exit(1)
+  }
+})

package/bin/cli.js

@@ -1,44 +1,44 @@
-#!/usr/bin/env node
-
-import { getCmd, resolvePackageManager } from './helpers/commands.js'
-
-/**
- * CLI tool to scaffold necessary adjustments in project folder.
- *
- * Allows `setup` or `update` to be passed as parameter.
- *
- * Second (optional) parameter might be a boolean to indicate auto mode
- * (no prompts, force = true) or manual mode (with prompts, force = false).
- *
- * Third (optional) parameter allows explicitly passing the package manager
- * (`npm`, `pnpm`, `yarn`, `bun` or `deno`), bypassing auto-detection.
- */
-
-// get parameters passed by user
-const args = process.argv.slice(2);
-
-// execute actions based on first param
-// additional params might be passed into the called functions
-(async () => {
-  let status = 0
-  try {
-    const packageManager = resolvePackageManager(args[2])
-    // CLI args are always strings, so 'false' must be parsed explicitly rather than treated as truthy
-    const autoRun = args[1] === 'true'
-    switch (args[0]) {
-      case 'setup':
-        await (await import('./setup.js')).specSetup(autoRun, packageManager)
-        break
-      case 'update':
-        await (await import('./update.js')).specUpdate(autoRun, packageManager)
-        break
-      default:
-        console.log(`Usage: \`${getCmd(packageManager)} setup [true|false] [npm|pnpm|yarn|bun|deno]\` or \`${getCmd(packageManager)} update [true|false] [npm|pnpm|yarn|bun|deno]\``)
-        status = 1
-    }
-  } catch (error) {
-    console.error('nuxt-spec CLI failed:', error.message)
-    status = 1
-  }
-  process.exit(status)
-})()
+#!/usr/bin/env node
+
+import { getCmd, resolvePackageManager } from './helpers/commands.js'
+
+/**
+ * CLI tool to scaffold necessary adjustments in project folder.
+ *
+ * Allows `setup` or `update` to be passed as parameter.
+ *
+ * Second (optional) parameter might be a boolean to indicate auto mode
+ * (no prompts, force = true) or manual mode (with prompts, force = false).
+ *
+ * Third (optional) parameter allows explicitly passing the package manager
+ * (`npm`, `pnpm`, `yarn`, `bun` or `deno`), bypassing auto-detection.
+ */
+
+// get parameters passed by user
+const args = process.argv.slice(2);
+
+// execute actions based on first param
+// additional params might be passed into the called functions
+(async () => {
+  let status = 0
+  try {
+    const packageManager = resolvePackageManager(args[2])
+    // CLI args are always strings, so 'false' must be parsed explicitly rather than treated as truthy
+    const autoRun = args[1] === 'true'
+    switch (args[0]) {
+      case 'setup':
+        await (await import('./setup.js')).specSetup(autoRun, packageManager)
+        break
+      case 'update':
+        await (await import('./update.js')).specUpdate(autoRun, packageManager)
+        break
+      default:
+        console.log(`[Nuxt Spec] Usage: \`${getCmd(packageManager)} setup [true|false] [npm|pnpm|yarn|bun|deno]\` or \`${getCmd(packageManager)} update [true|false] [npm|pnpm|yarn|bun|deno]\``)
+        status = 1
+    }
+  } catch (error) {
+    console.error('[Nuxt Spec] CLI failed:', error.message)
+    status = 1
+  }
+  process.exit(status)
+})()

package/bin/helpers/commands.js

@@ -1,82 +1,82 @@
-import { getPackageManager } from 'elrh-cosca'
-
-export const SUPPORTED_PACKAGE_MANAGERS = ['npm', 'pnpm', 'yarn', 'bun', 'deno']
-
-// get the package manager name for usage in commands
-// explicit override takes precedence over auto-detection
-export function resolvePackageManager(override) {
-  if (override) {
-    if (!SUPPORTED_PACKAGE_MANAGERS.includes(override)) {
-      throw new Error(`Unsupported package manager '${override}'. Use one of: ${SUPPORTED_PACKAGE_MANAGERS.join(', ')}`)
-    }
-    return override
-  }
-  return getPackageManager()
-}
-
-// use nuxt-spec CLI tool
-export function getCmd(packageManager) {
-  const command = 'nuxt-spec'
-  switch (packageManager) {
-    case 'pnpm':
-      return `pnpx ${command}`
-    case 'yarn':
-      return `yarn dlx ${command}`
-    case 'bun':
-      return `bunx ${command}`
-    case 'deno':
-      return `deno run -A npm:${command}`
-    default:
-      return `npx ${command}`
-  }
-}
-
-// update nuxt-spec
-export function getUpdateCmd(packageManager, target) {
-  switch (packageManager) {
-    case 'pnpm':
-      return `pnpm update ${target}`
-    case 'yarn':
-      return `yarn up ${target}`
-    case 'bun':
-      return `bun update ${target}`
-    case 'deno':
-      return `deno add npm:${target}`
-    default:
-      return `npm install ${target}`
-  }
-}
-
-// generate Nuxt types and auto-imports
-export function getPrepareCmd(packageManager) {
-  const command = 'nuxt prepare'
-  switch (packageManager) {
-    case 'pnpm':
-      return `pnpm exec ${command}`
-    case 'yarn':
-      return `yarn ${command}`
-    case 'bun':
-      return `bunx ${command}`
-    case 'deno':
-      return `deno run -A npm:${command}`
-    default:
-      return `npx ${command}`
-  }
-}
-
-// install/update playwright
-export function getPlaywrightInstallCmd(packageManager) {
-  const command = 'playwright install'
-  switch (packageManager) {
-    case 'pnpm':
-      return `pnpm exec ${command}`
-    case 'yarn':
-      return `yarn ${command}`
-    case 'bun':
-      return `bunx ${command}`
-    case 'deno':
-      return `deno run -A npm:${command}`
-    default:
-      return `npx ${command}`
-  }
-}
+import { getPackageManager } from 'elrh-cosca'
+
+export const SUPPORTED_PACKAGE_MANAGERS = ['npm', 'pnpm', 'yarn', 'bun', 'deno']
+
+// get the package manager name for usage in commands
+// explicit override takes precedence over auto-detection
+export function resolvePackageManager(override) {
+  if (override) {
+    if (!SUPPORTED_PACKAGE_MANAGERS.includes(override)) {
+      throw new Error(`Unsupported package manager '${override}'. Use one of: ${SUPPORTED_PACKAGE_MANAGERS.join(', ')}`)
+    }
+    return override
+  }
+  return getPackageManager()
+}
+
+// use nuxt-spec CLI tool
+export function getCmd(packageManager) {
+  const command = 'nuxt-spec'
+  switch (packageManager) {
+    case 'pnpm':
+      return `pnpx ${command}`
+    case 'yarn':
+      return `yarn dlx ${command}`
+    case 'bun':
+      return `bunx ${command}`
+    case 'deno':
+      return `deno run -A npm:${command}`
+    default:
+      return `npx ${command}`
+  }
+}
+
+// update nuxt-spec
+export function getUpdateCmd(packageManager, target) {
+  switch (packageManager) {
+    case 'pnpm':
+      return `pnpm update ${target}`
+    case 'yarn':
+      return `yarn up ${target}`
+    case 'bun':
+      return `bun update ${target}`
+    case 'deno':
+      return `deno add npm:${target}`
+    default:
+      return `npm install ${target}`
+  }
+}
+
+// generate Nuxt types and auto-imports
+export function getPrepareCmd(packageManager) {
+  const command = 'nuxt prepare'
+  switch (packageManager) {
+    case 'pnpm':
+      return `pnpm exec ${command}`
+    case 'yarn':
+      return `yarn ${command}`
+    case 'bun':
+      return `bunx ${command}`
+    case 'deno':
+      return `deno run -A npm:${command}`
+    default:
+      return `npx ${command}`
+  }
+}
+
+// install/update playwright
+export function getPlaywrightInstallCmd(packageManager) {
+  const command = 'playwright install'
+  switch (packageManager) {
+    case 'pnpm':
+      return `pnpm exec ${command}`
+    case 'yarn':
+      return `yarn ${command}`
+    case 'bun':
+      return `bunx ${command}`
+    case 'deno':
+      return `deno run -A npm:${command}`
+    default:
+      return `npx ${command}`
+  }
+}