@skirtle/create-vue-lib 0.0.0

package/dist/template/playground/examples/packages/playground/src/main.ts

@@ -0,0 +1,4 @@
+import { createApp } from 'vue'
+import App from './App.vue'
+
+createApp(App).mount('#app')

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

@@ -0,0 +1,70 @@
+import { resolve } from 'node:path'
+
+import { defineConfigWithTheme } from 'vitepress'
+
+export default ({ mode }: { mode: string }) => defineConfigWithTheme({
+  srcDir: './src',
+  outDir: './dist',
+  base: '<%- config.docsBase %>',
+  title: '<%- config.scopedPackageName %>',
+  lang: 'en-US',
+  description: 'Description',
+  cleanUrls: true,
+
+  <%_ if (config.githubPagesOrigin) { _%>
+  sitemap: {
+    hostname: '<%- config.githubPagesOrigin  %><%- config.docsBase %>'
+  },
+
+  transformHead({ page }) {
+    if (page !== '404.md') {
+      // The final replacement assumes `cleanUrls: true` is set
+      const canonicalUrl = `<%- config.githubPagesOrigin  %><%- config.docsBase %>${page}`
+        .replace(/index\.md$/, '')
+        .replace(/\.md$/, '')
+
+      return [['link', { rel: 'canonical', href: canonicalUrl }]]
+    }
+  },
+
+  <%_ } _%>
+  vite: {
+    resolve: {
+      alias: {
+        '<%- config.scopedPackageName %>': resolve(__dirname, '../../<%- config.mainPackageDirName %>/src/index.ts')
+      }
+    },
+
+    define: {
+      __DEV__: JSON.stringify(mode !== 'production')
+    }
+  },
+
+  themeConfig: {
+    search: {
+      provider: 'local'
+    },
+
+    nav: [
+      { text: 'Guide', link: '/introduction' }
+    ],
+
+    <%_ if (config.githubUrl) { _%>
+    socialLinks: [
+      { icon: 'github', link: '<%- config.githubUrl %>' }
+    ],
+
+    <%_ } _%>
+    sidebar: [
+      {
+        text: 'Getting started',
+        items: [
+          {
+            text: 'Introduction',
+            link: '/introduction'
+          }
+        ]
+      }
+    ]
+  }
+})

package/dist/template/vitepress/config/packages/docs/.vitepress/theme/index.ts

@@ -0,0 +1,8 @@
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+
+const theme: Theme = {
+  extends: DefaultTheme
+}
+
+export default theme

package/dist/template/vitepress/config/packages/docs/env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="vite/client" />
+/// <reference path="../@projectName@/src/global.d.ts" />

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

@@ -0,0 +1,24 @@
+{
+  "private": true,
+  "scripts": {
+    "clean": "rimraf dist && rimraf .vitepress/cache",
+    "dev": "vitepress dev .",
+    "type-check": "vue-tsc --noEmit -p tsconfig.app.json --composite false",
+    "build-only": "vitepress build .",
+    "build": "pnpm run type-check && pnpm run build-only",
+    "preview": "vitepress preview .",
+    "preinstall": "node ../../scripts/preinstall.js"
+  },
+  "dependencies": {
+    "vue": "^3.5.13"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.0",
+    "@types/node": "^22.13.0",
+    "@vue/tsconfig": "^0.7.0",
+    "rimraf": "^6.0.1",
+    "typescript": "~5.7.3",
+    "vitepress": "^1.6.3",
+    "vue-tsc": "^2.2.0"
+  }
+}

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

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

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

@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}

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

@@ -0,0 +1,18 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "nightwatch.conf.*",
+    "playwright.config.*",
+    "eslint.config.*"
+  ],
+  "compilerOptions": {
+    "noEmit": true,
+    "tsBuildInfoFile": "../../node_modules/.tmp/tsconfig.docs.node.tsbuildinfo",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": ["node"]
+  }
+}

package/dist/template/vitepress/examples/packages/docs/src/index.md

@@ -0,0 +1,32 @@
+---
+layout: home
+
+title: @unscopedPackageName@
+titleTemplate: Title template
+
+hero:
+  name: @unscopedPackageName@
+  text: Description
+  tagline: Tag line!
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /introduction
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/???/???
+    - theme: alt
+      text: See a demo
+      link: https://play.vuejs.org/
+
+features:
+  - icon: 🧩
+    title: Pretty great
+    details: Do great things.
+  - icon: 📦
+    title: Small and tree-shakable
+    details: Presumably.
+  - icon: 🔑
+    title: Type safe
+    details: A fully typed API.
+---

package/dist/template/vitepress/examples/packages/docs/src/introduction.md

@@ -0,0 +1,29 @@
+<script setup lang="ts">
+import { Example as ExampleComponent, MyPanel } from '@scopedPackageName@'
+</script>
+
+<style scoped>
+.panel {
+  margin: 20px 0;
+}
+</style>
+
+# Introduction
+
+<ExampleComponent />
+
+<MyPanel title="Panel title" footer="Panel footer">
+  Header and footer
+</MyPanel>
+
+<MyPanel title="Panel title">
+  Just a header
+</MyPanel>
+
+<MyPanel footer="Panel footer">
+  Just a footer
+</MyPanel>
+
+<MyPanel>
+  No header or footer
+</MyPanel>

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@skirtle/create-vue-lib",
+  "version": "0.0.0",
+  "author": "skirtle",
+  "license": "MIT",
+  "description": "Create a library using Vue and Vite",
+  "keywords": [
+    "vue",
+    "library",
+    "scaffold",
+    "vite",
+    "build"
+  ],
+  "homepage": "https://github.com/skirtles-code/create-vue-lib#readme",
+  "bugs": "https://github.com/skirtles-code/create-vue-lib/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skirtles-code/create-vue-lib.git"
+  },
+  "funding": "https://github.com/sponsors/skirtles-code",
+  "type": "module",
+  "engines": {
+    "node": ">=v18.3.0"
+  },
+  "bin": {
+    "create-vue-lib": "dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.0",
+    "@types/ejs": "^3.1.5",
+    "@types/node": "^22.13.0",
+    "@types/prompts": "^2.4.9",
+    "copyfiles": "^2.4.1",
+    "ejs": "^3.1.10",
+    "lint-staged": "^15.4.3",
+    "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": "pnpm run clean && pnpm run build:copy && pnpm run build:ts",
+    "build:copy": "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",
+    "start": "node ./dist/index.cjs",
+    "preinstall": "npx only-allow pnpm"
+  }
+}