Sync build with @skirtle/create-vue-lib (#10)

Author: skirtles-code

.editorconfig

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

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
+
+jobs:
+  ci:
+    if: github.repository == 'skirtles-code/vue-vnode-utils'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Lint
+        run: pnpm run lint
+      - name: Type check
+        run: pnpm run type-check
+      - name: Build
+        run: pnpm run build
+      - name: Test
+        run: pnpm run test:unit

.github/workflows/pages.yml

@@ -32,8 +32,6 @@ jobs:
         uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 9
       - name: Set up Node
         uses: actions/setup-node@v4
         with:

.gitignore

@@ -14,6 +14,10 @@ dist-ssr
 coverage
 *.local
 packages/docs/.vitepress/cache
+packages/vue-vnode-utils/README.md
+
+/cypress/videos/
+/cypress/screenshots/
 
 # Editor directories and files
 .vscode/*
@@ -24,3 +28,5 @@ packages/docs/.vitepress/cache
 *.njsproj
 *.sln
 *.sw?
+
+*.tsbuildinfo

packages/vue-vnode-utils/LICENSE renamed to LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2024, skirtle
+Copyright (c) 2022-2025, skirtle
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -65,4 +65,4 @@ Some browsers do not yet have full support for import maps.
 
 MIT
 
-Copyright © 2022-2024, skirtle
+Copyright © 2022-2025, skirtle

eslint.config.mts

@@ -0,0 +1,43 @@
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { includeIgnoreFile } from '@eslint/compat'
+import pluginVue from 'eslint-plugin-vue'
+import stylistic from '@stylistic/eslint-plugin'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import pluginVitest from '@vitest/eslint-plugin'
+
+export default defineConfigWithVueTs(
+  {
+    name: 'app/files-to-lint',
+    files: ['**/*.{ts,mts,vue}']
+  },
+
+  includeIgnoreFile(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '.gitignore')),
+
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
+
+  stylistic.configs.customize({
+    braceStyle: '1tbs',
+    commaDangle: 'never',
+    quoteProps: 'as-needed'
+  }),
+
+  {
+    rules: {
+      '@stylistic/arrow-parens': 'off',
+      '@stylistic/spaced-comment': ['error', 'always', { exceptions: ['#__PURE__'] }],
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-expressions': ['error', { allowShortCircuit: true }],
+      'vue/block-lang': 'off',
+      'vue/require-v-for-key': 'off',
+      'vue/valid-v-for': 'off'
+    }
+  },
+
+  {
+    ...pluginVitest.configs.recommended,
+    files: ['src/**/__tests__/*']
+  }
+)

package.json

@@ -1,21 +1,45 @@
 {
   "private": true,
   "type": "module",
+  "packageManager": "[email protected]",
+  "engines": {
+    "node": ">=v18.3.0"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.2.7",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@tsconfig/node22": "^22.0.0",
+    "@types/node": "^22.13.9",
+    "@vitest/eslint-plugin": "^1.1.36",
+    "@vue/eslint-config-typescript": "^14.5.0",
+    "eslint": "^9.21.0",
+    "eslint-plugin-vue": "~10.0.0",
+    "jiti": "^2.4.2",
+    "lint-staged": "^15.4.3",
+    "npm-run-all2": "^7.0.2",
+    "simple-git-hooks": "^2.11.1",
+    "typescript": "~5.8.0"
+  },
   "scripts": {
     "clean": "pnpm run -r clean",
-    "build": "pnpm run -r build",
-    "type-check": "pnpm run -r type-check",
     "docs:dev": "pnpm run --filter ./packages/docs -r dev",
     "docs:build": "pnpm run --filter ./packages/docs -r build",
     "test:unit": "pnpm run --filter ./packages/vue-vnode-utils -r test:unit",
     "coverage": "pnpm run --filter ./packages/vue-vnode-utils -r coverage",
-    "preinstall": "npx only-allow pnpm",
+    "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",
+    "build": "pnpm run -r build",
+    "preinstall": "node scripts/preinstall.js",
     "postinstall": "simple-git-hooks"
   },
   "simple-git-hooks": {
-    "pre-commit": "pnpm run type-check"
+    "pre-commit": "pnpm exec run-s type-check lint:staged"
   },
-  "devDependencies": {
-    "simple-git-hooks": "^2.11.1"
+  "lint-staged": {
+    "*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}": "eslint --fix"
   }
 }

packages/docs/.vitepress/config.mts

@@ -1,23 +1,38 @@
+import { fileURLToPath, URL } from 'node:url'
+
 import { defineConfigWithTheme } from 'vitepress'
-import { resolve } from 'node:path'
 
 export default ({ mode }: { mode: string }) => defineConfigWithTheme({
   srcDir: './src',
   outDir: './dist',
-  base: '/vue-vnode-utils',
+  base: '/vue-vnode-utils/',
   title: '@skirtle/vue-vnode-utils',
   lang: 'en-US',
   description: 'VNode utilities for Vue',
 
+  sitemap: {
+    hostname: 'https://skirtles-code.github.io/vue-vnode-utils/'
+  },
+
+  transformHead({ page }) {
+    if (page !== '404.md') {
+      const canonicalUrl = `https://skirtles-code.github.io/vue-vnode-utils/${page}`
+        .replace(/index\.md$/, '')
+        .replace(/\.md$/, '.html')
+
+      return [['link', { rel: 'canonical', href: canonicalUrl }]]
+    }
+  },
+
   vite: {
     resolve: {
       alias: {
-        '@skirtle/vue-vnode-utils': resolve(__dirname, '../../vue-vnode-utils/src/index.ts')
+        '@skirtle/vue-vnode-utils': fileURLToPath(new URL('../../vue-vnode-utils/src/', import.meta.url))
       }
     },
 
     define: {
-      __DEV__: JSON.stringify(mode !== 'production')
+      __DEV__: mode !== 'production'
     }
   },
 

packages/docs/.vitepress/theme/components/live-example.vue

@@ -5,7 +5,7 @@
   </fieldset>
 </template>
 
-<script>
+<script lang="ts">
 export default {
   name: 'live-example'
 }