@aerogel/cli 0.0.0-next.7e89f52eb37d9154f4879a5ccd058d27d476dada → 0.0.0-next.980a397d575dcb5ff8c5a0bff769d09f938ea03c

package/src/commands/generate-model.ts

@@ -1,11 +1,10 @@
-import { stringToStudlyCase } from '@noeldemartin/utils';
+import { formatCodeBlock, stringToStudlyCase } from '@noeldemartin/utils';
 
 import Command from '@/commands/Command';
 import File from '@/lib/File';
 import Log from '@/lib/Log';
 import Template from '@/lib/Template';
 import { templatePath } from '@/lib/utils/paths';
-import { formatCodeBlock } from '@/lib/utils/format';
 import type { CommandOptions } from '@/commands/Command';
 
 interface Options {
@@ -14,10 +13,10 @@ interface Options {
 
 export class GenerateModelCommand extends Command {
 
-    public static command: string = 'generate:model';
-    public static description: string = 'Generate an AerogelJS Model';
-    public static parameters: [string, string][] = [['name', 'Model name']];
-    public static options: CommandOptions = {
+    protected static command: string = 'generate:model';
+    protected static description: string = 'Generate an AerogelJS Model';
+    protected static parameters: [string, string][] = [['name', 'Model name']];
+    protected static options: CommandOptions = {
         fields: 'Create model with the given fields',
     };
 
@@ -31,7 +30,7 @@ export class GenerateModelCommand extends Command {
         this.options = options;
     }
 
-    public async run(): Promise<void> {
+    protected async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/models');
 
         if (File.exists(`src/models/${this.name}.ts`)) {
@@ -91,7 +90,7 @@ export class GenerateModelCommand extends Command {
         if (!File.contains('package.json', '"soukai"') && !File.contains('package.json', '"@aerogel/plugin-soukai"')) {
             Log.fail(`
                 Soukai is not installed yet! You can install it running:
-                npx ag install soukai
+                npx gel install soukai
             `);
         }
     }

package/src/commands/generate-service.test.ts

@@ -1,17 +1,25 @@
-import { describe, it } from 'vitest';
+import { beforeEach, describe, it } from 'vitest';
 
 import FileMock from '@/lib/File.mock';
+import { stubCommandRunner } from '@/testing/utils';
+import type { StubCommandRunner } from '@/testing/utils';
 
 import { GenerateServiceCommand } from './generate-service';
 
 describe('Generate Service command', () => {
 
+    let run: StubCommandRunner<typeof GenerateServiceCommand>;
+
+    beforeEach(() => {
+        run = stubCommandRunner(GenerateServiceCommand);
+    });
+
     it('generates services', async () => {
         // Arrange
         FileMock.stub('package.json', '@aerogel/core');
 
         // Act
-        await GenerateServiceCommand.run('FooBar');
+        await run('FooBar');
 
         // Assert
         FileMock.expectCreated('src/services/FooBar.ts').toContain('class FooBarService extends Service');

package/src/commands/generate-service.ts

@@ -1,4 +1,4 @@
-import { arrayFrom, stringToCamelCase } from '@noeldemartin/utils';
+import { arrayFrom, formatCodeBlock, stringToCamelCase } from '@noeldemartin/utils';
 import { Node, SyntaxKind } from 'ts-morph';
 import type { ObjectLiteralExpression, SourceFile } from 'ts-morph';
 
@@ -9,14 +9,13 @@ import Template from '@/lib/Template';
 import { app } from '@/lib/utils/app';
 import { templatePath } from '@/lib/utils/paths';
 import { editFiles, findDescendant } from '@/lib/utils/edit';
-import { formatCodeBlock } from '@/lib/utils/format';
 import type { Editor } from '@/lib/Editor';
 
 export class GenerateServiceCommand extends Command {
 
-    public static command: string = 'generate:service';
-    public static description: string = 'Generate an AerogelJS Service';
-    public static parameters: [string, string][] = [['name', 'Service name']];
+    protected static command: string = 'generate:service';
+    protected static description: string = 'Generate an AerogelJS Service';
+    protected static parameters: [string, string][] = [['name', 'Service name']];
 
     private name: string;
 
@@ -26,7 +25,7 @@ export class GenerateServiceCommand extends Command {
         this.name = name;
     }
 
-    public async run(): Promise<void> {
+    protected async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/services');
 
         const files = new Set<string>();

package/src/commands/install.test.ts

@@ -1,18 +1,49 @@
-import { describe, it } from 'vitest';
+import { beforeEach, describe, it } from 'vitest';
 
+import FileMock from '@/lib/File.mock';
 import ShellMock from '@/lib/Shell.mock';
+import { stubCommandRunner } from '@/testing/utils';
+import type { StubCommandRunner } from '@/testing/utils';
 
 import { InstallCommand } from './install';
 
 describe('Install plugin command', () => {
 
-    it('installs plugins', async () => {
+    let run: StubCommandRunner<typeof InstallCommand>;
+
+    beforeEach(() => {
+        run = stubCommandRunner(InstallCommand);
+    });
+
+    it('installs solid', async () => {
+        // Act
+        await run('solid');
+
+        // Assert
+        ShellMock.expectRan('npm install soukai-solid@next --save-exact');
+        ShellMock.expectRan('npm install @aerogel/plugin-solid@next --save-exact');
+    });
+
+    it('installs soukai', async () => {
+        // Act
+        await run('soukai');
+
+        // Assert
+        ShellMock.expectRan('npm install soukai@next --save-exact');
+        ShellMock.expectRan('npm install @aerogel/plugin-soukai@next --save-exact');
+    });
+
+    it('installs histoire', async () => {
+        // Arrange
+        FileMock.stub('package.json', '"@aerogel/core"');
+
         // Act
-        await InstallCommand.run('solid');
+        await run('histoire');
 
         // Assert
-        ShellMock.expectRan('npm install soukai-solid@next');
-        ShellMock.expectRan('npm install @aerogel/plugin-solid@next');
+        ShellMock.expectRan('npm install histoire@0.17.6 --save-dev');
+        ShellMock.expectRan('npm install @aerogel/histoire@next --save-exact --save-dev');
+        ShellMock.expectRan('npm install patch-package --save-dev');
     });
 
 });

package/src/commands/install.ts

@@ -1,19 +1,20 @@
 import Command from '@/commands/Command';
 import Log from '@/lib/Log';
+import { Histoire } from '@/plugins/Histoire';
 import { Solid } from '@/plugins/Solid';
 import { Soukai } from '@/plugins/Soukai';
 import type Plugin from '@/plugins/Plugin';
 
-const plugins = [new Soukai(), new Solid()].reduce(
+const plugins = [new Soukai(), new Solid(), new Histoire()].reduce(
     (pluginsObject, plugin) => Object.assign(pluginsObject, { [plugin.name]: plugin }),
     {} as Record<string, Plugin>,
 );
 
 export class InstallCommand extends Command {
 
-    public static command: string = 'install';
-    public static description: string = 'Install an AerogelJS plugin';
-    public static parameters: [string, string][] = [['plugin', 'Plugin to install']];
+    protected static command: string = 'install';
+    protected static description: string = 'Install an AerogelJS plugin';
+    protected static parameters: [string, string][] = [['plugin', 'Plugin to install']];
 
     private plugin: Plugin;
 
@@ -25,7 +26,7 @@ export class InstallCommand extends Command {
             Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
     }
 
-    public async run(): Promise<void> {
+    protected async run(): Promise<void> {
         await this.plugin.install();
     }
 

package/src/lib/Editor.ts

@@ -18,6 +18,7 @@ export class Editor {
         this.project.addSourceFilesAtPaths('src/**/*.ts');
         this.project.addSourceFilesAtPaths('tailwind.config.js');
         this.project.addSourceFilesAtPaths('vite.config.ts');
+        this.project.addSourceFilesAtPaths('package.json');
     }
 
     public addSourceFile(path: string): void {
@@ -30,22 +31,28 @@ export class Editor {
 
     public async format(): Promise<void> {
         await Log.animate('Formatting modified files', async () => {
-            const usingPrettier = File.exists('prettier.config.js');
-            const usingESLint = File.exists('.eslintrc.js');
-
-            await Promise.all(
-                arrayFrom(this.modifiedFiles).map(async (file) => {
+            const usingPrettier = File.exists('prettier.config.js') || File.contains('package.json', '"prettier": {');
+            const usingESLint = File.exists('.eslintrc.js') || File.contains('package.json', '"eslintConfig"');
+            const usingPrettierESLint = File.contains('package.json', '"prettier-eslint-cli"');
+            const formatFile = usingPrettierESLint
+                ? (file: string) => Shell.run(`npx prettier-eslint ${file} --write`)
+                : async (file: string) => {
                     usingPrettier && (await Shell.run(`npx prettier ${file} --write`));
-                    usingESLint && (await Shell.run(`npx eslint ${file} --fix`));
-                }),
-            );
+                    file.match(/\.(ts|js|vue)$/) && usingESLint && (await Shell.run(`npx eslint ${file} --fix`));
+                };
+
+            await Promise.all(arrayFrom(this.modifiedFiles).map(async (file) => formatFile(file)));
         });
     }
 
     public async save(file: SourceFile): Promise<void> {
         await file.save();
 
-        this.modifiedFiles.add(file.getFilePath());
+        this.addModifiedFile(file.getFilePath());
+    }
+
+    public addModifiedFile(path: string): void {
+        this.modifiedFiles.add(path);
     }
 
 }

package/src/lib/Shell.mock.ts

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

package/src/lib/Template.ts

@@ -6,7 +6,11 @@ import File from '@/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);

package/src/lib/utils/app.ts

@@ -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/paths.ts

@@ -10,7 +10,7 @@ export function basePath(path: string = ''): string {
     }
 
     const packageJson = File.read(resolve(__dirname, '../../../../package.json'));
-    const matches = stringMatch<2>(packageJson ?? '', /"@aerogel\/cli": "file:(.*)\/aerogel-cli-[\d.]*\.tgz"/);
+    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);

package/src/plugins/Histoire.ts

@@ -0,0 +1,105 @@
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+import Template from '@/lib/Template';
+import { isLinkedLocalApp } from '@/lib/utils/app';
+import { packagePath, templatePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export class Histoire extends Plugin {
+
+    private installedPatchPackage: boolean = false;
+    private installedPostCSSPseudoClasses: boolean = false;
+
+    constructor() {
+        super('histoire');
+    }
+
+    public async beforeInstall(): Promise<void> {
+        this.installedPatchPackage = false;
+        this.installedPostCSSPseudoClasses = false;
+    }
+
+    protected async afterInstall(): Promise<void> {
+        if (!this.installedPatchPackage) {
+            return;
+        }
+
+        await Log.animate('Patching dependencies', async () => {
+            await Shell.run('npx patch-package');
+        });
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateTailwindConfig(editor, {
+            content: isLinkedLocalApp()
+                ? `'${packagePath('histoire')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/histoire/dist/**/*.js\'',
+        });
+
+        await this.updateNpmScripts(editor);
+        await this.createConfigFiles();
+        await super.updateFiles(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        // We need this specific version because we're patching it using patch-package
+        await Shell.run('npm install histoire@0.17.6 --save-dev');
+
+        if (!File.contains('package.json', '"patch-package"')) {
+            await Shell.run('npm install patch-package --save-dev');
+
+            this.installedPatchPackage = true;
+        }
+
+        if (!File.contains('package.json', '"postcss-pseudo-classes"')) {
+            await Shell.run('npm install postcss-pseudo-classes --save-dev');
+
+            this.installedPostCSSPseudoClasses = true;
+        }
+
+        await super.installNpmDependencies();
+    }
+
+    protected getLocalPackageName(): string {
+        return this.name;
+    }
+
+    protected async updateNpmScripts(editor: Editor): Promise<void> {
+        Log.info('Updating npm scripts...');
+
+        const packageJson = File.read('package.json');
+
+        if (!packageJson) {
+            return Log.fail('Could not find package.json file');
+        }
+
+        File.write(
+            'package.json',
+            packageJson.replace(
+                '"lint": "noeldemartin-lint src",',
+                this.installedPatchPackage
+                    ? '"histoire": "histoire dev", "lint": "noeldemartin-lint src", "postinstall": "patch-package",'
+                    : '"histoire": "histoire dev", "lint": "noeldemartin-lint src",',
+            ),
+        );
+
+        editor.addModifiedFile('package.json');
+    }
+
+    protected async createConfigFiles(): Promise<void> {
+        Log.info('Creating config files...');
+
+        Template.instantiate(templatePath('histoire'));
+
+        if (this.installedPostCSSPseudoClasses) {
+            Template.instantiate(templatePath('postcss-pseudo-classes'));
+        }
+    }
+
+    protected isForDevelopment(): boolean {
+        return true;
+    }
+
+}

package/src/plugins/Plugin.ts

@@ -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> {
@@ -86,6 +101,25 @@ 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,
@@ -103,6 +137,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 +167,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,10 +1,7 @@
-import { Node, SyntaxKind } from 'ts-morph';
-import type { ArrayLiteralExpression, SourceFile } from 'ts-morph';
-
+import File from '@/lib/File';
+import Log from '@/lib/Log';
 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';
@@ -16,50 +13,66 @@ export class Solid extends Plugin {
     }
 
     protected async updateFiles(editor: Editor): Promise<void> {
-        await this.updateTailwindConfig(editor);
+        await this.updateTailwindConfig(editor, {
+            content: isLinkedLocalApp()
+                ? `'${packagePath('plugin-solid')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/plugin-solid/dist/**/*.js\'',
+        });
+
+        await this.updateNpmScripts(editor);
+        await this.updateGitIgnore();
         await super.updateFiles(editor);
     }
 
     protected async installNpmDependencies(): Promise<void> {
-        await Shell.run('npm install soukai-solid@next');
+        await Shell.run('npm install soukai-solid@next --save-exact');
+        await Shell.run('npm install @solid/community-server@7 --save');
         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:4000 cy:run",',
+                )
+                .replace(
+                    '"dev": "vite",',
+                    '"dev": "vite",\n' +
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -p 4000 -f ./solid-data",',
+                )
+                .replace(
+                    '"test:serve-app": "vite --port 5001"',
+                    '"test:serve-app": "vite --port 5001",\n' +
+                        '"test:serve-pod": "community-solid-server -p 4000 -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-data\n`);
     }
 
 }

package/src/plugins/Soukai.ts

@@ -8,7 +8,7 @@ export class Soukai extends Plugin {
     }
 
     protected async installNpmDependencies(): Promise<void> {
-        await Shell.run('npm install soukai@next');
+        await Shell.run('npm install soukai@next --save-exact');
         await super.installNpmDependencies();
     }
 

package/src/testing/stubs/ProgramStub.ts

@@ -0,0 +1,35 @@
+import type { Command as Program } from 'commander';
+import type { Constructor } from '@noeldemartin/utils';
+
+import type Command from '@/commands/Command';
+
+export default class ProgramStub<T extends Constructor<Command> = Constructor<Command>> {
+
+    private runner?: (...args: ConstructorParameters<T>) => Promise<void>;
+
+    public async run(...args: ConstructorParameters<T>): Promise<void> {
+        await this.runner?.(...args);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public command(): any {
+        return { description: () => this };
+    }
+
+    public argument(): this {
+        return this;
+    }
+
+    public option(): this {
+        return this;
+    }
+
+    public action(runner: Function): this {
+        this.runner = runner as (...args: ConstructorParameters<T>) => Promise<void>;
+
+        return this;
+    }
+
+}
+
+export default interface ProgramStub extends Program {}