@aerogel/cli 0.0.0-next.b85327579d32f21c6a9fa21142f0165cdd320d7e → 0.0.0-next.bf95405357e75d2e8b0268a5e8ce7b2b7dd0c895

package/src/lib/Log.mock.ts

@@ -15,23 +15,19 @@ export class LogServiceMock extends LogService {
         expect(this.logs, `Expected log to have length ${count}`).toHaveLength(count);
     }
 
-    protected logLine(message: string): void {
+    protected override logLine(message: string): void {
         this.logs.push(message);
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public fail<T = any>(message: string): T {
+    public override fail<T = any>(message: string): T {
         throw new Error(`Fail: ${message}`);
     }
 
-    public reset(): void {
-        this.logs = [];
-    }
-
-    protected stdout(): void {
+    protected override stdout(): void {
         //
     }
 
 }
 
-export default facade(new LogServiceMock());
+export default facade(LogServiceMock);

package/src/lib/Log.test.ts

@@ -1,11 +1,11 @@
-import { bold, hex } from 'chalk';
+import chalk from 'chalk';
 import { describe, it } from 'vitest';
 
-import LogMock from '@/lib/Log.mock';
+import LogMock from '@aerogel/cli/lib/Log.mock';
 
 import Log from './Log';
 
-const info = hex('#00ffff');
+const info = chalk.hex('#00ffff');
 
 describe('Log', () => {
 
@@ -14,7 +14,7 @@ describe('Log', () => {
         Log.info('Foo **bar**');
 
         // Assert
-        LogMock.expectLogged(info(`Foo ${bold('bar')}`));
+        LogMock.expectLogged(info(`Foo ${chalk.bold('bar')}`));
     });
 
     it('renders multiline messages', () => {

package/src/lib/Log.ts

@@ -1,12 +1,12 @@
+import chalk from 'chalk';
+import { clearLine, cursorTo } from 'node:readline';
 import { 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');
+    protected renderInfo = chalk.hex('#00ffff');
+    protected renderSuccess = chalk.hex('#00ff00');
+    protected renderError = chalk.hex('#ff0000');
 
     public async animate<T>(message: string, operation: () => Promise<T>): Promise<T> {
         const updateStdout = (end: string = '', done: boolean = false) => {
@@ -52,7 +52,7 @@ export class LogService {
         const matches = stringMatchAll<2>(message, /\*\*(.*)\*\*/g);
 
         for (const match of matches) {
-            message = message.replace(match[0], bold(match[1]));
+            message = message.replace(match[0], chalk.bold(match[1]));
         }
 
         return message;
@@ -92,4 +92,4 @@ export class LogService {
 
 }
 
-export default facade(new LogService());
+export default facade(LogService);

package/src/lib/Shell.mock.ts

@@ -7,8 +7,8 @@ export class ShellServiceMock extends ShellService {
 
     private history: string[] = [];
 
-    public async run(command: string): Promise<void> {
-        this.history.push(command);
+    public override async run(command: string): Promise<void> {
+        this.history.push(command.trim());
     }
 
     public expectRan(command: string): void {
@@ -17,4 +17,4 @@ export class ShellServiceMock extends ShellService {
 
 }
 
-export default facade(new ShellServiceMock());
+export default facade(ShellServiceMock);

package/src/lib/Shell.ts

@@ -1,4 +1,4 @@
-import { exec } from 'child_process';
+import { exec } from 'node:child_process';
 import { facade } from '@noeldemartin/utils';
 
 export class ShellService {
@@ -25,4 +25,4 @@ export class ShellService {
 
 }
 
-export default facade(new ShellService());
+export default facade(ShellService);

package/src/lib/Template.ts

@@ -1,12 +1,16 @@
-import { readFileSync } from 'fs';
-import { render } from 'mustache';
+import Mustache from 'mustache';
+import { readFileSync } from 'node:fs';
 import { toString } from '@noeldemartin/utils';
 
-import File from '@/lib/File';
+import File from '@aerogel/cli/lib/File';
 
 export default class Template {
 
-    public static instantiate(path: string, destination: string, replacements: Record<string, unknown>): string[] {
+    public static instantiate(
+        path: string,
+        destination: string = './',
+        replacements: Record<string, unknown> = {},
+    ): string[] {
         const template = new Template(path);
 
         return template.instantiate(destination, replacements);
@@ -28,7 +32,7 @@ export default class Template {
             const filePath =
                 destination + (relativePath.endsWith('.template') ? relativePath.slice(0, -9) : relativePath);
 
-            File.write(filePath, render(fileContents, replacements, undefined, ['<%', '%>']));
+            File.write(filePath, Mustache.render(fileContents, replacements, undefined, ['<%', '%>']));
             files.push(filePath);
         }
 
@@ -39,18 +43,21 @@ export default class Template {
         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>);
+        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/app.ts

@@ -1,5 +1,5 @@
-import App from '@/lib/App';
-import File from '@/lib/File';
+import App from '@aerogel/cli/lib/App';
+import File from '@aerogel/cli/lib/File';
 
 export function app(): App {
     // TODO parse app name
@@ -7,7 +7,7 @@ export function app(): App {
 }
 
 export function isLocalApp(): boolean {
-    return File.contains('package.json', 'file');
+    return File.contains('package.json', '"@aerogel/core": "file:');
 }
 
 export function isLinkedLocalApp(): boolean {

package/src/lib/utils/edit.ts

@@ -23,8 +23,8 @@ export function findDescendant<T extends Node>(
     const skipKinds = arrayFrom(options.skip ?? []);
 
     return node.forEachDescendant((descendant, traversal) => {
-        if (guard(descendant) && validate(descendant)) {
-            return descendant;
+        if (guard(descendant) && validate(descendant as T)) {
+            return descendant as T;
         }
 
         const descendantKind = descendant.getKind();

package/src/lib/utils/paths.ts

@@ -1,16 +1,24 @@
-import { resolve } from 'path';
+import { URL, fileURLToPath } from 'node:url';
 import { stringMatch } from '@noeldemartin/utils';
+import { resolve } from 'node:path';
 
-import File from '@/lib/File';
-import Log from '@/lib/Log';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
 
 export function basePath(path: string = ''): string {
-    if (File.contains(resolve(__dirname, '../../../package.json'), '"name": "aerogel"')) {
-        return resolve(__dirname, '../', path);
+    if (
+        File.contains(
+            fileURLToPath(new URL(/* @vite-ignore */ '../../../package.json', import.meta.url)),
+            '"packages/create-aerogel"',
+        )
+    ) {
+        return resolve(fileURLToPath(new URL(/* @vite-ignore */ '../', import.meta.url)), path);
     }
 
-    const packageJson = File.read(resolve(__dirname, '../../../../package.json'));
-    const matches = stringMatch<2>(packageJson ?? '', /"@aerogel\/cli": "file:(.*)\/aerogel-cli-[\d.]*\.tgz"/);
+    const packageJson = File.read(
+        fileURLToPath(new URL(/* @vite-ignore */ '../../../../package.json', import.meta.url)),
+    );
+    const matches = stringMatch<2>(packageJson ?? '', /"@aerogel\/core": "file:(.*)\/aerogel-core-[\d.]*\.tgz"/);
     const cliPath = matches?.[1] ?? Log.fail<string>('Could not determine base path');
 
     return resolve(cliPath, path);
@@ -28,3 +36,7 @@ export function packagePackPath(packageName: string): string | null {
 export function packagePath(packageName: string): string {
     return basePath(`../${packageName}`);
 }
+
+export function templatePath(name: string): string {
+    return fileURLToPath(new URL(/* @vite-ignore */ `../templates/${name}`, import.meta.url));
+}

package/src/plugins/Plugin.ts

@@ -1,13 +1,13 @@
 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';
+import Log from '@aerogel/cli/lib/Log';
+import Shell from '@aerogel/cli/lib/Shell';
+import File from '@aerogel/cli/lib/File';
+import { app, isLinkedLocalApp, isLocalApp } from '@aerogel/cli/lib/utils/app';
+import { editFiles, findDescendant, when } from '@aerogel/cli/lib/utils/edit';
+import { packNotFound, packagePackPath, packagePath } from '@aerogel/cli/lib/utils/paths';
+import type { Editor } from '@aerogel/cli/lib/Editor';
 
 export default abstract class Plugin {
 
@@ -20,6 +20,7 @@ export default abstract class Plugin {
     public async install(): Promise<void> {
         this.assertNotInstalled();
 
+        await this.beforeInstall();
         await this.installDependencies();
 
         if (editFiles()) {
@@ -29,6 +30,8 @@ export default abstract class Plugin {
             await editor.format();
         }
 
+        await this.afterInstall();
+
         Log.info(`Plugin ${this.name} installed!`);
     }
 
@@ -38,6 +41,14 @@ export default abstract class Plugin {
         }
     }
 
+    protected async beforeInstall(): Promise<void> {
+        // Placeholder for overrides, don't place any functionality here.
+    }
+
+    protected async afterInstall(): Promise<void> {
+        // Placeholder for overrides, don't place any functionality here.
+    }
+
     protected async installDependencies(): Promise<void> {
         await Log.animate('Installing plugin dependencies', async () => {
             await this.installNpmDependencies();
@@ -45,12 +56,16 @@ export default abstract class Plugin {
     }
 
     protected async updateFiles(editor: Editor): Promise<void> {
-        await this.updateBootstrapConfig(editor);
+        if (!this.isForDevelopment()) {
+            await this.updateBootstrapConfig(editor);
+        }
     }
 
     protected async installNpmDependencies(): Promise<void> {
+        const flags = this.isForDevelopment() ? '--save-dev' : '';
+
         if (isLinkedLocalApp()) {
-            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())}`);
+            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())} ${flags}`);
 
             return;
         }
@@ -58,12 +73,12 @@ export default abstract class Plugin {
         if (isLocalApp()) {
             const packPath = packagePackPath(this.getLocalPackageName()) ?? packNotFound(this.getLocalPackageName());
 
-            await Shell.run(`npm install file:${packPath}`);
+            await Shell.run(`npm install file:${packPath} ${flags}`);
 
             return;
         }
 
-        await Shell.run(`npm install ${this.getNpmPackageName()}@next`);
+        await Shell.run(`npm install ${this.getNpmPackageName()}@next --save-exact ${flags}`);
     }
 
     protected async updateBootstrapConfig(editor: Editor): Promise<void> {
@@ -89,7 +104,7 @@ export default abstract class Plugin {
     protected getBootstrapPluginsDeclaration(mainConfig: SourceFile): ArrayLiteralExpression | null {
         const bootstrapAppCall = findDescendant(mainConfig, {
             guard: Node.isCallExpression,
-            validate: (callExpression) => callExpression.getExpression().getText() === 'bootstrapApplication',
+            validate: (callExpression) => callExpression.getExpression().getText() === 'bootstrap',
             skip: SyntaxKind.ImportDeclaration,
         });
         const bootstrapOptions = bootstrapAppCall?.getArguments()[1];
@@ -103,6 +118,21 @@ export default abstract class Plugin {
         return pluginsArray;
     }
 
+    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;
+    }
+
     protected getBootstrapImport(): OptionalKind<ImportDeclarationStructure> {
         return {
             defaultImport: this.name,
@@ -118,6 +148,10 @@ export default abstract class Plugin {
         return `plugin-${this.name}`;
     }
 
+    protected isForDevelopment(): boolean {
+        return false;
+    }
+
     protected getBootstrapConfig(): string {
         return `${this.name}()`;
     }

package/src/plugins/Solid.ts

@@ -1,13 +1,8 @@
-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';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Plugin from '@aerogel/cli/plugins/Plugin';
+import Shell from '@aerogel/cli/lib/Shell';
+import type { Editor } from '@aerogel/cli/lib/Editor';
 
 export class Solid extends Plugin {
 
@@ -15,51 +10,62 @@ export class Solid extends Plugin {
         super('solid');
     }
 
-    protected async updateFiles(editor: Editor): Promise<void> {
-        await this.updateTailwindConfig(editor);
+    protected override async updateFiles(editor: Editor): Promise<void> {
+        await this.updateNpmScripts(editor);
+        await this.updateGitIgnore();
         await super.updateFiles(editor);
     }
 
-    protected async installNpmDependencies(): Promise<void> {
-        await Shell.run('npm install soukai-solid@next');
+    protected override async installNpmDependencies(): Promise<void> {
+        await Shell.run('npm install soukai-solid@next --save-exact');
+        await Shell.run('npm install @noeldemartin/solid-utils@next --save-exact');
+        await Shell.run('npm install @solid/community-server@7.1.6 --save-dev -E');
         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\'';
+    protected async updateNpmScripts(editor: Editor): Promise<void> {
+        Log.info('Updating npm scripts...');
 
-            if (!contentArray) {
-                return Log.fail(`
-                    Could not find content array in tailwind config, please add the following manually:
+        const packageJson = File.read('package.json');
 
-                    ${contentValue}
-                `);
-            }
+        if (!packageJson) {
+            return Log.fail('Could not find package.json file');
+        }
 
-            contentArray.addElement(contentValue);
+        File.write(
+            'package.json',
+            packageJson
+                .replace(
+                    '"cy:dev": "concurrently --kill-others \\"npm run test:serve-app\\" \\"npm run cy:open\\"",',
+                    '"cy:dev": "concurrently --kill-others ' +
+                        '\\"npm run test:serve-app\\" \\"npm run test:serve-pod\\" \\"npm run cy:open\\"",',
+                )
+                .replace(
+                    '"cy:test": "start-server-and-test test:serve-app http-get://localhost:5001 cy:run",',
+                    '"cy:test": "start-server-and-test ' +
+                        'test:serve-app http-get://localhost:5001 test:serve-pod http-get://localhost:3000 cy:run",',
+                )
+                .replace(
+                    '"dev": "vite",',
+                    '"dev": "vite",\n' +
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -f ./solid",',
+                )
+                .replace(
+                    '"test:serve-app": "vite --port 5001 --mode testing"',
+                    '"test:serve-app": "vite --port 5001 --mode testing",\n' +
+                        '"test:serve-pod": "community-solid-server -l warn"',
+                ),
+        );
 
-            await editor.save(tailwindConfig);
-        });
+        editor.addModifiedFile('package.json');
     }
 
-    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();
+    protected async updateGitIgnore(): Promise<void> {
+        Log.info('Updating .gitignore');
 
-        if (!Node.isArrayLiteralExpression(contentArray)) {
-            return null;
-        }
+        const gitignore = File.read('.gitignore') ?? '';
 
-        return contentArray;
+        File.write('.gitignore', `${gitignore}/solid\n`);
     }
 
 }

package/src/plugins/Soukai.ts

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

package/src/testing/setup.ts

@@ -1,31 +1,36 @@
-import { beforeEach, vi } from 'vitest';
-import { resolve } from 'path';
-import { setTestingNamespace } from '@noeldemartin/utils';
+import { beforeAll, beforeEach, vi } from 'vitest';
+import { resolve } from 'node:path';
+import { setupFacadeMocks } from '@noeldemartin/testing';
 
-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';
+import ShellMock from '@aerogel/cli/lib/Shell.mock';
+import File from '@aerogel/cli/lib/File';
+import FileMock from '@aerogel/cli/lib/File.mock';
+import Log from '@aerogel/cli/lib/Log';
+import LogMock from '@aerogel/cli/lib/Log.mock';
+import Shell from '@aerogel/cli/lib/Shell';
 
-setTestingNamespace(vi);
-
-File.setMockInstance(FileMock);
-Log.setMockInstance(LogMock);
-Shell.setMockInstance(ShellMock);
+beforeAll(() => {
+    File.setMockFacade(FileMock);
+    Log.setMockFacade(LogMock);
+    Shell.setMockFacade(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;
+vi.mock('@noeldemartin/utils', async () => {
+    const original = (await vi.importActual('@noeldemartin/utils')) as object;
+
+    setupFacadeMocks();
+
+    return original;
+});
+
+vi.mock('@aerogel/cli/lib/utils/app', async () => {
+    const original = (await vi.importActual('@aerogel/cli/lib/utils/app')) as object;
 
     return {
         ...original,
@@ -34,8 +39,8 @@ vi.mock('@/lib/utils/app', async () => {
     };
 });
 
-vi.mock('@/lib/utils/edit', async () => {
-    const original = (await vi.importActual('@/lib/utils/edit')) as object;
+vi.mock('@aerogel/cli/lib/utils/edit', async () => {
+    const original = (await vi.importActual('@aerogel/cli/lib/utils/edit')) as object;
 
     return {
         ...original,
@@ -44,8 +49,8 @@ vi.mock('@/lib/utils/edit', async () => {
 });
 
 // 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;
+vi.mock('@aerogel/cli/lib/utils/paths', async () => {
+    const original = (await vi.importActual('@aerogel/cli/lib/utils/paths')) as object;
 
     function basePath(path: string = '') {
         return resolve(__dirname, '../../', path);
@@ -55,15 +60,14 @@ vi.mock('@/lib/utils/paths', async () => {
         return basePath(`../${packageName}`);
     }
 
+    function templatePath(name: string = '') {
+        return resolve(__dirname, `../../templates/${name}`);
+    }
+
     return {
         ...original,
         basePath,
         packagePath,
+        templatePath,
     };
 });
-
-vi.mock('mustache', async () => {
-    const mustache = (await vi.importActual('mustache')) as { default: unknown };
-
-    return mustache.default;
-});

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

@@ -6,12 +6,24 @@ jobs:
     ci:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               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
+            - run: npm run test:ci
+            - run: npm run cy:test-snapshots:ci
+            - name: Upload Cypress screenshots
+              uses: actions/upload-artifact@v4
+              if: ${{ failure() }}
+              with:
+                  name: cypress_screenshots
+                  path: cypress/screenshots
+            - name: Upload Cypress snapshots
+              uses: actions/upload-artifact@v4
+              if: ${{ failure() }}
+              with:
+                  name: cypress_snapshots
+                  path: cypress/snapshots

package/templates/app/.nvmrc

@@ -1 +1 @@
-lts/hydrogen
+v22.9.0

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

@@ -3,6 +3,7 @@
     "configurations": [
         {
             "type": "node",
+            "runtimeVersion": "22.14.0",
             "request": "launch",
             "name": "Debug Current Test File",
             "autoAttachChildProcesses": true,

package/templates/app/README.md

@@ -0,0 +1,3 @@
+# <% app.name %>
+
+App created with [AerogelJS](https://aerogel.js.org)