@aerogel/cli 0.0.0-next.c8f032a868370824898e171969aec1bb6827688e → 0.0.0-next.f16bd1d894543c5303039c49f6f33488a1ffe931

package/src/lib/utils/edit.ts

@@ -0,0 +1,44 @@
+import { arrayFrom } from '@noeldemartin/utils';
+import type { Node, SyntaxKind } from 'ts-morph';
+
+export function editFiles(): boolean {
+    // TODO mock editor instead of relying on this for unit tests
+    return true;
+}
+
+export function findDescendant<T extends Node>(
+    node: Node | undefined,
+    options: {
+        guard?: (node: Node | undefined) => node is T;
+        validate?: (node: T) => boolean;
+        skip?: SyntaxKind | SyntaxKind[];
+    } = {},
+): T | undefined {
+    if (!node) {
+        return;
+    }
+
+    const guard = options.guard ?? (() => true);
+    const validate = options.validate ?? (() => true);
+    const skipKinds = arrayFrom(options.skip ?? []);
+
+    return node.forEachDescendant((descendant, traversal) => {
+        if (guard(descendant) && validate(descendant)) {
+            return descendant;
+        }
+
+        const descendantKind = descendant.getKind();
+
+        if (skipKinds.includes(descendantKind)) {
+            traversal.skip();
+        }
+    });
+}
+
+export function when<T extends Node>(node: Node | undefined, assertion: (node: Node) => node is T): T | undefined {
+    if (!node || !assertion(node)) {
+        return;
+    }
+
+    return node as T;
+}

package/src/lib/{utils.test.ts → utils/format.test.ts}

@@ -1,8 +1,8 @@
 import { describe, expect, it } from 'vitest';
 
-import { formatCodeBlock } from './utils';
+import { formatCodeBlock } from './format';
 
-describe('Utils', () => {
+describe('Format utils', () => {
 
     it('Formats code blocks', () => {
         // Arrange

package/src/lib/{utils.ts → utils/format.ts}

@@ -1,13 +1,7 @@
-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;

package/src/lib/utils/paths.ts

@@ -0,0 +1,34 @@
+import { resolve } from 'path';
+import { stringMatch } from '@noeldemartin/utils';
+
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+
+export function basePath(path: string = ''): string {
+    if (File.contains(resolve(__dirname, '../../../package.json'), '"name": "aerogel"')) {
+        return resolve(__dirname, '../', path);
+    }
+
+    const packageJson = File.read(resolve(__dirname, '../../../../package.json'));
+    const matches = stringMatch<2>(packageJson ?? '', /"@aerogel\/cli": "file:(.*)\/aerogel-cli-[\d.]*\.tgz"/);
+    const cliPath = matches?.[1] ?? Log.fail<string>('Could not determine base path');
+
+    return resolve(cliPath, path);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function packNotFound(packageName: string): any {
+    return Log.fail(`Could not find ${packageName} pack file, did you run 'npm pack'?`);
+}
+
+export function packagePackPath(packageName: string): string | null {
+    return File.getFiles(packagePath(packageName)).find((file) => file.endsWith('.tgz')) ?? null;
+}
+
+export function packagePath(packageName: string): string {
+    return basePath(`../${packageName}`);
+}
+
+export function templatePath(name: string): string {
+    return resolve(__dirname, `../templates/${name}`);
+}

package/src/plugins/Plugin.ts

@@ -0,0 +1,125 @@
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ArrayLiteralExpression, ImportDeclarationStructure, OptionalKind, SourceFile } from 'ts-morph';
+
+import Log from '@/lib/Log';
+import Shell from '@/lib/Shell';
+import File from '@/lib/File';
+import { app, isLinkedLocalApp, isLocalApp } from '@/lib/utils/app';
+import { editFiles, findDescendant, when } from '@/lib/utils/edit';
+import { packNotFound, packagePackPath, packagePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export default abstract class Plugin {
+
+    public readonly name: string;
+
+    constructor(name: string) {
+        this.name = name;
+    }
+
+    public async install(): Promise<void> {
+        this.assertNotInstalled();
+
+        await this.installDependencies();
+
+        if (editFiles()) {
+            const editor = app().edit();
+
+            await this.updateFiles(editor);
+            await editor.format();
+        }
+
+        Log.info(`Plugin ${this.name} installed!`);
+    }
+
+    protected assertNotInstalled(): void {
+        if (File.contains('package.json', `"${this.getNpmPackageName()}"`)) {
+            Log.fail(`${this.name} is already installed!`);
+        }
+    }
+
+    protected async installDependencies(): Promise<void> {
+        await Log.animate('Installing plugin dependencies', async () => {
+            await this.installNpmDependencies();
+        });
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateBootstrapConfig(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        if (isLinkedLocalApp()) {
+            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())}`);
+
+            return;
+        }
+
+        if (isLocalApp()) {
+            const packPath = packagePackPath(this.getLocalPackageName()) ?? packNotFound(this.getLocalPackageName());
+
+            await Shell.run(`npm install file:${packPath}`);
+
+            return;
+        }
+
+        await Shell.run(`npm install ${this.getNpmPackageName()}@next --save-exact`);
+    }
+
+    protected async updateBootstrapConfig(editor: Editor): Promise<void> {
+        await Log.animate('Injecting plugin in bootstrap configuration', async () => {
+            const mainConfig = editor.requireSourceFile('src/main.ts');
+            const pluginsArray = this.getBootstrapPluginsDeclaration(mainConfig);
+
+            if (!pluginsArray) {
+                return Log.fail(`
+                    Could not find plugins array in bootstrap config, please add the following manually:
+
+                    ${this.getBootstrapConfig()}
+                `);
+            }
+
+            mainConfig.addImportDeclaration(this.getBootstrapImport());
+            pluginsArray.addElement(this.getBootstrapConfig());
+
+            await editor.save(mainConfig);
+        });
+    }
+
+    protected getBootstrapPluginsDeclaration(mainConfig: SourceFile): ArrayLiteralExpression | null {
+        const bootstrapAppCall = findDescendant(mainConfig, {
+            guard: Node.isCallExpression,
+            validate: (callExpression) => callExpression.getExpression().getText() === 'bootstrapApplication',
+            skip: SyntaxKind.ImportDeclaration,
+        });
+        const bootstrapOptions = bootstrapAppCall?.getArguments()[1];
+        const pluginsOption = when(bootstrapOptions, Node.isObjectLiteralExpression)?.getProperty('plugins');
+        const pluginsArray = when(pluginsOption, Node.isPropertyAssignment)?.getInitializer();
+
+        if (!Node.isArrayLiteralExpression(pluginsArray)) {
+            return null;
+        }
+
+        return pluginsArray;
+    }
+
+    protected getBootstrapImport(): OptionalKind<ImportDeclarationStructure> {
+        return {
+            defaultImport: this.name,
+            moduleSpecifier: `@aerogel/plugin-${this.name}`,
+        };
+    }
+
+    protected getNpmPackageName(): string {
+        return `@aerogel/${this.getLocalPackageName()}`;
+    }
+
+    protected getLocalPackageName(): string {
+        return `plugin-${this.name}`;
+    }
+
+    protected getBootstrapConfig(): string {
+        return `${this.name}()`;
+    }
+
+}

package/src/plugins/Solid.ts

@@ -0,0 +1,65 @@
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ArrayLiteralExpression, SourceFile } from 'ts-morph';
+
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+import Log from '@/lib/Log';
+import { findDescendant } from '@/lib/utils/edit';
+import { isLinkedLocalApp } from '@/lib/utils/app';
+import { packagePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export class Solid extends Plugin {
+
+    constructor() {
+        super('solid');
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateTailwindConfig(editor);
+        await super.updateFiles(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        await Shell.run('npm install soukai-solid@next --save-exact');
+        await super.installNpmDependencies();
+    }
+
+    protected async updateTailwindConfig(editor: Editor): Promise<void> {
+        await Log.animate('Updating tailwind configuration', async () => {
+            const tailwindConfig = editor.requireSourceFile('tailwind.config.js');
+            const contentArray = this.getTailwindContentArray(tailwindConfig);
+            const contentValue = isLinkedLocalApp()
+                ? `'${packagePath('plugin-solid')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/plugin-solid/dist/**/*.js\'';
+
+            if (!contentArray) {
+                return Log.fail(`
+                    Could not find content array in tailwind config, please add the following manually:
+
+                    ${contentValue}
+                `);
+            }
+
+            contentArray.addElement(contentValue);
+
+            await editor.save(tailwindConfig);
+        });
+    }
+
+    protected getTailwindContentArray(tailwindConfig: SourceFile): ArrayLiteralExpression | null {
+        const contentAssignment = findDescendant(tailwindConfig, {
+            guard: Node.isPropertyAssignment,
+            validate: (propertyAssignment) => propertyAssignment.getName() === 'content',
+            skip: SyntaxKind.JSDoc,
+        });
+        const contentArray = contentAssignment?.getInitializer();
+
+        if (!Node.isArrayLiteralExpression(contentArray)) {
+            return null;
+        }
+
+        return contentArray;
+    }
+
+}

package/src/plugins/Soukai.ts

@@ -0,0 +1,19 @@
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+
+export class Soukai extends Plugin {
+
+    constructor() {
+        super('soukai');
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        await Shell.run('npm install soukai@next --save-exact');
+        await super.installNpmDependencies();
+    }
+
+    protected getBootstrapConfig(): string {
+        return 'soukai({ models: import.meta.glob(\'@/models/*\', { eager: true }) })';
+    }
+
+}

package/src/testing/setup.ts

@@ -17,21 +17,53 @@ Shell.setMockInstance(ShellMock);
 
 beforeEach(() => {
     FileMock.reset();
+    LogMock.reset();
+
     File.mock();
     Log.mock();
     Shell.mock();
 });
 
+vi.mock('@/lib/utils/app', async () => {
+    const original = (await vi.importActual('@/lib/utils/app')) as object;
+
+    return {
+        ...original,
+        isLocalApp: () => false,
+        isLinkedLocalApp: () => false,
+    };
+});
+
+vi.mock('@/lib/utils/edit', async () => {
+    const original = (await vi.importActual('@/lib/utils/edit')) as object;
+
+    return {
+        ...original,
+        editFiles: () => false,
+    };
+});
+
 // TODO find out why these need to be mocked
+vi.mock('@/lib/utils/paths', async () => {
+    const original = (await vi.importActual('@/lib/utils/paths')) as object;
+
+    function basePath(path: string = '') {
+        return resolve(__dirname, '../../', path);
+    }
+
+    function packagePath(packageName: string) {
+        return basePath(`../${packageName}`);
+    }
 
-vi.mock('@/lib/utils', async () => {
-    const utils = (await vi.importActual('@/lib/utils')) as object;
+    function templatePath(name: string = '') {
+        return resolve(__dirname, `../../templates/${name}`);
+    }
 
     return {
-        ...utils,
-        basePath(path: string) {
-            return resolve(__dirname, '../../', path);
-        },
+        ...original,
+        basePath,
+        packagePath,
+        templatePath,
     };
 });
 

package/templates/app/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['@noeldemartin/eslint-config-vue'],
+};

package/templates/app/.gitignore.template

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

package/templates/app/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug Current Test File",
+            "autoAttachChildProcesses": true,
+            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+            "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+            "args": ["run", "${fileBasenameNoExtension}"],
+            "smartStep": true,
+            "console": "integratedTerminal"
+        }
+    ]
+}

package/templates/app/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "emeraldwalk.runonsave": {
+        "commands": [
+            {
+                "match": ".*",
+                "cmd": "npx prettier-eslint ${file} --write"
+            }
+        ]
+    }
+}

package/templates/app/cypress.config.ts

@@ -1,8 +1,12 @@
+import install from '@aerogel/cypress/dist/plugin';
 import { defineConfig } from 'cypress';
 
 export default defineConfig({
     e2e: {
         baseUrl: 'http://localhost:5001',
         video: false,
+        setupNodeEvents(on) {
+            install(on);
+        },
     },
 });

package/templates/app/index.html

@@ -5,7 +5,7 @@
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
         <title><% app.name %></title>
     </head>
-    <body class="h-full w-full">
+    <body class="h-full w-full text-base font-normal leading-tight text-gray-900 antialiased">
         <div id="app" class="h-full"></div>
         <script type="module" src="./src/main.ts"></script>
     </body>

package/templates/app/package.json

@@ -8,6 +8,8 @@
         "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",
+        "cy:test-snapshots": "docker run -it -u `id -u ${whoami}` -e CYPRESS_SNAPSHOTS=true -v ./:/app -w /app cypress/base:18.16.0 sh -c \"npx cypress install && npm run cy:test\"",
+        "cy:test-snapshots:ci": "docker run -e CYPRESS_SNAPSHOTS=true -v ./:/app -w /app cypress/base:18.16.0 sh -c \"npx cypress install && npm run cy:test\"",
         "dev": "vite",
         "lint": "noeldemartin-lint src",
         "test": "vitest --run",
@@ -15,30 +17,38 @@
         "test:serve-app": "vite --port 5001"
     },
     "dependencies": {
-        "@aerogel/core": "next",
-        "@aerogel/plugin-i18n": "next",
+        "@aerogel/core": "<% &dependencies.aerogelCore %>",
+        "@aerogel/plugin-i18n": "<% &dependencies.aerogelPluginI18n %>",
+        "@aerogel/plugin-soukai": "<% &dependencies.aerogelPluginSoukai %>",
         "@intlify/unplugin-vue-i18n": "^0.12.2",
+        "@noeldemartin/utils": "next",
         "@tailwindcss/forms": "^0.5.3",
         "@tailwindcss/typography": "^0.5.9",
-        "soukai": "^0.5.1",
+        "soukai": "next",
         "tailwindcss": "^3.3.2",
         "vue": "^3.3.0",
-        "vue-i18n": "9.3.0-beta.19",
-        "vue-router": "^4.2.1"
+        "vue-i18n": "9.3.0-beta.19"
     },
     "devDependencies": {
-        "@aerogel/cli": "next",
-        "@aerogel/cypress": "next",
-        "@aerogel/vite": "next",
-        "@noeldemartin/utils": "0.4.0-next.ac00beaecf32bb02ed8e335225d7948d946d73bd",
+        "@aerogel/cli": "<% &dependencies.aerogelCli %>",
+        "@aerogel/cypress": "<% &dependencies.aerogelCypress %>",
+        "@aerogel/vite": "<% &dependencies.aerogelVite %>",
+        "@noeldemartin/eslint-config-vue": "next",
+        "@noeldemartin/scripts": "next",
         "@total-typescript/ts-reset": "^0.4.2",
         "@types/node": "^20.3.1",
         "autoprefixer": "^10.4.14",
         "concurrently": "^8.2.0",
         "cypress": "^12.17.0",
+        "eslint": "^8.40.0",
+        "prettier": "^2.8.8",
+        "prettier-eslint-cli": "^7.1.0",
+        "prettier-plugin-tailwindcss": "^0.2.8",
         "start-server-and-test": "^2.0.0",
+        "unplugin-icons": "^0.16.3",
         "unplugin-vue-components": "^0.24.1",
         "vite": "^4.3.0",
-        "vitest": "^0.33.0"
+        "vitest": "^0.33.0",
+        "vue-tsc": "^1.8.15"
     }
 }

package/templates/app/prettier.config.js

@@ -0,0 +1,5 @@
+/** @type {import('prettier').Config} */
+module.exports = {
+    plugins: [require('prettier-plugin-tailwindcss')],
+    printWidth: 120,
+};

package/templates/app/src/App.vue

@@ -1,7 +1,9 @@
 <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>
+            <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>

package/templates/app/src/main.ts

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

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

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

package/templates/app/tailwind.config.js

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

package/templates/app/vite.config.ts

@@ -1,21 +1,24 @@
 import Aerogel, { AerogelResolver } from '@aerogel/vite';
 import Components from 'unplugin-vue-components/vite';
 import I18n from '@intlify/unplugin-vue-i18n/vite';
+import Icons from 'unplugin-icons/vite';
+import IconsResolver from 'unplugin-icons/resolver';
+import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
-export default {
+export default defineConfig({
     plugins: [
-        I18n({ include: resolve(__dirname, './src/lang/**/*.yaml') }),
         Aerogel(),
         Components({
-            dirs: ['src/pages'],
             dts: false,
-            resolvers: [AerogelResolver()],
+            resolvers: [AerogelResolver(), IconsResolver()],
         }),
+        I18n({ include: resolve(__dirname, './src/lang/**/*.yaml') }),
+        Icons(),
     ],
     resolve: {
         alias: {
             '@': resolve(__dirname, './src'),
         },
     },
-};
+});

package/templates/service/[service.name].ts

@@ -0,0 +1,8 @@
+import { Service } from '@aerogel/core';
+import { facade } from '@noeldemartin/utils';
+
+export class <% service.name %>Service extends Service {
+
+}
+
+export default facade(new <% service.name %>Service());

package/noeldemartin.config.js

@@ -1,4 +0,0 @@
-/** @type {import('@noeldemartin/scripts').Config} */
-module.exports = {
-    external: ['fs', '@noeldemartin/utils', 'chalk', 'child_process', 'commander', 'mustache', 'path', 'readline'],
-};