Make Vitest inclusion optional

Author: skirtles-code

packages/create-vue-lib/src/index.ts

@@ -79,6 +79,7 @@ type Config = {
   includeExamples: boolean
   includeEsLint: boolean
   includeEsLintStylistic: boolean
+  includeVitest: boolean
   includeAtAliases: boolean
   includeTestVariable: boolean
 }
@@ -252,6 +253,7 @@ async function init() {
 
   const includeEsLint = await togglePrompt('Include ESLint?', true)
   const includeEsLintStylistic = await togglePromptIf(includeEsLint, 'Include ESLint Stylistic for formatting?', includeEsLint)
+  const includeVitest = await togglePromptIf(extended, 'Include Vitest for testing?', true)
   const includeDocs = await togglePrompt('Include VitePress for documentation?', true)
   const includeGithubPages = includeDocs && await togglePrompt('Include GitHub Pages config for documentation?')
   const includePlayground = await togglePrompt('Include playground application for development?', true)
@@ -309,6 +311,7 @@ async function init() {
     includeExamples,
     includeEsLint,
     includeEsLintStylistic,
+    includeVitest,
     includeAtAliases,
     includeTestVariable
   }
@@ -331,6 +334,10 @@ async function init() {
     copyTemplate('eslint', config)
   }
 
+  if (config.includeVitest) {
+    copyTemplate('vitest', config)
+  }
+
   console.log()
   console.log('Project created')
   console.log()
@@ -399,9 +406,15 @@ function copyFiles(templateFile: string, config: Config) {
     const target = targetPath.replace(/\.ejs$/, '')
     let content = ejs.render(template, { config })
 
-    if (target.endsWith('.json')) {
-      // Remove trailing commas
-      content = content.replace(/,(\s*)([}\]])/g, '$1$2')
+    if (/\.(json|m?[jt]s)$/.test(target)) {
+      // Trim spaces from the ends of lines
+      content = content.replace(/ +\n/g, '\n')
+
+      // Remove consecutive blank lines
+      content = content.replace(/\n\n+/g, '\n\n')
+
+      // Remove trailing commas and any blank newlines that follow them
+      content = content.replace(/, *(?:\n+(\n\s*)|(\s*))([}\])])/g, '$1$2$3')
     }
 
     fs.writeFileSync(target, content)

packages/create-vue-lib/src/template/base/config/.vscode/extensions.json.ejs

@@ -1,7 +1,9 @@
 {
   "recommendations": [
     "Vue.volar",
+    <%_ if (config.includeVitest) { _%>
     "vitest.explorer",
+    <%_ } _%>
     <%_ if (config.includeEsLint) { _%>
     "dbaeumer.vscode-eslint",
     <%_ } _%>

packages/create-vue-lib/src/template/base/config/package.json.ejs

@@ -14,8 +14,10 @@
     "docs:dev": "pnpm run --filter ./packages/docs -r dev",
     "docs:build": "pnpm run --filter ./packages/docs -r build",
     <%_ } _%>
+    <%_ if (config.includeVitest) { _%>
     "test:unit": "pnpm run --filter ./packages/<%- config.mainPackageDirName %> -r test:unit",
     "coverage": "pnpm run --filter ./packages/<%- config.mainPackageDirName %> -r coverage",
+    <%_ } _%>
     <%_ if (config.includeEsLint) { _%>
     "type-check": "run-p type-check:*",
     "type-check:packages": "pnpm run -r type-check",
@@ -51,7 +53,9 @@
     "@tsconfig/node22": "^22.0.0",
     "@types/node": "^22.13.4",
     "@typescript-eslint/parser": "^8.23.0",
+    <%_ if (config.includeVitest) { _%>
     "@vitest/eslint-plugin": "1.1.31",
+    <%_ } _%>
     "@vue/eslint-config-typescript": "^14.4.0",
     "eslint": "^9.20.1",
     "eslint-plugin-vue": "^9.32.0",

packages/create-vue-lib/src/template/base/config/packages/@projectName@/package.json renamed to packages/create-vue-lib/src/template/base/config/packages/@projectName@/package.json.ejs

@@ -1,31 +1,31 @@
 {
   "private": true,
-  "name": "@scopedPackageName@",
+  "name": "<%- config.scopedPackageName %>",
   "version": "0.0.0",
   "author": "",
   "license": "",
   "description": "",
   "keywords": [],
-  "homepage": "@homepageUrl@",
-  "bugs": "@githubIssues@",
+  "homepage": "<%- config.homepageUrl %>",
+  "bugs": "<%- config.githubIssues %>",
   "repository": {
     "type": "git",
-    "url": "@githubRepository@"
+    "url": "<%- config.githubRepository %>"
   },
   "sideEffects": false,
-  "main": "dist/@unscopedPackageName@.cjs",
-  "module": "dist/@unscopedPackageName@.esm-bundler.prod.mjs",
-  "unpkg": "dist/@unscopedPackageName@.global.dev.js",
-  "jsdelivr": "dist/@unscopedPackageName@.global.dev.js",
-  "types": "dist/@unscopedPackageName@.d.ts",
+  "main": "dist/<%- config.unscopedPackageName %>.cjs",
+  "module": "dist/<%- config.unscopedPackageName %>.esm-bundler.prod.mjs",
+  "unpkg": "dist/<%- config.unscopedPackageName %>.global.dev.js",
+  "jsdelivr": "dist/<%- config.unscopedPackageName %>.global.dev.js",
+  "types": "dist/<%- config.unscopedPackageName %>.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/@unscopedPackageName@.d.ts",
+      "types": "./dist/<%- config.unscopedPackageName %>.d.ts",
       "import": {
-        "development": "./dist/@unscopedPackageName@.esm.dev.js",
-        "default": "./dist/@unscopedPackageName@.esm-bundler.prod.mjs"
+        "development": "./dist/<%- config.unscopedPackageName %>.esm.dev.js",
+        "default": "./dist/<%- config.unscopedPackageName %>.esm-bundler.prod.mjs"
       },
-      "require": "./dist/@unscopedPackageName@.cjs"
+      "require": "./dist/<%- config.unscopedPackageName %>.cjs"
     },
     "./dist/*": "./dist/*",
     "./package.json": "./package.json"
@@ -42,8 +42,10 @@
     "@types/jsdom": "^21.1.7",
     "@types/node": "^22.13.4",
     "@vitejs/plugin-vue": "^5.2.1",
+    <%_ if (config.includeVitest) { _%>
     "@vitest/coverage-v8": "^3.0.5",
     "@vue/test-utils": "^2.4.6",
+    <%_ } _%>
     "@vue/tsconfig": "^0.7.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -53,15 +55,19 @@
     "typescript": "~5.7.3",
     "vite": "^6.1.0",
     "vite-plugin-dts": "^4.5.3",
+    <%_ if (config.includeVitest) { _%>
     "vitest": "^3.0.5",
+    <%_ } _%>
     "vue": "^3.5.13",
     "vue-tsc": "^2.2.2"
   },
   "scripts": {
     "clean:dist": "rimraf dist",
     "clean": "rimraf dist coverage LICENSE README.md",
+    <%_ if (config.includeVitest) { _%>
     "test:unit": "vitest --environment jsdom",
     "coverage": "vitest run --coverage --environment jsdom",
+    <%_ } _%>
     "type-check": "vue-tsc --build",
     "build:copy": "copyfiles -f ../../LICENSE ../../README.md .",
     "build:dev": "cross-env NODE_ENV=development vite build --mode development",

packages/create-vue-lib/src/template/base/config/packages/@projectName@/tsconfig.json renamed to packages/create-vue-lib/src/template/base/config/packages/@projectName@/tsconfig.json.ejs

@@ -7,8 +7,10 @@
     {
       "path": "./tsconfig.app.json"
     },
+    <%_ if (config.includeVitest) { _%>
     {
       "path": "./tsconfig.vitest.json"
     }
+    <%_ } _%>
   ]
 }

packages/create-vue-lib/src/template/eslint/config/eslint.config.mts.ejs

@@ -7,7 +7,9 @@ import pluginVue from 'eslint-plugin-vue'
 import stylistic from '@stylistic/eslint-plugin'
 <%_ } _%>
 import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+<%_ if (config.includeVitest) { _%>
 import pluginVitest from '@vitest/eslint-plugin'
+<%_ } _%>
 
 export default defineConfigWithVueTs(
   {
@@ -26,8 +28,10 @@ export default defineConfigWithVueTs(
   }),
   <%_ } _%>
 
+  <%_ if (config.includeVitest) { _%>
   {
     ...pluginVitest.configs.recommended,
     files: ['src/**/__tests__/*']
   }
+  <%_ } _%>
 )

packages/create-vue-lib/src/template/base/config/packages/@projectName@/tsconfig.vitest.json renamed to packages/create-vue-lib/src/template/vitest/config/packages/@projectName@/tsconfig.vitest.json

@@ -45,6 +45,7 @@
 <span class="check">✔</span> <a href="#github-path">GitHub path (optional) … skirtles-code/test-project</a>
 <span class="check">✔</span> <a href="#include-eslint">Include ESLint? … No / Yes</a>
 <span class="check">✔</span> <a href="#include-eslint-stylistic">Include ESLint Stylistic for formatting? … No / Yes</a>
+<span class="check">✔</span> <a href="#include-vitest">Include Vitest for testing? … No / Yes</a>
 <span class="check">✔</span> <a href="#include-vitepress">Include VitePress for documentation? … No / Yes</a>
 <span class="check">✔</span> <a href="#include-github-pages">Include GitHub Pages config for documentation? … No / Yes</a>
 <span class="check">✔</span> <a href="#include-playground">Include playground application for development? … No / Yes</a>
@@ -132,6 +133,16 @@ Include configuration for ESLint. This will be very similar to the default confi
 
 Currently, this is the only formatter that is supported by this CLI tool, but you can configure others yourself after the project is created.
 
+## Include Vitest for testing?{#include-vitest}
+
+:::info NOTE
+This question is only asked when using the `--extended` flag.
+:::
+
+[Vitest](https://vitest.dev/) is a testing framework for Vite.
+
+Testing is particularly important for libraries, so Vitest is included by default, but you can opt out if you want to implement an alternative testing strategy.
+
 ## Include VitePress for documentation?{#include-vitepress}
 
 [VitePress](https://vitepress.dev/) has become the standard tool for library documentation in the Vue community. If you intend to publish your package publicly then you probably want to use VitePress for your documentation.