@citruslime/create-boilerplate 3.0.0-beta.2 → 3.0.0-beta.3

package/template/packages/utils/_lintstagedrc.js

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+export default {
+    '*.{js,cjs,mjs,ts,cts,mts}': ['eslint --fix']
+};

package/template/packages/utils/eslint.config.js

@@ -0,0 +1 @@
+export { default } from '@[[PACKAGE_NAME]]/config-eslint';

package/template/packages/utils/exports-list.json

@@ -0,0 +1 @@
+["api"]

package/template/packages/utils/exports-list.ts

@@ -0,0 +1,95 @@
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { basename, join } from 'node:path';
+
+import { createUnimport, type Import, type ScanDir, type ScanDirExportsOptions } from 'unimport';
+
+/**
+ * Writes the exports list to the package root.
+ *
+ * @param packageRoot The root directory of the package.
+ * @returns A promise that resolves when the exports list is written.
+ */
+export async function writeExportsList (packageRoot: string): Promise<void> {
+    const importItems: Import[] = await getExportsList(packageRoot);
+
+    const names = new Set<string>();
+
+    for (const importItem of importItems) {
+        const name = importItem.as ?? importItem.name;
+
+        if (name === 'default') {
+            const from = importItem.from;
+
+            if (from) {
+                names.add(basename(from, '.ts'));
+            }
+        }
+        else {
+            names.add(name);
+        }
+    }
+
+    writeFileSync(join(packageRoot, 'exports-list.json'), JSON.stringify(Array.from(names).sort()));
+}
+
+/**
+ * Gets the exports list from the package root.
+ *
+ * @param packageRoot The root directory of the package.
+ * @returns The exports list.
+ */
+async function getExportsList (packageRoot: string): Promise<Import[]> {
+    const unimport = createUnimport({ imports: [] });
+    const directories: ScanDir[] = [{ glob: '**/*.ts' }];
+    const options: ScanDirExportsOptions = {
+        cwd: join(packageRoot, 'src'),
+        filePatterns: ['*.ts']
+    };
+
+    try {
+        return await unimport.scanImportsFromDir(directories, options);
+    }
+    catch {
+        return [];
+    }
+}
+
+/**
+ * Reads the export names from the exports list.
+ *
+ * @param packageRoot The root directory of the package.
+ * @returns The export names.
+ * @throws {Error} An error if the exports list is not found.
+ */
+export function readExportNames (packageRoot: string): string[] {
+    const fromManifest = readManifest(packageRoot);
+
+    if (fromManifest.length > 0) {
+        return fromManifest;
+    }
+
+    throw new Error(
+        '@[[PACKAGE_NAME]]/utils: exports-list.json not found. Add AppUtilsPlugin() to your Vite config (or run the dev server once).'
+    );
+}
+
+/**
+ * Reads the manifest from the exports list.
+ *
+ * @param packageRoot The root directory of the package.
+ * @returns The manifest.
+ */
+function readManifest (packageRoot: string): string[] {
+    const manifestPath = join(packageRoot, 'exports-list.json');
+
+    if (!existsSync(manifestPath)) {
+        return [];
+    }
+
+    try {
+        return JSON.parse(readFileSync(manifestPath, 'utf-8')) as string[];
+    }
+    catch {
+        return [];
+    }
+}

package/template/packages/utils/package.json

@@ -0,0 +1,43 @@
+{
+    "name": "@[[PACKAGE_NAME]]/utils",
+    "type": "module",
+    "version": "0.0.0",
+    "private": true,
+    "main": "./dist/index.mjs",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "run-s build-only build-types",
+        "build-only": "vite build",
+        "build-types": "vue-tsc -p tsconfig.build.json --declaration --emitDeclarationOnly",
+        "lint": "eslint . --cache"
+    },
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs"
+        },
+        "./resolver": {
+            "types": "./resolver.ts",
+            "import": "./resolver.ts",
+            "default": "./resolver.ts"
+        },
+        "./plugin": {
+            "types": "./plugin.ts",
+            "import": "./plugin.ts",
+            "default": "./plugin.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "exports-list.json",
+        "plugin.ts",
+        "resolver.ts",
+        "exports-list.ts"
+    ],
+    "devDependencies": {
+        "@[[PACKAGE_NAME]]/config-eslint": "workspace:*",
+        "@[[PACKAGE_NAME]]/config-typescript": "workspace:*"
+    }
+}

package/template/packages/utils/plugin.ts

@@ -0,0 +1,55 @@
+import { basename, dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import type { Plugin } from 'vite';
+
+import { writeExportsList } from './exports-list.ts';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageRoot = basename(__dirname) === 'dist' ? join(__dirname, '..') : __dirname;
+
+/**
+ * Creates a Vite plugin that writes the exports list to the package root.
+ *
+ * @returns A Vite plugin that writes the exports list to the package root.
+ */
+export function utilsPlugin (): Plugin {
+    return {
+        name: '@[[PACKAGE_NAME]]/utils:exports-list',
+        enforce: 'pre',
+        async config () {
+            await writeExportsList(packageRoot);
+        },
+        configureServer (server) {
+            let pending: ReturnType<typeof setTimeout> | null = null;
+            const schedule = (): void => {
+                if (pending) {
+                    return;
+                }
+
+                pending = setTimeout(async () => {
+                    pending = null;
+                    try {
+                        await writeExportsList(packageRoot);
+                    }
+                    catch (error) {
+                        console.error('Failed to write exports list:', error);
+                    }
+                }, 150);
+            };
+
+            try {
+                server.watcher.add(join(packageRoot, 'src'));
+                server.watcher.on('change', schedule);
+                server.watcher.on('add', schedule);
+                server.watcher.on('unlink', schedule);
+            }
+            catch {
+                // src may not exist in some setups
+            }
+        }
+    };
+}
+
+export default utilsPlugin;

package/template/packages/utils/resolver.ts

@@ -0,0 +1,38 @@
+import { basename, dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import type { Resolver } from 'unplugin-auto-import/types';
+
+import { readExportNames } from './exports-list.ts';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageRoot = basename(__dirname) === 'dist' ? join(__dirname, '..') : __dirname;
+const packageName = '@[[PACKAGE_NAME]]/utils';
+
+/**
+ * Creates a resolver for the utils package.
+ *
+ * @returns A resolver for the utils package.
+ */
+export function utilsResolver (): Resolver {
+    return (name) => {
+        let exports: string[];
+
+        try {
+            exports = readExportNames(packageRoot);
+        }
+        catch {
+            return null;
+        }
+
+        if (exports.includes(name)) {
+            return { from: packageName,
+                name };
+        }
+
+        return null;
+    };
+}
+
+export default utilsResolver;

package/template/packages/utils/src/api/api.ts

@@ -0,0 +1,6 @@
+import { useApi } from '@citruslime/vue-utils';
+
+import { endpoints } from './endpoints';
+import { handleFetchErrorResponse } from './errors';
+
+export const api = useApi(endpoints, handleFetchErrorResponse, '/api');

package/template/packages/utils/src/api/endpoints.ts

@@ -0,0 +1,18 @@
+import { createEndpoint } from '@citruslime/vue-utils';
+
+/**
+ * Gets the standard headers for an API request.
+ *
+ * @param accept The MIME type of the accepted response.
+ * @returns The standard headers for API requests.
+ */
+function getHeaders (accept: string = 'application/json'): HeadersInit {
+    return {
+        accept,
+        'accept-language': 'en-GB'
+    } as HeadersInit;
+}
+
+export const endpoints = {
+    appInfo: createEndpoint('/appinfo', 'GET', getHeaders)
+};

package/template/packages/utils/src/api/errors.ts

@@ -0,0 +1,19 @@
+interface ResponseContext {
+    data: unknown;
+    response: Response | null;
+    error: unknown;
+}
+
+/**
+ * Handles error responses from the API.
+ *
+ * @param context The response context containing data, response, and error.
+ */
+export async function handleFetchErrorResponse (context: ResponseContext): Promise<void> {
+    if (context.response && !context.response.ok) {
+        console.error(`API error: ${context.response.status} ${context.response.statusText}`);
+    }
+    else if (context.error) {
+        console.error('Network error:', context.error);
+    }
+}

package/template/packages/utils/src/api/models/app-info.ts

@@ -0,0 +1,5 @@
+export interface AppInfo {
+    name: string;
+    version: string;
+    environment: string;
+}

package/template/packages/utils/src/index.ts

@@ -0,0 +1,2 @@
+export { api } from './api/api';
+export type { AppInfo } from './api/models/app-info';

package/template/packages/utils/tsconfig.build.json

@@ -0,0 +1,19 @@
+{
+    "extends": "./tsconfig.lib.json",
+    "compilerOptions": {
+        "composite": false,
+        "rootDir": "src",
+        "outDir": "dist",
+        "noEmit": false,
+        "declaration": true,
+        "declarationMap": true,
+        "allowImportingTsExtensions": false
+    },
+    "include": [
+        "src/**/*.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}

package/template/packages/utils/tsconfig.json

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

package/template/packages/utils/tsconfig.lib.json

@@ -0,0 +1,15 @@
+{
+    "extends": "@[[PACKAGE_NAME]]/config-typescript/vue.json",
+    "include": [
+        "src/**/*.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ],
+    "compilerOptions": {
+        "composite": true,
+        "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.lib.tsbuildinfo",
+        "allowArbitraryExtensions": true
+    }
+}

package/template/packages/utils/tsconfig.node.json

@@ -0,0 +1,21 @@
+{
+    "extends": "@[[PACKAGE_NAME]]/config-typescript/node.json",
+    "include": [
+        "vite.config.ts",
+        "exports-list.ts",
+        "plugin.ts",
+        "resolver.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ],
+    "compilerOptions": {
+        "composite": true,
+        "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+        "noEmit": true,
+        "types": [
+            "node"
+        ]
+    }
+}

package/template/packages/utils/vite.config.ts

@@ -0,0 +1,31 @@
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { defineConfig } from 'vite';
+
+import { utilsPlugin } from './plugin';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig({
+    plugins: [utilsPlugin()],
+    build: {
+        lib: {
+            entry: resolve(__dirname, 'src/index.ts'),
+            formats: ['es']
+        },
+        outDir: 'dist',
+        emptyOutDir: true,
+        sourcemap: true,
+        rollupOptions: {
+            external: id =>
+                id === 'vue' ||
+                id === '@citruslime/vue-utils' ||
+                id.startsWith('node:'),
+            output: {
+                entryFileNames: '[name].mjs'
+            }
+        }
+    }
+});

package/template/pnpm-workspace.yaml

@@ -0,0 +1,11 @@
+packages:
+  - apps/*
+  - packages/*
+
+publicHoistPattern:
+  - "*eslint*"
+  - "*stylelint*"
+
+allowBuilds:
+  esbuild: true
+  unrs-resolver: true

package/template/{.vscode/template.code-workspace → template.code-workspace}

@@ -2,11 +2,31 @@
     "folders": [
         {
             "name": "Root",
-            "path": ".."
+            "path": "."
         },
         {
-            "name": "Hooks",
-            "path": "[[HUSKY_DIR]]"
+            "name": "App",
+            "path": "apps/app"
+        },
+        {
+            "name": "ESLint Config",
+            "path": "packages/config-eslint"
+        },
+        {
+            "name": "Stylelint Config",
+            "path": "packages/config-stylelint"
+        },
+        {
+            "name": "TypeScript Config",
+            "path": "packages/config-typescript"
+        },
+        {
+            "name": "Utils",
+            "path": "packages/utils"
+        },
+        {
+            "name": "Git Hooks",
+            "path": "[[GIT_ROOT]]/.husky"
         }
     ],
     "settings": {
@@ -24,7 +44,6 @@
         },
         "editor.defaultFormatter": "dbaeumer.vscode-eslint",
         "editor.formatOnSave": true,
-        "eslint.experimental.useFlatConfig": true,
         "eslint.validate": [
             "html",
             "javascript",
@@ -36,8 +55,8 @@
         "files.exclude": {
             ".husky": true,
             "node_modules": true,
-            "packages": true,
-            "pipelines": true
+            "apps": true,
+            "packages": true
         },
         "stylelint.validate": [
             "css",
@@ -63,4 +82,4 @@
             "antfu.iconify"
         ]
     }
-}
+}

package/template/turbo.json

@@ -0,0 +1,24 @@
+{
+    "$schema": "https://turbo.build/schema.json",
+    "tasks": {
+        "build": {
+            "dependsOn": [
+                "^build"
+            ],
+            "outputs": [
+                "dist/**"
+            ]
+        },
+        "dev": {
+            "cache": false,
+            "persistent": true
+        },
+        "preview": {
+            "cache": false,
+            "persistent": true
+        },
+        "lint": {
+            "outputs": []
+        }
+    }
+}

package/hooks/post-checkout

@@ -1,8 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-if ! command -v pnpm; then
-    choco install pnpm -y
-fi
-
-pnpm install -w -C "[[PACKAGE_DIR]]"

package/hooks/post-merge

@@ -1,8 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-if ! command -v pnpm; then
-    choco install pnpm -y
-fi
-
-pnpm install -w -C "[[PACKAGE_DIR]]"

package/hooks/pre-commit

@@ -1,8 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-if ! command -v pnpm; then
-    choco install pnpm -y
-fi
-
-pnpm -C "[[PACKAGE_DIR]]" pre-commit-lint

package/template/.vscode/extensions.json

@@ -1,14 +0,0 @@
-{
-    "recommendations": [
-        "Vue.volar",
-        "dbaeumer.vscode-eslint",
-        "stylelint.vscode-stylelint",
-        "bradlc.vscode-tailwindcss",
-        "eamodio.gitlens",
-        "christian-kohler.npm-intellisense",
-        "pmneo.tsimporter",
-        "editorconfig.editorconfig",
-        "cpylua.language-postcss",
-        "antfu.iconify"
-    ]
-}

package/template/.vscode/settings.json

@@ -1,40 +0,0 @@
-{
-    "[json]": {
-        "editor.defaultFormatter": "vscode.json-language-features"
-    },
-    "[jsonc]": {
-        "editor.defaultFormatter": "vscode.json-language-features"
-    },
-    "editor.codeActionsOnSave": {
-        "source.fixAll": "explicit",
-        "source.fixAll.eslint": "explicit",
-        "source.fixAll.stylelint": "explicit",
-        "source.organizeImports": "never"
-    },
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-    "editor.formatOnSave": true,
-    "eslint.experimental.useFlatConfig": true,
-    "eslint.validate": [
-        "html",
-        "javascript",
-        "typescript",
-        "vue"
-    ],
-    "files.encoding": "utf8",
-    "files.eol": "\n",
-    "files.exclude": {
-        ".husky": true,
-        "node_modules": true,
-        "packages": true,
-        "pipelines": true
-    },
-    "stylelint.validate": [
-        "css",
-        "postcss",
-        "vue"
-    ],
-    "tailwindCSS.includeLanguages": {
-        "vue": "html",
-        "vue-html": "html"
-    }
-}

package/template/_lintstagedrc.js

@@ -1,5 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-export default {
-    './**/*.+(js|cjs|mjs|ts|cts|mts|vue)': ['eslint --fix'],
-    './**/*.(css|vue)': ['stylelint --fix']
-};

package/template/_npmrc

@@ -1,3 +0,0 @@
-public-hoist-pattern[]=*eslint*
-public-hoist-pattern[]=*stylelint*
-public-hoist-pattern[]=*tailwindcss*

package/template/eslint.config.js

@@ -1,11 +0,0 @@
-import config from '@citruslime/config/eslint';
-import { FlatCompat } from '@eslint/eslintrc';
-
-const compat = new FlatCompat({
-    baseDirectory: import.meta.url
-});
-
-export default [
-    ...config,
-    ...compat.extends('./.eslintrc-auto-import.json')
-];

package/template/index.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" href="/favicon.ico" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0">
-    <title>[[PACKAGE_NAME]]</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/template/postcss.config.js

@@ -1,6 +0,0 @@
-export default {
-    plugins: {
-        tailwindcss: {},
-        autoprefixer: {}
-    }
-};

package/template/src/main.ts

@@ -1,15 +0,0 @@
-import { i18n } from '@citruslime/ui';
-import '@citruslime/utils';
-import piniaPluginPersistedstate from 'pinia-plugin-persistedstate';
-
-import app from './app.vue';
-
-const pinia = createPinia();
-
-pinia.use(piniaPluginPersistedstate);
-
-createApp(app)
-    .use(router)
-    .use(i18n)
-    .use(pinia)
-    .mount('#app');

package/template/src/state/auth.ts

@@ -1,13 +0,0 @@
-export const useAuthStore = defineStore('auth', () => {
-    const username = ref<string>('Nobody');
-    const loginDate = ref<string | null>(null);
-
-    return {
-        username,
-        loginDate
-    };
-}, {
-    persist: {
-        storage: localStorage
-    }
-});