@citruslime/create-boilerplate 0.1.2 → 1.0.0-beta.11

package/README.md

@@ -1,30 +1,25 @@
-# Citrus-Lime UI Library Boilerplate Creation
+# Citrus-Lime UI Library Create Boilerplate Script
+
+A create package for initialising Citrus-Lime web apps.
 
 ![version](https://img.shields.io/npm/v/@citruslime/create-boilerplate/latest)
 ![version next](https://img.shields.io/npm/v/@citruslime/create-boilerplate/next)
-![license](https://img.shields.io/npm/l/@citruslime/create-boilerplate)
 
 - ⚡ [NPM Package](https://www.npmjs.com/package/@citruslime/create-boilerplate)
 - 📖 [Documentation & API](https://uilibrary.citruslime.com)
 - 📌 [Citrus-Lime Ltd](https://www.citruslime.com)
 
-## Running the script
 
-⚠️ All of the parameters listed below are required.
+`npm init @citruslime/boilerplate TargetDirectory`
+
+or
+
+`yarn create @citruslime/boilerplate TargetDirectory`
 
-#### Script signature
-```yarn create @citruslime/boilerplate ScriptTarget PackageName FrontEndPortNumber BackendPortNumber AutoRun```
+- **TargetDirectory**
+  - A relative folder path for the script to create the boilerplate app
+  - *Optional* - will be prompted for, if not provided
 
-- **ScriptTarget**
-  - _A relative folder path for the script to create the boilerplate app_
-- **PackageName**
-  - _Using a lower-kebab-cased naming convention_
-- **FrontEndPortNumber**
-  - _The port in which the vite app will run_
-- **BackendPortNumber**
-  - _The port in which the API project which drives the front-end api will run_
-- **AutoRun**
-  - `true|false` _Run the app immediately after creating it_
+e.g.
 
-#### Example Script Execution
-```yarn create @citruslime/boilerplate ./ui/customer app-customer-ui 3001 44531 true```
+`yarn create @citruslime/boilerplate ./ui/customer`

package/main.mjs

@@ -0,0 +1,373 @@
+#!/usr/bin/env node
+
+import { execSync } from 'child_process';
+import { existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+
+import { lightBlue, green, red } from 'kolorist';
+import parseArgs from 'minimist';
+import prompts from 'prompts';
+
+const argv = parseArgs(process.argv.slice(2));
+const cwd = process.cwd();
+
+const placeholdersToReplace = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    '[[PACKAGE_NAME]]': '',
+    '[[REPOSITORY_ROOT]]': '',
+    '[[BACKEND_PORT]]': 0,
+    '[[FRONTEND_PORT]]': 0,
+    '/* eslint-disable array-bracket-spacing */': '',
+    '/* eslint-enable array-bracket-spacing */': ''
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+
+const filesToRename = {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    _gitignore: '.gitignore',
+    _editorconfig: '.editorconfig',
+    _eslintignore: '.eslintignore',
+    '_eslintrc.js': '.eslintrc.js',
+    '_lintstagedrc.json': '.lintstagedrc.json',
+    _stylelintignore: '.stylelintignore',
+    '_stylelintrc.js': '.stylelintrc.js',
+    'template.code-workspace': 'citrus-lime.code-workspace'
+    /* eslint-enable @typescript-eslint/naming-convention */
+};
+
+const dependenciesToInstall = [
+    {
+        name: '@citruslime/ui'
+    },
+    {
+        name: '@vueuse/core'
+    },
+    {
+        name: 'flatpickr'
+    },
+    {
+        name: 'pinia'
+    },
+    {
+        name: 'pinia-plugin-persistedstate'
+    },
+    {
+        name: 'vue',
+        next: true
+    },
+    {
+        name: 'vue-i18n',
+        next: true
+    },
+    {
+        name: 'vue-router',
+        next: true
+    },
+    {
+        name: '@citruslime/config',
+        dev: true
+    },
+    {
+        name: '@citruslime/theme',
+        dev: true
+    },
+    {
+        name: '@types/node',
+        dev: true
+    },
+    {
+        name: '@vitejs/plugin-vue',
+        dev: true
+    },
+    {
+        name: '@iconify/vue',
+        dev: true
+    },
+    {
+        name: '@vue/compiler-sfc',
+        dev: true
+    },
+    {
+        name: 'husky',
+        dev: true
+    },
+    {
+        name: 'lint-staged',
+        dev: true
+    },
+    {
+        name: 'typescript',
+        dev: true
+    },
+    {
+        name: 'unplugin-vue-components',
+        dev: true
+    },
+    {
+        name: 'vite',
+        dev: true
+    },
+    {
+        name: 'vite-plugin-mkcert',
+        dev: true
+    },
+    {
+        name: 'vite-plugin-pages',
+        dev: true
+    },
+    {
+        name: 'vue-tsc',
+        dev: true
+    }
+];
+
+/**
+ * Initialise the new package.
+ */
+async function init () {
+    let packageDir = argv._[0];
+
+    const {
+        packageName,
+        empty,
+        packageManager,
+        rootDir,
+        frontendPort,
+        backendPort
+    } = await prompts([
+        {
+            type: 'text',
+            name: 'packageName',
+            message: 'Enter a package name:',
+            validate: (value) => /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(value)
+        },
+        {
+            type: packageDir ? null : 'text',
+            name: 'packageDir',
+            message: 'Enter a directory for the package:',
+            onState: (state) => packageDir = state.value
+        },
+        {
+            type: () => !existsSync(packageDir) || readdirSync(packageDir).length === 0 ? null : 'confirm',
+            name: 'empty',
+            message: () => `${packageDir === '.' ? 'Current directory' : `Target directory "${packageDir}"`} is not empty. Remove existing files and continue?`
+        },
+        {
+            type (_, { empty }) {
+                if (empty === false) {
+                    cancel();
+                }
+
+                return null;
+            },
+            name: 'emptyConfirmation'
+        },
+        {
+            type: 'select',
+            name: 'packageManager',
+            message: 'Select a package manager:',
+            choices: [
+                {
+                    title: 'yarn',
+                    value: 'yarn'
+                },
+                {
+                    title: 'npm',
+                    value: 'npm'
+                }
+            ],
+            initial: 0
+        },
+        {
+            type: 'text',
+            name: 'rootDir',
+            message: 'Enter the relative path to the root of the repository:',
+            validate: (value) => value && value?.trim() !== ''
+        },
+        {
+            type: 'number',
+            name: 'frontendPort',
+            message: 'Enter the port for the dev server to run on:'
+        },
+        {
+            type: 'text',
+            name: 'backendPort',
+            message: 'Enter the port that the backend server runs on:'
+        }
+    ], {
+        onCancel: () => cancel()
+    });
+
+    print(lightBlue('Initialising package...'), true);
+
+    setReplacements(packageName, rootDir, frontendPort, backendPort);
+    prepareDir(join(cwd, packageDir), empty);
+    copyTemplate(packageDir);
+
+    process.chdir(packageDir);
+    installDependencies(packageManager);
+
+    print(green(`Package ${packageName} has been successfully initialised in ${packageDir}.`), true);
+}
+
+/**
+ * Set the dynamic values for the file renaming and placeholder replacements.
+ *
+ * @param {string} packageName The name of the package being created.
+ * @param {string} rootDir The relative path of the root of the repository.
+ * @param {number} frontendPort The port that the frontend dev server will run on.
+ * @param {number} backendPort The port that the backend server runs on.
+ */
+function setReplacements (packageName, rootDir, frontendPort, backendPort) {
+    filesToRename['template.code-workspace'] = `${packageName}.code-workspace`;
+
+    placeholdersToReplace['[[PACKAGE_NAME]]'] = packageName;
+    placeholdersToReplace['[[REPOSITORY_ROOT]]'] = rootDir;
+    placeholdersToReplace['[[FRONTEND_PORT]]'] = frontendPort;
+    placeholdersToReplace['[[BACKEND_PORT]]'] = backendPort;
+}
+
+/**
+ * Prepares the directory for the new package to be created in.
+ *
+ * @param {string} path The path of the directory to be prepared.
+ * @param {boolean} empty If the current contents needs to be emptied.
+ */
+function prepareDir (path, empty) {
+    if (empty) {
+        const options = {
+            recursive: true,
+            force: true
+        };
+
+        print(lightBlue('Emptying directory...'), true);
+
+        forEachInDir(path, (item) => rmSync(join(path, item), options));
+    }
+    else if (!existsSync(path)) {
+        print(lightBlue('Creating directory...'), true);
+
+        mkdirSync(path);
+    }
+}
+
+/**
+ * Copies the template directory into the new package directory.
+ *
+ * @param {string} packageDir The directory of the new package.
+ */
+function copyTemplate (packageDir) {
+    const codeDir = fileURLToPath(dirname(import.meta.url));
+    const templateDir = join(codeDir, 'template');
+
+    forEachInDir(templateDir, (item) => copy(templateDir, packageDir, item));
+}
+
+/**
+ * Copies a file or directory from one location to another.
+ *
+ * @param {string} source The path of the item to copy.
+ * @param {string} destination The path of the new item.
+ * @param {string} item The item to copy.
+ */
+function copy (source, destination, item) {
+    const sourceItem = join(source, item);
+    const info = statSync(sourceItem);
+
+    if (info.isDirectory()) {
+        const destinationDir = join(destination, item);
+
+        mkdirSync(destinationDir, { recursive: true });
+
+        forEachInDir(sourceItem, (item) => copy(sourceItem, destinationDir, item));
+    }
+    else {
+        const destinationFile = filesToRename[item] ? join(destination, filesToRename[item]) : join(destination, item);
+        const options = {
+            encoding: 'utf-8'
+        };
+
+        print(lightBlue(`Copying ${item}...`), true);
+
+        let contents = readFileSync(sourceItem, options);
+
+        for (const [
+            key,
+            value
+        ] of Object.entries(placeholdersToReplace)) {
+            contents = contents.replace(key, value);
+        }
+
+        writeFileSync(destinationFile, contents, options);
+    }
+}
+
+/**
+ * Installs the required dependencies for the template.
+ *
+ * @param {string} packageManager The package manager to use.
+ */
+function installDependencies (packageManager) {
+    const prefix = `${packageManager} ${packageManager === 'yarn' ? 'add' : 'install'}`;
+
+    print(lightBlue('Installing dev dependencies...'), true);
+
+    let devDependencies = '';
+    for (const dependency of dependenciesToInstall.filter(d => d.dev)) {
+        devDependencies += `${dependency.name}${dependency.next ? '@next' : '@latest'} `;
+    }
+
+    print(lightBlue('Installing dependencies...'), true);
+
+    let dependencies = '';
+    for (const dependency of dependenciesToInstall.filter(d => !d.dev)) {
+        dependencies += `${dependency.name}${dependency.next ? '@next' : '@latest'} `;
+    }
+
+    execSync(`${prefix} -D ${devDependencies}`);
+    execSync(`${prefix} ${dependencies}`);
+}
+
+/**
+ * Calls the callback for each item in a directory.
+ *
+ * @param {string} dir The directory to loop-through the contents of.
+ * @param {function(string): void} callback The callback to provide with each item.
+ */
+function forEachInDir (dir, callback) {
+    const items = readdirSync(dir);
+
+    for (const item of items) {
+        callback(item);
+    }
+}
+
+/**
+ * Throws an error to indicate that the current operation has been cancelled.
+ */
+function cancel () {
+    throw new Error('Operation was cancelled.');
+}
+
+/**
+ * Prints a message to the console.
+ *
+ * @param {string} message The message to display.
+ * @param {boolean} clearPrevious Whether to clear the previous line before displaying the new one.
+ */
+function print (message, clearPrevious = false) {
+    if (clearPrevious) {
+        process.stdout.clearLine();
+        process.stdout.cursorTo(0);
+    }
+
+    process.stdout.write(message);
+}
+
+try {
+    await init();
+}
+catch (e) {
+    print(red(e.message));
+}

package/package.json

@@ -1,34 +1,32 @@
 {
     "name": "@citruslime/create-boilerplate",
-    "version": "0.1.2",
+    "version": "1.0.0-beta.11",
     "author": {
         "name": "Citrus-Lime Ltd",
         "url": "https://citruslime.com"
     },
     "license": "MIT",
     "homepage": "https://uilibrary.citruslime.com/",
-    "repository": {
-        "url": "https://dev.azure.com/citruslime/FutureEcommerce/_git/CitrusLime.VueUiLibrary?version=GBrelease"
-    },
     "publishConfig": {
         "access": "public"
     },
     "files": [
-        "index.js",
-        "boilerplate-*"
+        "main.mjs",
+        "template-*"
     ],
-    "main": "index.js",
+    "main": "main.mjs",
     "bin": {
-        "create-boilerplate": "index.js",
-        "cva": "index.js"
+        "create-boilerplate": "main.mjs"
     },
     "engines": {
-        "node": ">=12.0.0"
+        "node": ">=14.0.0"
     },
     "dependencies": {
-        "core-js": "3.15.2",
-        "kolorist": "^1.5.0",
+        "kolorist": "^1.5.1",
         "minimist": "^1.2.5",
-        "prompts": "^2.4.1"
+        "prompts": "^2.4.2"
+    },
+    "devDependencies": {
+        "@types/prompts": "^2.0.14"
     }
 }

package/boilerplate-app/.vscode/boilerplate-app.code-workspace

@@ -1,67 +0,0 @@
-{
-    "folders": [
-        {
-            "name": "Root",
-            "path": ".."
-        },
-        {
-            "name": "Hooks",
-            "path": "../../.husky"
-        }
-    ],
-    "settings": {
-        "[css]": {
-            "editor.insertSpaces": false
-        },
-        "css.validate": false,
-        "diffEditor.ignoreTrimWhitespace": false,
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": false
-        },
-        "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-        "editor.detectIndentation": false,
-        "editor.formatOnSave": true,
-        "editor.linkedEditing": true,
-        "eslint.alwaysShowStatus": true,
-        "eslint.validate": [
-            "html",
-            "javascript",
-            "typescript",
-            "vue"
-        ],
-        "files.encoding": "utf8",
-        "files.eol": "\n",
-        "files.exclude": {
-            "node_modules": true
-        },
-        "files.trimTrailingWhitespace": true,
-        "git.autofetch": true,
-        "git.autofetchPeriod": 60,
-        "git.enableSmartCommit": true,
-        "git.pruneOnFetch": true,
-        "npm-intellisense.scanDevDependencies": true,
-        "npm-intellisense.showBuildInLibs": true,
-        "tailwindCSS.includeLanguages": {
-            "vue": "html"
-        },
-        "typescript.preferences.quoteStyle": "single",
-        "typescript.tsdk": "node_modules\\typescript\\lib",
-        "typescript.updateImportsOnFileMove.enabled": "always",
-        "volar.tsPlugin": true,
-        "volar.tsPluginStatus": false
-    },
-    "extensions": {
-        "recommendations": [
-            "johnsoncodehk.volar",
-            "dbaeumer.vscode-eslint",
-            "stylelint.vscode-stylelint",
-            "bradlc.vscode-tailwindcss",
-            "adrianwilczynski.csharp-to-typescript",
-            "eamodio.gitlens",
-            "ms-vsliveshare.vsliveshare",
-            "christian-kohler.npm-intellisense",
-            "kevinmcgowan.typescriptimport",
-            "editorconfig.editorconfig"
-        ]
-    }
-}

package/boilerplate-app/.vscode/extensions.json

@@ -1,14 +0,0 @@
-{
-    "recommendations": [
-        "johnsoncodehk.volar",
-        "dbaeumer.vscode-eslint",
-        "stylelint.vscode-stylelint",
-        "bradlc.vscode-tailwindcss",
-        "adrianwilczynski.csharp-to-typescript",
-        "eamodio.gitlens",
-        "ms-vsliveshare.vsliveshare",
-        "christian-kohler.npm-intellisense",
-        "kevinmcgowan.typescriptimport",
-        "editorconfig.editorconfig"
-    ]
-}

package/boilerplate-app/.vscode/settings.json

@@ -1,41 +0,0 @@
-{
-    "[css]": {
-        "editor.insertSpaces": false
-    },
-    "css.validate": false,
-    "diffEditor.ignoreTrimWhitespace": false,
-    "editor.codeActionsOnSave": {
-        "source.organizeImports": false
-    },
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-    "editor.detectIndentation": false,
-    "editor.formatOnSave": true,
-    "editor.linkedEditing": true,
-    "eslint.alwaysShowStatus": true,
-    "eslint.validate": [
-        "html",
-        "javascript",
-        "typescript",
-        "vue"
-    ],
-    "files.encoding": "utf8",
-    "files.eol": "\n",
-    "files.exclude": {
-        "node_modules": true
-    },
-    "files.trimTrailingWhitespace": true,
-    "git.autofetch": true,
-    "git.autofetchPeriod": 60,
-    "git.enableSmartCommit": true,
-    "git.pruneOnFetch": true,
-    "npm-intellisense.scanDevDependencies": true,
-    "npm-intellisense.showBuildInLibs": true,
-    "tailwindCSS.includeLanguages": {
-        "vue": "html"
-    },
-    "typescript.preferences.quoteStyle": "single",
-    "typescript.tsdk": "node_modules\\typescript\\lib",
-    "typescript.updateImportsOnFileMove.enabled": "always",
-    "volar.tsPlugin": true,
-    "volar.tsPluginStatus": false
-}

package/boilerplate-app/_editorconfig

@@ -1,10 +0,0 @@
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.css]
-indent_style = tab

package/boilerplate-app/_eslintignore

@@ -1,3 +0,0 @@
-dist
-node_modules
-index.html

package/boilerplate-app/_eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-    root: true,
-    extends: [ './node_modules/@citruslime/ui/dist/.eslintrc.js' ]
-};

package/boilerplate-app/_gitignore

@@ -1,5 +0,0 @@
-node_modules
-.DS_Store
-dist
-dist-ssr
-*.local

package/boilerplate-app/_lintstagedrc.json

@@ -1,8 +0,0 @@
-{
-    "./**/*.+(js|ts|vue)": [
-        "eslint --fix"
-    ],
-    "./**/*.css": [
-        "stylelint --fix"
-    ]
-}

package/boilerplate-app/_stylelintignore

@@ -1,2 +0,0 @@
-**/dist
-**/node_modules

package/boilerplate-app/_stylelintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-    extends: [ './node_modules/@citruslime/ui/dist/.stylelintrc.js' ]
-};

package/boilerplate-app/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" />
-    <title>boilerplate-app</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/boilerplate-app/package.json

@@ -1,55 +0,0 @@
-{
-    "name": "boilerplate-app",
-    "version": "0.0.0",
-    "private": true,
-    "scripts": {
-        "dev": "vite",
-        "build": "vue-tsc --noEmit && vite build",
-        "serve": "vite preview",
-        "lint": "eslint . --ext .js,.ts,.vue --fix && stylelint ./**/*.css --fix",
-        "pre-commit-lint": "yarn lint-staged",
-        "prepare": "cd .. && husky install"
-    },
-    "dependencies": {
-        "@citruslime/ui": "^1.1.3",
-        "@harlem/core": "^1.3.2",
-        "@harlem/plugin-devtools": "^1.3.2",
-        "@harlem/plugin-storage": "^1.3.2",
-        "vue": "^3.1.4",
-        "vue-router": "^4.0.10"
-    },
-    "devDependencies": {
-        "@iconify/json": "^1.1.376",
-        "@tailwindcss/forms": "^0.3.3",
-        "@typescript-eslint/eslint-plugin": "^4.28.3",
-        "@typescript-eslint/parser": "^4.28.3",
-        "@vitejs/plugin-vue": "^1.2.5",
-        "@vue/compiler-sfc": "^3.1.4",
-        "@vue/eslint-config-typescript": "^7.0.0",
-        "autoprefixer": "^10.3.1",
-        "eslint": "^7.30.0",
-        "eslint-plugin-import": "^2.23.4",
-        "eslint-plugin-jsdoc": "^35.4.3",
-        "eslint-plugin-vue": "^7.13.0",
-        "husky": "^7.0.1",
-        "lint-staged": "^11.0.1",
-        "postcss": "^8.3.5",
-        "postcss-combine-media-query": "^1.0.1",
-        "postcss-discard-duplicates": "^5.0.1",
-        "stylelint": "^13.13.1",
-        "stylelint-config-idiomatic-order": "^8.1.0",
-        "stylelint-config-standard": "^22.0.0",
-        "stylelint-group-selectors": "^1.0.8",
-        "stylelint-high-performance-animation": "^1.5.2",
-        "stylelint-order": "^4.1.0",
-        "tailwindcss": "^2.2.4",
-        "typescript": "^4.3.5",
-        "typescript-vue-plugin": "^0.26.2",
-        "vite": "^2.4.2",
-        "vite-plugin-components": "^0.13.0",
-        "vite-plugin-icons": "^0.6.5",
-        "vite-plugin-mkcert": "^1.3.2",
-        "vite-plugin-pages": "^0.15.0",
-        "vue-tsc": "^0.2.1"
-    }
-}

package/boilerplate-app/postcss.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-    plugins: {
-        tailwindcss: {},
-        autoprefixer: {},
-        'postcss-discard-duplicates': {},
-        'postcss-combine-media-query': {}
-    }
-};

package/boilerplate-app/public/site.webmanifest

@@ -1,8 +0,0 @@
-{
-    "name": "",
-    "short_name": "",
-    "icons": [],
-    "theme_color": "#637bc6",
-    "background_color": "#9acd32",
-    "display": "standalone"
-}

package/boilerplate-app/public/web.config

@@ -1,7 +0,0 @@
-<configuration>
-    <system.webServer>
-        <staticContent>
-            <mimeMap fileExtension="webmanifest" mimeType="application/json" />
-        </staticContent>
-    </system.webServer>
-</configuration>

package/boilerplate-app/src/app.css

@@ -1,9 +0,0 @@
-@import '@citruslime/ui/dist/style.css';
-
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-body {
-	@apply bg-off-white min-h-screen w-full;
-}

package/boilerplate-app/src/app.ts

@@ -1,5 +0,0 @@
-import { defineComponent } from 'vue';
-
-export default defineComponent({
-    name: 'App'
-});

package/boilerplate-app/src/app.vue

@@ -1,7 +0,0 @@
-<script lang="ts" src="./app"></script>
-
-<style src="./app.css"></style>
-
-<template>
-    <router-view />
-</template>

package/boilerplate-app/src/main.ts

@@ -1,23 +0,0 @@
-import citrusLimeUi from '@citruslime/ui';
-import harlem from '@harlem/core';
-import createDevtoolsPlugin from '@harlem/plugin-devtools';
-import createStoragePlugin from '@harlem/plugin-storage';
-import { createApp } from 'vue';
-
-import app from './app.vue';
-import router from './router';
-import { prefix } from './state';
-
-createApp(app)
-    .use(router)
-    .use(citrusLimeUi)
-    .use(harlem, {
-        plugins: [
-            createDevtoolsPlugin(),
-            createStoragePlugin('*', {
-                type: 'local',
-                prefix
-            })
-        ]
-    })
-    .mount('#app');

package/boilerplate-app/src/router/index.ts

@@ -1,18 +0,0 @@
-import generatedRoutes from 'virtual:generated-pages';
-import { createRouter, createWebHashHistory, RouteRecordRaw } from 'vue-router';
-
-export const routes: RouteRecordRaw[] = [
-    ...generatedRoutes,
-    {
-        name: 'not-found',
-        path: '/:pathMatch(.*)*',
-        redirect: '/'
-    }
-];
-
-const router = createRouter({
-    history: createWebHashHistory(),
-    routes
-});
-
-export default router;

package/boilerplate-app/src/shims-vue.d.ts

@@ -1,7 +0,0 @@
-declare module '*.vue' {
-    import { DefineComponent } from 'vue';
-
-    const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
-
-    export default component;
-}

package/boilerplate-app/src/state/index.ts

@@ -1 +0,0 @@
-export { prefix } from './utils';

package/boilerplate-app/src/state/utils/index.ts

@@ -1 +0,0 @@
-export const prefix = 'boilerplate-app';

package/boilerplate-app/src/views/dashboard/index.ts

@@ -1,5 +0,0 @@
-import { defineComponent } from 'vue';
-
-export default defineComponent({
-    name: 'Dashboard'
-});

package/boilerplate-app/src/views/dashboard/index.vue

@@ -1,11 +0,0 @@
-<script lang="ts" src="."></script>
-
-<route>
-{
-    path: '/'
-}
-</route>
-
-<template>
-    <div></div>
-</template>

package/boilerplate-app/src/vite-env.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="vite/client" />
-/// <reference types="vite-plugin-pages/client" />

package/boilerplate-app/tailwind.config.js

@@ -1,16 +0,0 @@
-module.exports = {
-    mode: 'jit',
-    presets: [ require('@citruslime/ui/dist/theme') ],
-    purge: [
-        './index.html',
-        './src/**/*.{vue,js,ts,jsx,tsx}'
-    ],
-    darkMode: false,
-    theme: {
-        extend: {}
-    },
-    variants: {
-        extend: {}
-    },
-    plugins: []
-};

package/boilerplate-app/tsconfig.json

@@ -1,29 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "esnext",
-        "module": "esnext",
-        "moduleResolution": "node",
-        "strict": true,
-        "sourceMap": true,
-        "resolveJsonModule": true,
-        "esModuleInterop": true,
-        "isolatedModules": true,
-        "lib": [
-            "esnext",
-            "dom"
-        ],
-        "types": [
-            "vite/client"
-        ],
-        "plugins": [
-            {
-                "name": "typescript-vue-plugin"
-            }
-        ]
-    },
-    "include": [
-        "src/**/*.ts",
-        "src/**/*.d.ts",
-        "src/**/*.vue"
-    ]
-}

package/boilerplate-app/vite.config.ts

@@ -1,50 +0,0 @@
-import path from 'path';
-
-import vue from '@vitejs/plugin-vue';
-import { defineConfig } from 'vite';
-import components from 'vite-plugin-components';
-import icons, { ViteIconsResolver } from 'vite-plugin-icons';
-import mkcert from 'vite-plugin-mkcert';
-import pages from 'vite-plugin-pages';
-
-export default defineConfig({
-    plugins: [
-        vue(),
-        pages({
-            pagesDir: 'src/views',
-            extensions: [ 'vue' ]
-        }),
-        components({
-            customComponentResolvers: [ ViteIconsResolver({
-                componentPrefix: ''
-            }) ]
-        }),
-        icons(),
-        mkcert()
-    ],
-    define: {
-        /* eslint-disable @typescript-eslint/naming-convention */
-        __VUE_I18N_FULL_INSTALL__: true,
-        __VUE_I18N_LEGACY_API__: false,
-        __INTLIFY_PROD_DEVTOOLS__: false
-        /* eslint-enable @typescript-eslint/naming-convention */
-    },
-    resolve: {
-        alias: {
-            '@': path.resolve(__dirname, 'src'),
-            'vue-i18n': 'vue-i18n/dist/vue-i18n.runtime.esm-bundler.js'
-        }
-    },
-    server: {
-        open: true,
-        https: true,
-        port: 9999999999,
-        proxy: {
-            '/api': {
-                target: 'https://localhost:[[PORTNUMBERBACKEND]]',
-                secure: false,
-                rewrite: (path) => path.replace('/api', '')
-            }
-        }
-    }
-});

package/index.js

@@ -1,250 +0,0 @@
-#!/usr/bin/env node
-
-/* eslint-disable indent, array-bracket-newline, array-bracket-spacing, space-before-function-paren, brace-style, eol-last, jsdoc/require-jsdoc */
-require('core-js/features/string/replace-all');
-
-const { execSync } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-
-const {
-    green,
-    bold,
-    lightCyan,
-    red
-} = require('kolorist');
-const argv = require('minimist')(process.argv.slice(2));
-
-const cwd = process.cwd();
-
-const renameFiles = {
-    _gitignore: '.gitignore', // eslint-disable-line @typescript-eslint/naming-convention
-    _editorconfig: '.editorconfig', // eslint-disable-line @typescript-eslint/naming-convention
-    _eslintignore: '.eslintignore', // eslint-disable-line @typescript-eslint/naming-convention
-    '_eslintrc.js': '.eslintrc.js', // eslint-disable-line @typescript-eslint/naming-convention
-    '_lintstagedrc.json': '.lintstagedrc.json', // eslint-disable-line @typescript-eslint/naming-convention
-    _stylelintignore: '.stylelintignore', // eslint-disable-line @typescript-eslint/naming-convention
-    '_stylelintrc.js': '.stylelintrc.js', // eslint-disable-line @typescript-eslint/naming-convention
-    'boilerplate-app.code-workspace': '' // eslint-disable-line @typescript-eslint/naming-convention,
-};
-
-const boilerplateAppText = 'boilerplate-app';
-
-const fsOptions = {
-    encoding: 'utf-8'
-};
-
-let root;
-let targetDir;
-let packageName;
-let portFrontend;
-let portBackend;
-let autoRun;
-
-async function init() {
-    targetDir = argv._[0];
-    packageName = argv._[1];
-    portFrontend = argv._[2];
-    portBackend = argv._[3];
-    autoRun = argv._[4];
-
-    const pkgManager = /yarn/.test(process.env.npm_execpath) ? 'yarn' : 'error';
-
-    testScriptParams(targetDir, packageName, pkgManager, portFrontend, portBackend, autoRun);
-
-    const packageNameStylised = packageName.split('-')
-        .map(e => e.charAt(0).toUpperCase() + e.toLowerCase().slice(1))
-        .join(' ');
-
-    root = path.join(cwd, targetDir);
-
-    if (!fs.existsSync(root)) {
-        fs.mkdirSync(root);
-    }
-
-    emptyDir(root);
-
-    console.log(`\n\n${lightCyan('Scaffolding project in ' + root + ' ...')}`);
-
-    const templateDir = path.join(__dirname, boilerplateAppText);
-
-    renameFiles['boilerplate-app.code-workspace'] = 'boilerplate-app.code-workspace';
-
-    copyFilesToTarget(templateDir, packageNameStylised);
-    ensureFilesDoNotContainBoilerplateData(templateDir);
-    runShelledScripts();
-}
-
-function runShelledScripts() {
-    const execCmd = `echo "\n\n${bold(green('Finishing installing project ...'))}"
-    cd ${targetDir}
-    echo "${lightCyan('Running yarn ...')}"
-    yarn install
-    echo "${lightCyan('Preparing project ...')}"
-    yarn prepare
-    ${autoRun === 'true' ? `echo "${lightCyan('Running project in development environment ...')}"` : ''}
-    ${autoRun === 'true' ? 'yarn dev' : ''}
-    `;
-
-    try {
-        execSync(execCmd, { shell: 'powershell.exe', stdio: 'inherit' });
-        console.log(`\n\n${bold(green('Task Complete.'))}`);
-    }
-    catch (err) {
-        console.log(`\n\n${bold(red('Task Failed.'))}`);
-
-        console.log(`\n\nStatus Code: ${err.status} with '${err.message}'`);
-
-        console.log(`\nerror : ${err}`);
-    }
-}
-
-function copyFilesToTarget(templateDir, packageNameStylised) {
-    const files = fs.readdirSync(templateDir);
-    for (const file of files) {
-        if (file === 'index.html') {
-            writeIndexHtml(templateDir, root, file, packageNameStylised);
-        } else if (file === 'vite.config.ts') {
-            writeViteConfig(templateDir, root, file, portFrontend, portBackend);
-        } else {
-            write(templateDir, root, file, null);
-        }
-    }
-}
-
-function writeIndexHtml(templateDir, root, file, packageNameStylised) {
-    let fileContent = fs.readFileSync(path.join(templateDir, file), fsOptions);
-
-    fileContent = fileContent.replace(boilerplateAppText, packageNameStylised);
-
-    write(templateDir, root, file, fileContent);
-}
-
-function writeViteConfig(templateDir, root, file, portFrontend, portBackend) {
-    let fileContent = fs.readFileSync(path.join(templateDir, file), fsOptions);
-
-    fileContent = fileContent.replace(9999999999, portFrontend)
-        .replace('[[PORTNUMBERBACKEND]]', portBackend);
-
-    write(templateDir, root, file, fileContent);
-}
-
-function write(templateDir, root, file, content) {
-    const targetPath = renameFiles[file] ?
-        path.join(root, renameFiles[file]) :
-        path.join(root, file);
-    if (content) {
-        fs.writeFileSync(targetPath, content);
-    } else {
-        copy(path.join(templateDir, file), targetPath);
-    }
-}
-
-function copy(src, dest) {
-    const stat = fs.statSync(src);
-    if (stat.isDirectory()) {
-        copyDir(src, dest);
-    } else {
-        fs.copyFileSync(src, dest);
-    }
-}
-
-function testScriptParams(targetDir, packageName, pkgManager, portFrontend, portBackend, autoRun) {
-    if (!targetDir) {
-        throw new Error(red('✖') + ' Missing target directory');
-    }
-
-    if (!packageName || !isValidPackageName(packageName)) {
-        throw new Error(red('✖') + ' A valid, hyphenated, lowercase project name (e.g. "lowercase-hyphenated-project-name") argument must be provided.');
-    }
-
-    if (pkgManager === 'error') {
-        throw new Error(red('✖') + ' The init script must be executed using yarn.');
-    }
-
-    if (!portFrontend || isNaN(Number(portFrontend))) {
-        throw new Error(red('✖') + ' The front-end port parameter is required and must be a number.');
-    }
-
-    if (!portBackend || isNaN(Number(portBackend))) {
-        throw new Error(red('✖') + ' The back-end port parameter is required and must be a number.');
-    }
-
-    let arBool = (autoRun.toString().toLowerCase() === 'true' ?
-        true :
-        (autoRun.toString().toLowerCase() === 'false' ?
-            false :
-            '')
-    );
-    if (typeof arBool !== 'boolean') {
-        throw new Error(red('✖') + ' The autoRun parameter must be present and a boolean value.');
-    }
-}
-
-function isValidPackageName(projectName) {
-    return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
-        projectName
-    );
-}
-
-function copyDir(srcDir, destDir) {
-    fs.mkdirSync(destDir, { recursive: true });
-    for (const file of fs.readdirSync(srcDir)) {
-        const srcFile = path.resolve(srcDir, file);
-        const destFile = path.resolve(destDir, file);
-        copy(srcFile, destFile);
-    }
-}
-
-function emptyDir(dir) {
-    if (!fs.existsSync(dir)) {
-        return;
-    }
-    for (const file of fs.readdirSync(dir)) {
-        const abs = path.resolve(dir, file);
-        // baseline is Node 12 so can't use rmSync :(
-        if (fs.lstatSync(abs).isDirectory()) {
-            emptyDir(abs);
-            fs.rmdirSync(abs);
-        } else {
-            fs.unlinkSync(abs);
-        }
-    }
-}
-
-function getFilesInFlatArray(path) {
-    const files = [];
-    for (const file of fs.readdirSync(path)) {
-        const fullPath = path + '/' + file;
-        if (fs.lstatSync(fullPath).isDirectory()) getFilesInFlatArray(fullPath).forEach(x => files.push(file + '/' + x));
-        else files.push(file);
-    }
-    return files;
-}
-
-function ensureFilesDoNotContainBoilerplateData() {
-    const files = getFilesInFlatArray(root);
-
-    for (const filePath of files) {
-        let oldFilePath = path.join(root, filePath);
-        let newFilePath = path.join(root, filePath);
-
-        if (!fs.lstatSync(oldFilePath).isDirectory()) {
-            if (newFilePath.indexOf(boilerplateAppText) > -1) {
-                newFilePath = newFilePath.replace(boilerplateAppText, packageName);
-                fs.renameSync(oldFilePath, newFilePath);
-            }
-    
-            let fileContent = fs.readFileSync(newFilePath, fsOptions);
-            if (fileContent && typeof fileContent === 'string') {
-                fileContent = fileContent.replaceAll(boilerplateAppText, packageName);
-            }
-
-            fs.writeFileSync(newFilePath, fileContent);
-        }
-    }
-}
-
-init().catch((e) => {
-    console.error(e);
-});