@skirtle/create-vue-lib 0.0.1 → 0.0.2

package/dist/template/base/config/{.editorconfig → .editorconfig.ejs}

@@ -1,3 +1,5 @@
+root = true
+
 [*]
 charset = utf-8
 indent_style = space
@@ -5,3 +7,7 @@ indent_size = 2
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

package/dist/template/base/config/.gitignore.ejs

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+packages/docs/.vitepress/cache
+packages/<%- config.mainPackageDirName %>/LICENSE
+packages/<%- config.mainPackageDirName %>/README.md
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo

package/dist/template/base/config/.vscode/extensions.json.ejs

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

package/dist/template/base/config/.vscode/settings.json.ejs

@@ -0,0 +1,13 @@
+{
+  "explorer.fileNesting.enabled": true,
+  "explorer.fileNesting.patterns": {
+    "tsconfig.json": "tsconfig.*.json, env.d.ts",
+    "vite.config.*": "jsconfig*, vitest.config.*, cypress.config.*, playwright.config.*",
+    "package.json": "package-lock.json, pnpm*, .yarnrc*, yarn*, .eslint*, eslint*, .prettier*, prettier*, .editorconfig"
+  },
+  <%_ if (config.includeEsLint) { _%>
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  }
+  <%_ } _%>
+}

package/dist/template/base/config/package.json.ejs

@@ -7,12 +7,6 @@
   },
   "scripts": {
     "clean": "pnpm run -r clean",
-    "build": "pnpm run -r build",
-    "type-check": "pnpm run -r type-check",
-    <%_ if (config.includeEsLint) { _%>
-    "lint": "eslint",
-    "lint:fix": "eslint --fix",
-    <%_ } _%>
     <%_ if (config.includePlayground) { _%>
     "dev": "pnpm run --filter ./packages/playground -r dev",
     <%_ } _%>
@@ -22,12 +16,23 @@
     <%_ } _%>
     "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",
+    "type-check:self": "tsc",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "lint:staged": "lint-staged",
+    <%_ } else { _%>
+    "type-check": "pnpm run -r type-check",
+    <%_ } _%>
+    "build": "pnpm run -r build",
     "preinstall": "node scripts/preinstall.js",
     "postinstall": "simple-git-hooks"
   },
   <%_ if (config.includeEsLint) { _%>
   "simple-git-hooks": {
-    "pre-commit": "pnpm run type-check && pnpm exec lint-staged"
+    "pre-commit": "pnpm exec run-s type-check lint:staged"
   },
   "lint-staged": {
     "*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}": "eslint --fix"
@@ -43,6 +48,8 @@
     <%_ if (config.includeEsLintStylistic) { _%>
     "@stylistic/eslint-plugin": "^4.0.0",
     <%_ } _%>
+    "@tsconfig/node22": "^22.0.0",
+    "@types/node": "^22.13.0",
     "@typescript-eslint/parser": "^8.23.0",
     "@vitest/eslint-plugin": "1.1.25",
     "@vue/eslint-config-typescript": "^14.3.0",
@@ -50,7 +57,11 @@
     "eslint-plugin-vue": "^9.32.0",
     "jiti": "^2.4.2",
     "lint-staged": "^15.4.3",
+    "npm-run-all2": "^7.0.2",
+    <%_ } _%>
+    "simple-git-hooks": "^2.11.1",
+    <%_ if (config.includeEsLint) { _%>
+    "typescript": "^5.7.3"
     <%_ } _%>
-    "simple-git-hooks": "^2.11.1"
   }
 }

package/dist/template/base/config/packages/@projectName@/package.json

@@ -42,27 +42,29 @@
     "@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",
     "jsdom": "^26.0.0",
     "npm-run-all2": "^7.0.2",
     "rimraf": "^5.0.1",
     "typescript": "~5.7.3",
     "vite": "^6.0.11",
-    "vite-plugin-dts": "^4.5.0",
+    "vite-plugin-dts": "4.5.0",
     "vitest": "^3.0.2",
     "vue": "^3.5.13",
     "vue-tsc": "^2.2.0"
   },
   "scripts": {
-    "clean": "rimraf dist coverage",
     "clean:dist": "rimraf dist",
+    "clean": "rimraf dist coverage LICENSE README.md",
     "test:unit": "vitest --environment jsdom",
     "coverage": "vitest run --coverage --environment jsdom",
-    "build": "run-s clean:dist build-only type-check",
-    "build-only": "run-s build-dev build-neutral build-prod",
-    "build-dev": "vite build --mode development",
-    "build-neutral": "vite build --mode neutral",
-    "build-prod": "vite build --mode production",
     "type-check": "vue-tsc --build",
+    "build:copy": "copyfiles -f ../../LICENSE ../../README.md .",
+    "build:dev": "cross-env NODE_ENV=development vite build --mode development",
+    "build:neutral": "vite build --mode neutral",
+    "build:prod": "vite build --mode production",
+    "build": "run-s clean:dist build:* type-check",
     "preinstall": "node ../../scripts/preinstall.js"
   }
 }

package/dist/template/base/config/packages/@projectName@/src/global.d.ts.ejs

@@ -0,0 +1,4 @@
+declare const __DEV__: boolean
+<%_ if (config.includeTestVariable) { _%>
+declare const __TEST__: boolean
+<%_ } _%>

package/dist/template/base/config/packages/@projectName@/{tsconfig.app.json → tsconfig.app.json.ejs}

@@ -3,9 +3,11 @@
   "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
   "exclude": ["src/**/__tests__/*"],
   "compilerOptions": {
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    <%_ if (config.includeAtAliases) { _%>
     "paths": {
       "@/*": ["./src/*"]
     }
+    <%_ } _%>
   }
 }

package/dist/template/base/config/packages/@projectName@/tsconfig.node.json

@@ -10,7 +10,7 @@
   ],
   "compilerOptions": {
     "noEmit": true,
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
     "module": "ESNext",
     "moduleResolution": "Bundler",
     "types": ["node"]

package/dist/template/base/config/packages/@projectName@/tsconfig.vitest.json

@@ -3,7 +3,7 @@
   "include": ["src/**/__tests__/*", "env.d.ts"],
   "exclude": [],
   "compilerOptions": {
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.vitest.tsbuildinfo",
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.vitest.tsbuildinfo",
     "lib": [],
     "types": ["node", "jsdom"]
   }

package/dist/template/base/config/packages/@projectName@/{vite.config.mts → vite.config.mts.ejs}

@@ -1,12 +1,14 @@
 import { resolve } from 'node:path'
+<%_ if (config.includeAtAliases) { _%>
 import { fileURLToPath, URL } from 'node:url'
+<%_ } _%>
 
-import { defineConfig } from 'vite'
+import { defineConfig, type UserConfig } from 'vite'
 import replace from '@rollup/plugin-replace'
 import vue from '@vitejs/plugin-vue'
 import dts from 'vite-plugin-dts'
 
-export default defineConfig(({ mode }) => {
+export default defineConfig(({ mode }): UserConfig => {
   if (mode !== 'production' && mode !== 'development' && mode !== 'neutral' && mode !== 'test') {
     throw new Error(`Unknown mode: ${mode}`)
   }
@@ -29,22 +31,30 @@ export default defineConfig(({ mode }) => {
       vue(),
       dtsPlugin
     ],
+    <%_ if (config.includeAtAliases) { _%>
     resolve: {
       alias: {
         '@': fileURLToPath(new URL('./src', import.meta.url))
       }
     },
+    <%_ } _%>
+    <%_ if (config.includeTestVariable) { _%>
+    define: {
+      __TEST__: mode === 'test'
+    },
+    <%_ } _%>
     build: {
       target: 'es2019',
       emptyOutDir: false,
       minify: mode === 'production',
       lib: {
         entry: resolve(__dirname, 'src/index.ts'),
-        name: '@globalVariableName@',
+        name: '<%- config.globalVariableName %>',
         formats: mode === 'neutral' ? ['cjs', 'es'] : ['es', 'iife'],
+        cssFileName: mode === 'production' ? '<%- config.unscopedPackageName %>.prod' : '<%- config.unscopedPackageName %>',
 
         fileName(format) {
-          let name = '@unscopedPackageName@'
+          let name = '<%- config.unscopedPackageName %>'
           let extension = 'js'
 
           if (format === 'iife') {

package/dist/template/base/examples/packages/@projectName@/src/components/{ExampleComponent.vue → ExampleComponent.vue.ejs}

@@ -3,6 +3,9 @@ import { ref } from 'vue'
 
 if (__DEV__) {
   console.log('dev: creating ExampleComponent')
+  <%_ if (config.includeTestVariable) { _%>
+  console.log(`__TEST__: ${__TEST__}`)
+  <%_ } _%>
 }
 
 const msg = ref('Hello world!')

package/dist/template/eslint/config/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "include": ["eslint.config.*"],
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["node"]
+  }
+}

package/dist/template/playground/config/packages/playground/package.json

@@ -1,12 +1,13 @@
 {
   "private": true,
   "scripts": {
+    "clean": "rimraf dist",
     "dev": "vite --port 5051",
     "type-check": "vue-tsc --build",
-    "build-only": "vite build",
-    "build": "run-p -c type-check \"build-only {@}\" --",
+    "build:only": "vite build",
+    "build": "run-p -c type-check \"build:only {@}\" --",
     "preview": "vite preview --port 4051",
-    "clean": "rimraf dist"
+    "preinstall": "node ../../scripts/preinstall.js"
   },
   "dependencies": {
     "vue": "^3.5.13"

package/dist/template/playground/config/packages/playground/tsconfig.app.json.ejs

@@ -0,0 +1,13 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "paths": {
+      <%_ if (config.includeAtAliases) { _%>
+      "@/*": ["./src/*"],
+      <%_ } _%>
+      "<%- config.scopedPackageName %>": ["../<%- config.mainPackageDirName %>/src/index.ts"]
+    }
+  }
+}

package/dist/template/playground/config/packages/playground/tsconfig.node.json

@@ -10,7 +10,7 @@
   ],
   "compilerOptions": {
     "noEmit": true,
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.playground.node.tsbuildinfo",
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
     "module": "ESNext",
     "moduleResolution": "Bundler",
     "types": ["node"]

package/dist/template/playground/config/packages/playground/vite.config.mts.ejs

@@ -0,0 +1,45 @@
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig, type UserConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import vueDevTools from 'vite-plugin-vue-devtools'
+
+<%_ if (config.includeAtAliases) { _%>
+const librarySrc = fileURLToPath(new URL('../<%- config.mainPackageDirName %>/src/', import.meta.url))
+const playgroundSrc = fileURLToPath(new URL('./src/', import.meta.url))
+
+<%_ } _%>
+export default defineConfig(({ mode }): UserConfig => ({
+  plugins: [
+    vue(),
+    vueDevTools()
+  ],
+  resolve: {
+    <%_ if (config.includeAtAliases) { _%>
+    alias: [
+      {
+        find: '@',
+        replacement: '@',
+        customResolver(source, importer) {
+          return source.replace(
+            /^@\//,
+            importer?.startsWith(librarySrc) ? librarySrc : playgroundSrc
+          )
+        }
+      }, {
+        find: '<%- config.scopedPackageName %>',
+        replacement: librarySrc
+      }
+    ]
+    <%_ } else { _%>
+    alias: {
+      '<%- config.scopedPackageName %>': fileURLToPath(new URL('../<%- config.mainPackageDirName %>/src/', import.meta.url))
+    }
+    <%_ } _%>
+  },
+  define: {
+    __DEV__: mode !== 'production'<%_ if (config.includeTestVariable) { _%>,
+    __TEST__: false
+    <%_ } %>
+  }
+}))

package/dist/template/vitepress/config/packages/docs/.vitepress/config.mts.ejs

@@ -1,7 +1,12 @@
-import { resolve } from 'node:path'
+import { fileURLToPath, URL } from 'node:url'
 
 import { defineConfigWithTheme } from 'vitepress'
 
+<%_ if (config.includeAtAliases) { _%>
+const librarySrc = fileURLToPath(new URL('../../<%- config.mainPackageDirName %>/src/', import.meta.url))
+const playgroundSrc = fileURLToPath(new URL('../src/', import.meta.url))
+
+<%_ } _%>
 export default ({ mode }: { mode: string }) => defineConfigWithTheme({
   srcDir: './src',
   outDir: './dist',
@@ -30,13 +35,33 @@ export default ({ mode }: { mode: string }) => defineConfigWithTheme({
   <%_ } _%>
   vite: {
     resolve: {
+      <%_ if (config.includeAtAliases) { _%>
+      alias: [
+        {
+          find: '@',
+          replacement: '@',
+          customResolver(source, importer) {
+            return source.replace(
+              /^@\//,
+              importer?.startsWith(librarySrc) ? librarySrc : playgroundSrc
+            )
+          }
+        }, {
+          find: '<%- config.scopedPackageName %>',
+          replacement: librarySrc
+        }
+      ]
+      <%_ } else { _%>
       alias: {
-        '<%- config.scopedPackageName %>': resolve(__dirname, '../../<%- config.mainPackageDirName %>/src/index.ts')
+        '<%- config.scopedPackageName %>': fileURLToPath(new URL('../../<%- config.mainPackageDirName %>/src/', import.meta.url))
       }
+      <%_ } _%>
     },
 
     define: {
-      __DEV__: JSON.stringify(mode !== 'production')
+      __DEV__: mode !== 'production'<%_ if (config.includeTestVariable) { _%>,
+      __TEST__: false
+      <%_ } %>
     }
   },
 

package/dist/template/vitepress/config/packages/docs/package.json

@@ -3,11 +3,11 @@
   "scripts": {
     "clean": "rimraf dist .vitepress/cache",
     "dev": "vitepress dev .",
-    "type-check": "run-p -c type-check:*",
     "type-check:code": "vue-tsc --noEmit -p tsconfig.app.json --composite false",
     "type-check:config": "vue-tsc --noEmit -p tsconfig.node.json --composite false",
-    "build-only": "vitepress build .",
-    "build": "run-p -c type-check \"build-only {@}\" --",
+    "type-check": "run-p -c type-check:*",
+    "build:only": "vitepress build .",
+    "build": "run-p -c type-check \"build:only {@}\" --",
     "preview": "vitepress preview .",
     "preinstall": "node ../../scripts/preinstall.js"
   },

package/dist/template/vitepress/config/packages/docs/{tsconfig.app.json → tsconfig.app.json.ejs}

@@ -9,9 +9,11 @@
     "src/**/*.md"
   ],
   "compilerOptions": {
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.docs.app.tsbuildinfo",
     "paths": {
-      "@scopedPackageName@": ["../@projectName@/src/index.ts"]
+      <%_ if (config.includeAtAliases) { _%>
+      "@/*": ["./src/*"],
+      <%_ } _%>
+      "<%- config.scopedPackageName %>": ["../<%- config.mainPackageDirName %>/src/index.ts"]
     }
   },
   "vueCompilerOptions": {

package/dist/template/vitepress/config/packages/docs/tsconfig.node.json

@@ -3,7 +3,6 @@
   "include": [".vitepress/config.*"],
   "compilerOptions": {
     "noEmit": true,
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.docs.node.tsbuildinfo",
     "module": "ESNext",
     "moduleResolution": "Bundler",
     "types": ["node"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skirtle/create-vue-lib",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "skirtle",
   "license": "MIT",
   "description": "Create a library using Vue and Vite",
@@ -35,23 +35,20 @@
     "@types/prompts": "^2.4.9",
     "copyfiles": "^2.4.1",
     "ejs": "^3.1.10",
-    "lint-staged": "^15.4.3",
     "npm-run-all2": "^7.0.2",
     "prompts": "^2.4.2",
     "rimraf": "^6.0.1",
-    "simple-git-hooks": "^2.11.1",
     "tsup": "^8.3.6",
     "typescript": "^5.7.3"
   },
   "scripts": {
-    "clean": "rimraf dist",
-    "build": "run-s clean build:copy build:ts",
-    "build:copy": "copyfiles -u 1 -a \"src/template/**\" dist",
+    "clean": "rimraf dist LICENSE README.md",
+    "type-check": "tsc",
+    "build:copy": "copyfiles -f ../../LICENSE ../../README.md .",
+    "build:templates": "copyfiles -u 1 -a \"src/template/**\" dist",
     "build:ts": "tsup src/index.ts --format cjs --target node18",
-    "build:dts": "tsup src/index.ts --dts --format cjs --target node18",
+    "build": "run-s clean build:copy build:templates build:ts",
     "start": "node ./dist/index.cjs",
-    "docs:dev": "pnpm run --filter ./docs -r dev",
-    "docs:build": "pnpm run --filter ./docs -r build",
     "preinstall": "npx only-allow pnpm"
   }
 }

package/dist/template/base/config/packages/@projectName@/README.md.ejs

@@ -1,5 +0,0 @@
-# <%- config.scopedPackageName %>
-
-Project description
-
-## License

package/dist/template/base/config/packages/@projectName@/src/global.d.ts

@@ -1 +0,0 @@
-declare let __DEV__: boolean

package/dist/template/base/config/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "files": ["eslint.config.mts"],
-  "include": ["scripts/**/*"]
-}

package/dist/template/playground/config/packages/playground/tsconfig.app.json

@@ -1,11 +0,0 @@
-{
-  "extends": "@vue/tsconfig/tsconfig.dom.json",
-  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
-  "compilerOptions": {
-    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.playground.app.tsbuildinfo",
-    "paths": {
-      "@/*": ["./src/*"],
-      "@scopedPackageName@": ["../@projectName@/src/index.ts"]
-    }
-  }
-}

package/dist/template/playground/config/packages/playground/vite.config.mts

@@ -1,22 +0,0 @@
-import { fileURLToPath, URL } from 'node:url'
-
-import { defineConfig } from 'vite'
-import vue from '@vitejs/plugin-vue'
-import vueDevTools from 'vite-plugin-vue-devtools'
-
-export default defineConfig(({ mode }) => ({
-  plugins: [
-    vue(),
-    vueDevTools()
-  ],
-  resolve: {
-    alias: {
-      '@': fileURLToPath(new URL('./src', import.meta.url)),
-      '@scopedPackageName@': fileURLToPath(new URL('../@projectName@/src/index.ts', import.meta.url))
-    }
-  },
-
-  define: {
-    __DEV__: JSON.stringify(mode !== 'production')
-  }
-}))