@aerogel/cli 0.0.0-next.47ed8ee3c048720794026e45140e9b700cb428b9

package/src/lib/File.ts

@@ -0,0 +1,70 @@
+import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'fs';
+import { facade } from '@noeldemartin/utils';
+import { dirname, resolve } from 'path';
+
+export class FileService {
+
+    public contains(path: string, contents: string): boolean {
+        return !!this.read(path)?.includes(contents);
+    }
+
+    public exists(path: string): boolean {
+        return existsSync(path);
+    }
+
+    public read(path: string): string | null {
+        if (!this.isFile(path)) {
+            return null;
+        }
+
+        return readFileSync(path).toString();
+    }
+
+    public getFiles(directoryPath: string): string[] {
+        const children = readdirSync(directoryPath, { withFileTypes: true });
+        const files: string[] = [];
+
+        for (const child of children) {
+            const path = resolve(directoryPath, child.name);
+
+            if (child.isDirectory()) {
+                files.push(...this.getFiles(path));
+            } else {
+                files.push(path);
+            }
+        }
+
+        return files;
+    }
+
+    public isDirectory(path: string): boolean {
+        return this.exists(path) && lstatSync(path).isDirectory();
+    }
+
+    public isFile(path: string): boolean {
+        return this.exists(path) && lstatSync(path).isFile();
+    }
+
+    public isEmptyDirectory(path: string): boolean {
+        if (!this.isDirectory(path)) {
+            return false;
+        }
+
+        return this.getFiles(path).length === 0;
+    }
+
+    public makeDirectory(path: string): void {
+        mkdirSync(path, { recursive: true });
+    }
+
+    public write(path: string, contents: string): void {
+        if (!existsSync(dirname(path))) {
+            mkdirSync(dirname(path), { recursive: true });
+        }
+
+        writeFileSync(path, contents);
+    }
+
+}
+
+export default facade(new FileService());

package/src/lib/Log.mock.ts

@@ -0,0 +1,28 @@
+import { expect } from 'vitest';
+import { arrayFrom, facade } from '@noeldemartin/utils';
+
+import { LogService } from './Log';
+
+export class LogServiceMock extends LogService {
+
+    private logs: string[] = [];
+
+    public expectLogged(message: string): void {
+        expect(this.logs, `Expected message "${message}" to have been logged`).toContain(message);
+    }
+
+    protected log(messages: string | string[]): void {
+        this.logs.push(...arrayFrom(messages));
+    }
+
+    public fail(message: string): void {
+        throw new Error(`Fail: ${message}`);
+    }
+
+    protected stdout(): void {
+        //
+    }
+
+}
+
+export default facade(new LogServiceMock());

package/src/lib/Log.test.ts

@@ -0,0 +1,21 @@
+import { bold, hex } from 'chalk';
+import { describe, it } from 'vitest';
+
+import LogMock from '@/lib/Log.mock';
+
+import Log from './Log';
+
+describe('Log', () => {
+
+    it('renders markdown bold', () => {
+        // Arrange
+        const info = hex('#00ffff');
+
+        // Act
+        Log.info('Foo **bar**');
+
+        // Assert
+        LogMock.expectLogged(info(`Foo ${bold('bar')}`));
+    });
+
+});

package/src/lib/Log.ts

@@ -0,0 +1,79 @@
+import { arrayFrom, facade, stringMatchAll } from '@noeldemartin/utils';
+import { bold, hex } from 'chalk';
+import { clearLine, cursorTo } from 'readline';
+
+export class LogService {
+
+    protected renderInfo = hex('#00ffff');
+    protected renderSuccess = hex('#00ff00');
+    protected renderError = hex('#ff0000');
+
+    public async animate<T>(message: string, operation: () => Promise<T>): Promise<T> {
+        const updateStdout = (end: string = '') => {
+            const progress = this.renderInfo(this.renderMarkdown(message) + '.'.repeat(frame % 4)) + end;
+
+            this.stdout(progress);
+        };
+
+        let frame = 0;
+
+        updateStdout();
+
+        const interval = setInterval(() => (frame++, updateStdout()), 1000);
+        const result = await operation();
+
+        clearInterval(interval);
+        updateStdout('\n');
+
+        return result;
+    }
+
+    public info(messages: string | string[]): void {
+        arrayFrom(messages).forEach((message) => {
+            this.log(this.renderInfo(this.renderMarkdown(message)));
+        });
+    }
+
+    public error(messages: string | string[]): void {
+        arrayFrom(messages).forEach((message) => {
+            this.log(this.renderError(this.renderMarkdown(message)));
+        });
+    }
+
+    public fail(messages: string | string[]): void {
+        this.error(messages);
+
+        process.exit(1);
+    }
+
+    public success(messages: string | string[]): void {
+        arrayFrom(messages).forEach((message) => {
+            this.log(this.renderSuccess(this.renderMarkdown(message)));
+        });
+    }
+
+    protected renderMarkdown(message: string): string {
+        const matches = stringMatchAll<2>(message, /\*\*(.*)\*\*/g);
+
+        for (const match of matches) {
+            message = message.replace(match[0], bold(match[1]));
+        }
+
+        return message;
+    }
+
+    protected log(messages: string | string[]): void {
+        // eslint-disable-next-line no-console
+        arrayFrom(messages).forEach((message) => console.log(message));
+    }
+
+    protected stdout(message: string): void {
+        cursorTo(process.stdout, 0);
+        clearLine(process.stdout, 0);
+
+        process.stdout.write(message);
+    }
+
+}
+
+export default facade(new LogService());

package/src/lib/Shell.mock.ts

@@ -0,0 +1,20 @@
+import { expect } from 'vitest';
+import { facade } from '@noeldemartin/utils';
+
+import { ShellService } from './Shell';
+
+export class ShellServiceMock extends ShellService {
+
+    private history: string[] = [];
+
+    public async run(command: string): Promise<void> {
+        this.history.push(command);
+    }
+
+    public expectRan(command: string): void {
+        expect(this.history, `expected '${command}' command to have been executed`).toContain(command);
+    }
+
+}
+
+export default facade(new ShellServiceMock());

package/src/lib/Shell.ts

@@ -0,0 +1,28 @@
+import { exec } from 'child_process';
+import { facade } from '@noeldemartin/utils';
+
+export class ShellService {
+
+    private cwd: string | null = null;
+
+    public setWorkingDirectory(cwd: string): void {
+        this.cwd = cwd;
+    }
+
+    public async run(command: string): Promise<void> {
+        await new Promise<void>((resolve, reject) => {
+            exec(command, { cwd: this.cwd ?? undefined }, (error) => {
+                if (error) {
+                    reject(error);
+
+                    return;
+                }
+
+                resolve();
+            });
+        });
+    }
+
+}
+
+export default facade(new ShellService());

package/src/lib/Template.ts

@@ -0,0 +1,56 @@
+import { readFileSync } from 'fs';
+import { render } from 'mustache';
+import { toString } from '@noeldemartin/utils';
+
+import File from '@/lib/File';
+
+export default class Template {
+
+    public static instantiate(path: string, destination: string, replacements: Record<string, unknown>): string[] {
+        const template = new Template(path);
+
+        return template.instantiate(destination, replacements);
+    }
+
+    constructor(public path: string) {}
+
+    public instantiate(destination: string, replacements: Record<string, unknown> = {}): string[] {
+        const filenameReplacements = this.getFilenameReplacements(replacements);
+        const files: string[] = [];
+        destination = `${destination}/`.replace(/\/\//, '/');
+
+        for (const file of File.getFiles(this.path)) {
+            const relativePath = Object.entries(filenameReplacements).reduce(
+                (path, [match, replacement]) => path.replaceAll(match, replacement),
+                file.substring(this.path.length + 1),
+            );
+            const fileContents = readFileSync(file).toString();
+            const filePath =
+                destination + (relativePath.endsWith('.template') ? relativePath.slice(0, -9) : relativePath);
+
+            File.write(filePath, render(fileContents, replacements, undefined, ['<%', '%>']));
+            files.push(filePath);
+        }
+
+        return files;
+    }
+
+    protected getFilenameReplacements(
+        replacements: Record<string, unknown>,
+        prefix: string = '',
+    ): Record<string, string> {
+        return Object.entries(replacements).reduce((filenameReplacements, [key, value]) => {
+            if (typeof value === 'object') {
+                Object.assign(
+                    filenameReplacements,
+                    this.getFilenameReplacements(value as Record<string, unknown>, `${key}.`),
+                );
+            } else {
+                filenameReplacements[`[${prefix}${key}]`] = toString(value);
+            }
+
+            return filenameReplacements;
+        }, {} as Record<string, string>);
+    }
+
+}

package/src/lib/utils.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from 'vitest';
+
+import { formatCodeBlock } from './utils';
+
+describe('Utils', () => {
+
+    it('Formats code blocks', () => {
+        // Arrange
+        const raw = `
+
+            const foo = 'bar';
+
+            if (foo) {
+                doSomething();
+            }
+
+        `;
+        const formatted = [
+            'const foo = \'bar\';', //
+            '', //
+            'if (foo) {', //
+            '    doSomething();', //
+            '}', //
+        ].join('\n');
+
+        // Act
+        const actual = formatCodeBlock(raw);
+
+        // Assert
+        expect(actual).toEqual(formatted);
+    });
+
+});

package/src/lib/utils.ts

@@ -0,0 +1,44 @@
+import { resolve } from 'path';
+
+export interface FormatCodeBlockOptions {
+    indent?: number;
+}
+
+export function basePath(path: string): string {
+    return resolve(__dirname, '../', path);
+}
+
+export function formatCodeBlock(code: string, options: FormatCodeBlockOptions = {}): string {
+    const lines = code.split('\n');
+    const indent = options.indent ?? 0;
+    let originalIndent = 0;
+    let formatted = '';
+
+    for (const line of lines) {
+        const trimmedLine = line.trim();
+        const isEmptyLine = trimmedLine.length === 0;
+
+        if (formatted.length === 0) {
+            if (isEmptyLine) {
+                continue;
+            }
+
+            originalIndent = line.indexOf(trimmedLine[0] ?? '');
+            formatted += `${' '.repeat(indent)}${trimmedLine}\n`;
+
+            continue;
+        }
+
+        if (isEmptyLine) {
+            formatted += '\n';
+
+            continue;
+        }
+
+        const lineIndent = line.indexOf(trimmedLine[0] ?? '');
+
+        formatted += `${' '.repeat(indent + lineIndent - originalIndent)}${trimmedLine}\n`;
+    }
+
+    return formatted.trimEnd();
+}

package/src/main.ts

@@ -0,0 +1,3 @@
+import CLI from './cli';
+
+export { CLI };

package/src/testing/setup.ts

@@ -0,0 +1,42 @@
+import { beforeEach, vi } from 'vitest';
+import { resolve } from 'path';
+import { setTestingNamespace } from '@noeldemartin/utils';
+
+import File from '@/lib/File';
+import FileMock from '@/lib/File.mock';
+import Log from '@/lib/Log';
+import LogMock from '@/lib/Log.mock';
+import Shell from '@/lib/Shell';
+import ShellMock from '@/lib/Shell.mock';
+
+setTestingNamespace(vi);
+
+File.setMockInstance(FileMock);
+Log.setMockInstance(LogMock);
+Shell.setMockInstance(ShellMock);
+
+beforeEach(() => {
+    FileMock.reset();
+    File.mock();
+    Log.mock();
+    Shell.mock();
+});
+
+// TODO find out why these need to be mocked
+
+vi.mock('@/lib/utils', async () => {
+    const utils = (await vi.importActual('@/lib/utils')) as object;
+
+    return {
+        ...utils,
+        basePath(path: string) {
+            return resolve(__dirname, '../../', path);
+        },
+    };
+});
+
+vi.mock('mustache', async () => {
+    const mustache = (await vi.importActual('mustache')) as { default: unknown };
+
+    return mustache.default;
+});

package/src/types/ts-reset.d.ts

@@ -0,0 +1 @@
+/// <reference types="@total-typescript/ts-reset" />

package/templates/app/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+    ci:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version-file: '.nvmrc'
+            - run: npm ci
+            - run: npm run lint
+            - run: npm run test:ci
+            - run: npm run cy:test
+            - run: npm run build

package/templates/app/.gitignore.template

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

package/templates/app/.nvmrc

@@ -0,0 +1 @@
+lts/hydrogen

package/templates/app/cypress/e2e/app.cy.ts

@@ -0,0 +1,9 @@
+describe('App', () => {
+
+    beforeEach(() => cy.visit('/'));
+
+    it('Shows get started link', () => {
+        cy.see('Get started');
+    });
+
+});

package/templates/app/cypress/support/e2e.ts

@@ -0,0 +1,3 @@
+import install from '@aerogel/cypress';
+
+install();

package/templates/app/cypress/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "lib": ["es5", "dom"],
+        "types": ["cypress", "node"],
+        "baseUrl": ".",
+        "paths": {
+            "@cy/*": ["./*"]
+        }
+    },
+    "include": ["**/*.ts"]
+}

package/templates/app/cypress.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+    e2e: {
+        baseUrl: 'http://localhost:5001',
+        video: false,
+    },
+});

package/templates/app/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en" class="h-full w-full">
+    <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title><% app.name %></title>
+    </head>
+    <body class="h-full w-full">
+        <div id="app" class="h-full"></div>
+        <script type="module" src="./src/main.ts"></script>
+    </body>
+</html>

package/templates/app/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "<% app.slug %>",
+    "version": "0.0.0",
+    "private": true,
+    "scripts": {
+        "build": "vite build",
+        "cy:dev": "concurrently --kill-others \"npm run test:serve-app\" \"npm run cy:open\"",
+        "cy:open": "cypress open --e2e --browser chromium",
+        "cy:run": "cypress run",
+        "cy:test": "start-server-and-test test:serve-app http-get://localhost:5001 cy:run",
+        "dev": "vite",
+        "lint": "noeldemartin-lint src",
+        "test": "vitest --run",
+        "test:ci": "vitest --run --reporter verbose",
+        "test:serve-app": "vite --port 5001"
+    },
+    "dependencies": {
+        "@aerogel/core": "next",
+        "@aerogel/plugin-i18n": "next",
+        "@intlify/unplugin-vue-i18n": "^0.12.2",
+        "@tailwindcss/forms": "^0.5.3",
+        "@tailwindcss/typography": "^0.5.9",
+        "soukai": "^0.5.1",
+        "tailwindcss": "^3.3.2",
+        "vue": "^3.3.0",
+        "vue-i18n": "9.3.0-beta.19",
+        "vue-router": "^4.2.1"
+    },
+    "devDependencies": {
+        "@aerogel/cli": "next",
+        "@aerogel/cypress": "next",
+        "@aerogel/vite": "next",
+        "@noeldemartin/utils": "0.4.0-next.ac00beaecf32bb02ed8e335225d7948d946d73bd",
+        "@total-typescript/ts-reset": "^0.4.2",
+        "@types/node": "^20.3.1",
+        "autoprefixer": "^10.4.14",
+        "concurrently": "^8.2.0",
+        "cypress": "^12.17.0",
+        "start-server-and-test": "^2.0.0",
+        "unplugin-vue-components": "^0.24.1",
+        "vite": "^4.3.0",
+        "vitest": "^0.33.0"
+    }
+}

package/templates/app/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: {
+        tailwindcss: {},
+        autoprefixer: {},
+    },
+};

package/templates/app/src/App.vue

@@ -0,0 +1,10 @@
+<template>
+    <AGAppLayout>
+        <main class="flex flex-grow flex-col items-center justify-center bg-blue-50">
+            <h1 class="text-4xl font-semibold">{{ $t('home.title') }}</h1>
+            <a href="https://aerogel.js.org" target="_blank" class="mt-2 underline opacity-75 hover:opacity-100">
+                {{ $t('home.getStarted') }}
+            </a>
+        </main>
+    </AGAppLayout>
+</template>

package/templates/app/src/assets/styles.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

package/templates/app/src/lang/en.yaml

@@ -0,0 +1,3 @@
+home:
+  title: Aerogel
+  getStarted: Get started

package/templates/app/src/main.test.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest';
+
+describe('App', () => {
+
+    it('works', () => {
+        expect(true).toBe(true);
+    });
+
+});

package/templates/app/src/main.ts

@@ -0,0 +1,9 @@
+import i18n from '@aerogel/plugin-i18n';
+import { bootstrapApplication } from '@aerogel/core';
+
+import './assets/styles.css';
+import App from './App.vue';
+
+bootstrapApplication(App, {
+    plugins: [i18n({ messages: import.meta.glob('@/lang/*.yaml') })],
+});

package/templates/app/src/types/globals.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="vite/client" />
+/// <reference types="vue-router" />
+/// <reference types="vue-i18n" />

package/templates/app/src/types/shims.d.ts

@@ -0,0 +1,7 @@
+declare module '*.vue' {
+    import type { ComponentOptions } from 'vue';
+
+    const component: ComponentOptions;
+
+    export default component;
+}

package/templates/app/src/types/ts-reset.d.ts

@@ -0,0 +1 @@
+/// <reference types="@total-typescript/ts-reset" />

package/templates/app/tailwind.config.js

@@ -0,0 +1,5 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    content: ['./index.html', './src/**/*.{vue,ts}', '../core/src/**/*.{vue,ts}'],
+    plugins: [require('@tailwindcss/forms'), require('@tailwindcss/typography')],
+};

package/templates/app/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "module": "esnext",
+        "moduleResolution": "node",
+        "strict": true,
+        "jsx": "preserve",
+        "noUncheckedIndexedAccess": true,
+        "resolveJsonModule": true,
+        "esModuleInterop": true,
+        "lib": ["esnext", "dom"],
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["./src/*"]
+        }
+    },
+    "include": ["src/**/*.ts", "src/**/*.vue"]
+}