@aerogel/cli 0.0.0-next.d4e50d20bf4c270c2068f0a4398e9304ee4a062e → 0.0.0-next.d803ba42263b449637ede53bb8ce9a147e781512

package/src/lib/File.mock.ts

@@ -8,28 +8,28 @@ export class FileMockService extends FileService {
 
     private virtualFilesystem: Record<string, string | { directory: true }> = {};
 
-    public exists(path: string): boolean {
+    public override exists(path: string): boolean {
         return super.exists(path) || path in this.virtualFilesystem;
     }
 
-    public isDirectory(path: string): boolean {
+    public override isDirectory(path: string): boolean {
         return (
             super.isDirectory(path) ||
             (path in this.virtualFilesystem && typeof this.virtualFilesystem[path] === 'object')
         );
     }
 
-    public isFile(path: string): boolean {
+    public override isFile(path: string): boolean {
         return (
             super.isFile(path) || (path in this.virtualFilesystem && typeof this.virtualFilesystem[path] === 'string')
         );
     }
 
-    public makeDirectory(path: string): void {
+    public override makeDirectory(path: string): void {
         this.virtualFilesystem[path] = { directory: true };
     }
 
-    public read(path: string): string | null {
+    public override read(path: string): string | null {
         if (path in this.virtualFilesystem && typeof this.virtualFilesystem[path] === 'string') {
             return this.virtualFilesystem[path] as string;
         }
@@ -37,14 +37,10 @@ export class FileMockService extends FileService {
         return super.read(path);
     }
 
-    public write(path: string, contents: string): void {
+    public override write(path: string, contents: string): void {
         this.virtualFilesystem[path] = contents;
     }
 
-    public reset(): void {
-        this.virtualFilesystem = {};
-    }
-
     public expectCreated(path: string, expectContent?: (contents: string) => void): Assertion<string> {
         expect(typeof this.virtualFilesystem[path] === 'string', `expected '${path}' file to have been created`).toBe(
             true,
@@ -63,4 +59,4 @@ export class FileMockService extends FileService {
 
 }
 
-export default facade(new FileMockService());
+export default facade(FileMockService);

package/src/lib/File.ts

@@ -1,6 +1,7 @@
-import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'fs';
+import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+
 import { facade } from '@noeldemartin/utils';
-import { dirname, resolve } from 'path';
 
 export class FileService {
 
@@ -26,6 +27,16 @@ export class FileService {
         return readFileSync(path).toString();
     }
 
+    public replace(path: string, search: string | RegExp, replacement: string): void {
+        const contents = this.read(path);
+
+        if (!contents) {
+            return;
+        }
+
+        this.write(path, contents.replaceAll(search, replacement));
+    }
+
     public getFiles(directoryPath: string): string[] {
         const children = readdirSync(directoryPath, { withFileTypes: true });
         const files: string[] = [];
@@ -73,4 +84,4 @@ export class FileService {
 
 }
 
-export default facade(new FileService());
+export default facade(FileService);

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,7 +7,7 @@ export class ShellServiceMock extends ShellService {
 
     private history: string[] = [];
 
-    public async run(command: string): Promise<void> {
+    public override async run(command: string): Promise<void> {
         this.history.push(command.trim());
     }
 
@@ -15,6 +15,10 @@ export class ShellServiceMock extends ShellService {
         expect(this.history, `expected '${command}' command to have been executed`).toContain(command);
     }
 
+    public expectNotRan(command: string): void {
+        expect(this.history, `expected '${command}' command to not have been executed`).not.toContain(command);
+    }
+
 }
 
-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,8 +1,8 @@
-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 {
 
@@ -32,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);
         }
 
@@ -43,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

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,15 +1,27 @@
-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 (process.env.AEROGEL_BASE_PATH) {
+        return resolve(process.env.AEROGEL_BASE_PATH, path);
     }
 
-    const packageJson = File.read(resolve(__dirname, '../../../../package.json'));
+    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(
+        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');
 
@@ -30,5 +42,5 @@ export function packagePath(packageName: string): string {
 }
 
 export function templatePath(name: string): string {
-    return resolve(__dirname, `../templates/${name}`);
+    return fileURLToPath(new URL(/* @vite-ignore */ `../templates/${name}`, import.meta.url));
 }

package/src/plugins/LocalFirst.ts

@@ -0,0 +1,9 @@
+import Plugin from '@aerogel/cli/plugins/Plugin';
+
+export default class LocalFirst extends Plugin {
+
+    constructor() {
+        super('local-first');
+    }
+
+}

package/src/plugins/Plugin.ts

@@ -1,13 +1,15 @@
 import { Node, SyntaxKind } from 'ts-morph';
+import { stringToCamelCase } from '@noeldemartin/utils';
 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 { addNpmDependency } from '@aerogel/cli/utils/package';
+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 {
 
@@ -17,15 +19,21 @@ export default abstract class Plugin {
         this.name = name;
     }
 
-    public async install(): Promise<void> {
+    public async install(options: { skipInstall?: boolean } = {}): Promise<void> {
         this.assertNotInstalled();
 
         await this.beforeInstall();
-        await this.installDependencies();
+        await this.addDependencies();
+
+        if (!options.skipInstall) {
+            await this.installDependencies();
+        }
 
         if (editFiles()) {
             const editor = app().edit();
 
+            editor.addSourceFile('package.json');
+
             await this.updateFiles(editor);
             await editor.format();
         }
@@ -49,23 +57,32 @@ export default abstract class Plugin {
         // Placeholder for overrides, don't place any functionality here.
     }
 
+    protected async addDependencies(): Promise<void> {
+        Log.info('Adding plugin dependencies');
+        this.addNpmDependencies();
+    }
+
     protected async installDependencies(): Promise<void> {
         await Log.animate('Installing plugin dependencies', async () => {
-            await this.installNpmDependencies();
+            await Shell.run('pnpm install --no-save');
         });
     }
 
     protected async updateFiles(editor: Editor): Promise<void> {
-        if (!this.isForDevelopment()) {
-            await this.updateBootstrapConfig(editor);
+        if (this.isForDevelopment()) {
+            return;
         }
-    }
 
-    protected async installNpmDependencies(): Promise<void> {
-        const flags = this.isForDevelopment() ? '--save-dev' : '';
+        await this.updateBootstrapConfig(editor);
+    }
 
+    protected addNpmDependencies(): void {
         if (isLinkedLocalApp()) {
-            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())} ${flags}`);
+            addNpmDependency(
+                this.getNpmPackageName(),
+                `file:${packagePath(this.getLocalPackageName())}`,
+                this.isForDevelopment(),
+            );
 
             return;
         }
@@ -73,12 +90,12 @@ export default abstract class Plugin {
         if (isLocalApp()) {
             const packPath = packagePackPath(this.getLocalPackageName()) ?? packNotFound(this.getLocalPackageName());
 
-            await Shell.run(`npm install file:${packPath} ${flags}`);
+            addNpmDependency(this.getNpmPackageName(), `file:${packPath}`, this.isForDevelopment());
 
             return;
         }
 
-        await Shell.run(`npm install ${this.getNpmPackageName()}@next --save-exact ${flags}`);
+        addNpmDependency(this.getNpmPackageName(), 'next', this.isForDevelopment());
     }
 
     protected async updateBootstrapConfig(editor: Editor): Promise<void> {
@@ -101,25 +118,6 @@ export default abstract class Plugin {
         });
     }
 
-    protected async updateTailwindConfig(editor: Editor, options: { content: string }): Promise<void> {
-        await Log.animate('Updating tailwind configuration', async () => {
-            const tailwindConfig = editor.requireSourceFile('tailwind.config.js');
-            const contentArray = this.getTailwindContentArray(tailwindConfig);
-
-            if (!contentArray) {
-                return Log.fail(`
-                    Could not find content array in tailwind config, please add the following manually:
-
-                    ${options.content}
-                `);
-            }
-
-            contentArray.addElement(options.content);
-
-            await editor.save(tailwindConfig);
-        });
-    }
-
     protected getBootstrapPluginsDeclaration(mainConfig: SourceFile): ArrayLiteralExpression | null {
         const bootstrapAppCall = findDescendant(mainConfig, {
             guard: Node.isCallExpression,
@@ -154,7 +152,7 @@ export default abstract class Plugin {
 
     protected getBootstrapImport(): OptionalKind<ImportDeclarationStructure> {
         return {
-            defaultImport: this.name,
+            defaultImport: stringToCamelCase(this.name),
             moduleSpecifier: `@aerogel/plugin-${this.name}`,
         };
     }
@@ -172,7 +170,7 @@ export default abstract class Plugin {
     }
 
     protected getBootstrapConfig(): string {
-        return `${this.name}()`;
+        return `${stringToCamelCase(this.name)}()`;
     }
 
 }

package/src/plugins/Solid.ts

@@ -1,34 +1,27 @@
-import File from '@/lib/File';
-import Log from '@/lib/Log';
-import Plugin from '@/plugins/Plugin';
-import Shell from '@/lib/Shell';
-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 { addNpmDependency } from '@aerogel/cli/utils/package';
+import type { Editor } from '@aerogel/cli/lib/Editor';
 
-export class Solid extends Plugin {
+export default class Solid extends Plugin {
 
     constructor() {
         super('solid');
     }
 
-    protected async updateFiles(editor: Editor): Promise<void> {
-        await this.updateTailwindConfig(editor, {
-            content: isLinkedLocalApp()
-                ? `'${packagePath('plugin-solid')}/dist/**/*.js'`
-                : '\'./node_modules/@aerogel/plugin-solid/dist/**/*.js\'',
-        });
-
+    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 --save-exact');
-        await Shell.run('npm install @noeldemartin/solid-utils@next --save-exact');
-        await Shell.run('npm install @solid/community-server@7 --save');
-        await super.installNpmDependencies();
+    protected override addNpmDependencies(): void {
+        addNpmDependency('soukai-solid', 'next');
+        addNpmDependency('@noeldemartin/solid-utils', 'next');
+        addNpmDependency('@solid/community-server', '7.1.6', true);
+
+        super.addNpmDependencies();
     }
 
     protected async updateNpmScripts(editor: Editor): Promise<void> {
@@ -56,11 +49,12 @@ export class Solid extends Plugin {
                 .replace(
                     '"dev": "vite",',
                     '"dev": "vite",\n' +
-                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -f ./solid-data",',
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -f ./solid",',
                 )
                 .replace(
-                    '"test:serve-app": "vite --port 5001"',
-                    '"test:serve-app": "vite --port 5001",\n"test:serve-pod": "community-solid-server -l warn"',
+                    '"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"',
                 ),
         );
 
@@ -72,7 +66,7 @@ export class Solid extends Plugin {
 
         const gitignore = File.read('.gitignore') ?? '';
 
-        File.write('.gitignore', `${gitignore}/solid-data\n`);
+        File.write('.gitignore', `${gitignore}/solid\n`);
     }
 
 }

package/src/plugins/Soukai.ts

@@ -1,18 +1,19 @@
-import Plugin from '@/plugins/Plugin';
-import Shell from '@/lib/Shell';
+import Plugin from '@aerogel/cli/plugins/Plugin';
+import { addNpmDependency } from '@aerogel/cli/utils/package';
 
-export class Soukai extends Plugin {
+export default 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 override addNpmDependencies(): void {
+        addNpmDependency('soukai', 'next');
+
+        super.addNpmDependencies();
     }
 
-    protected getBootstrapConfig(): string {
+    protected override getBootstrapConfig(): string {
         return 'soukai({ models: import.meta.glob(\'@/models/*\', { eager: true }) })';
     }