@aerogel/cli 0.0.0-next.5953e1862a7c89a8fc80da087467d67d4f4e8c73 → 0.0.0-next.6c02970f90d4e979a72530f1fa0c650785d6538f

package/src/cli.ts

@@ -1,9 +1,14 @@
 import { Command } from 'commander';
+import { facade, fail } from '@noeldemartin/utils';
+import { resolve } from 'path';
+import { existsSync, readFileSync } from 'fs';
+
 import { CreateCommand } from '@/commands/create';
-import { facade } from '@noeldemartin/utils';
 import { GenerateComponentCommand } from '@/commands/generate-component';
 import { GenerateModelCommand } from '@/commands/generate-model';
+import { GenerateOverridesCommand } from '@/commands/generate-overrides';
 import { GenerateServiceCommand } from '@/commands/generate-service';
+import { InfoCommand } from '@/commands/info';
 import { InstallCommand } from '@/commands/install';
 
 export class CLIService {
@@ -11,17 +16,32 @@ export class CLIService {
     public run(argv?: string[]): void {
         const program = new Command();
 
-        program.name('ag').description('AerogelJS CLI').version('0.0.0');
+        program.name('gel').description('AerogelJS CLI').version(this.getVersion());
 
         CreateCommand.define(program);
         GenerateComponentCommand.define(program);
         GenerateModelCommand.define(program);
+        GenerateOverridesCommand.define(program);
         GenerateServiceCommand.define(program);
+        InfoCommand.define(program);
         InstallCommand.define(program);
 
         program.parse(argv);
     }
 
+    public getVersion(): string {
+        const errorMessage = 'Could not find CLI\'s version, please report this bug.';
+        const packageJsonPath = resolve(__dirname, '../package.json');
+
+        if (!existsSync(packageJsonPath)) {
+            throw new Error(errorMessage);
+        }
+
+        const packageJson = JSON.parse(readFileSync(packageJsonPath).toString()) as { version?: string };
+
+        return packageJson.version ?? fail(errorMessage);
+    }
+
 }
 
-export default facade(new CLIService());
+export default facade(CLIService);

package/src/commands/Command.ts

@@ -8,10 +8,10 @@ export type CommandOptions = Record<string, string | { description: string; type
 
 export default class Command {
 
-    public static command: string = '';
-    public static description: string = '';
-    public static parameters: [string, string][] = [];
-    public static options: CommandOptions = {};
+    protected static command: string = '';
+    protected static description: string = '';
+    protected static parameters: [string, string][] = [];
+    protected static options: CommandOptions = {};
 
     public static define(program: CommanderCommand): void {
         program = program.command(this.command).description(this.description);
@@ -33,11 +33,16 @@ export default class Command {
     public static async run<T extends CommandConstructor>(this: T, ...args: ConstructorParameters<T>): Promise<void> {
         const instance = new this(...args);
 
+        await instance.validate();
         await instance.run();
     }
 
-    public async run(): Promise<void> {
-        //
+    protected async validate(): Promise<void> {
+        // Placeholder for overrides, don't place any functionality here.
+    }
+
+    protected async run(): Promise<void> {
+        // Placeholder for overrides, don't place any functionality here.
     }
 
     protected assertAerogelOrDirectory(path?: string): void {

package/src/commands/create.ts

@@ -15,10 +15,10 @@ export interface Options {
 
 export class CreateCommand extends Command {
 
-    public static command: string = 'create';
-    public static description: string = 'Create AerogelJS app';
-    public static parameters: [string, string][] = [['path', 'Application path']];
-    public static options: CommandOptions = {
+    protected static command: string = 'create';
+    protected static description: string = 'Create AerogelJS app';
+    protected static parameters: [string, string][] = [['path', 'Application path']];
+    protected static options: CommandOptions = {
         name: 'Application name',
         local: {
             type: 'boolean',
@@ -40,7 +40,7 @@ export class CreateCommand extends Command {
         this.options = options;
     }
 
-    public async run(): Promise<void> {
+    protected async run(): Promise<void> {
         const path = this.path;
         const name = this.options.name ?? stringToTitleCase(basename(path));
 

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

@@ -67,4 +67,25 @@ describe('Generate Component command', () => {
         );
     });
 
+    it('generates button components with stories', async () => {
+        // Arrange
+        FileMock.stub(
+            'package.json',
+            `
+                "@aerogel/core": "*",
+                "histoire": "*"
+            `,
+        );
+
+        // Act
+        await GenerateComponentCommand.run('FooBar', { button: true, story: true });
+
+        // Assert
+        FileMock.expectCreated('src/components/FooBar.vue').toContain(
+            '<AGHeadlessButton :class="variantClasses" :disabled="disabled">',
+        );
+        FileMock.expectCreated('src/components/FooBar.story.vue').toContain('.story-foobar .variant-playground');
+        FileMock.expectCreated('src/components/FooBar.story.vue').toContain('<FooBar :color="color">');
+    });
+
 });

package/src/commands/generate-component.ts

@@ -1,4 +1,4 @@
-import { arrayFrom, stringToSlug } from '@noeldemartin/utils';
+import { arrayFilter, arrayFrom, stringToSlug } from '@noeldemartin/utils';
 import { Node, SyntaxKind } from 'ts-morph';
 import type { ArrayLiteralExpression, CallExpression, SourceFile } from 'ts-morph';
 
@@ -12,27 +12,37 @@ import { templatePath } from '@/lib/utils/paths';
 import type { CommandOptions } from '@/commands/Command';
 
 export interface Options {
-    story?: boolean;
+    button?: boolean;
+    checkbox?: boolean;
     input?: boolean;
+    story?: boolean;
 }
 
 export class GenerateComponentCommand extends Command {
 
-    public static command: string = 'generate:component';
-    public static description: string = 'Generate an AerogelJS Component';
-    public static parameters: [string, string][] = [
+    protected static command: string = 'generate:component';
+    protected static description: string = 'Generate an AerogelJS Component';
+    protected static parameters: [string, string][] = [
         ['path', 'Component path (relative to components folder; extension not necessary)'],
     ];
 
-    public static options: CommandOptions = {
-        story: {
-            description: 'Create component story using Histoire',
+    protected static options: CommandOptions = {
+        button: {
+            description: 'Create a custom button',
+            type: 'boolean',
+        },
+        checkbox: {
+            description: 'Create a custom checkbox',
             type: 'boolean',
         },
         input: {
             description: 'Create a custom input',
             type: 'boolean',
         },
+        story: {
+            description: 'Create component story using Histoire',
+            type: 'boolean',
+        },
     };
 
     private path: string;
@@ -45,7 +55,15 @@ export class GenerateComponentCommand extends Command {
         this.options = options;
     }
 
-    public async run(): Promise<void> {
+    protected async validate(): Promise<void> {
+        const components = arrayFilter([this.options.button, this.options.input, this.options.checkbox]).length;
+
+        if (components > 1) {
+            Log.fail('Can only use one of \'button\', \'input\', or \'checkbox\' flags!');
+        }
+    }
+
+    protected async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/components');
         this.assertHistoireInstalled();
 
@@ -71,7 +89,7 @@ export class GenerateComponentCommand extends Command {
         if (!File.contains('package.json', '"histoire"') && !File.contains('package.json', '"@aerogel/histoire"')) {
             Log.fail(`
                 Histoire is not installed yet! You can install it running:
-                npx ag install histoire
+                npx gel install histoire
             `);
         }
     }
@@ -82,7 +100,13 @@ export class GenerateComponentCommand extends Command {
                 Log.fail(`${this.path} component already exists!`);
             }
 
-            const templateName = this.options.input ? 'component-input' : 'component';
+            const templateName = this.options.input
+                ? 'component-input'
+                : this.options.button
+                    ? 'component-button'
+                    : this.options.checkbox
+                        ? 'component-checkbox'
+                        : 'component';
             const componentFiles = Template.instantiate(templatePath(templateName), `src/components/${directoryName}`, {
                 component: {
                     name: componentName,
@@ -100,7 +124,13 @@ export class GenerateComponentCommand extends Command {
         }
 
         await Log.animate('Creating story', async () => {
-            const templateName = this.options.input ? 'component-input-story' : 'component-story';
+            const templateName = this.options.input
+                ? 'component-input-story'
+                : this.options.button
+                    ? 'component-button-story'
+                    : this.options.checkbox
+                        ? 'component-checkbox-story'
+                        : 'component-story';
             const storyFiles = Template.instantiate(templatePath(templateName), `src/components/${directoryName}`, {
                 component: {
                     name: componentName,

package/src/commands/generate-model.ts

@@ -13,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',
     };
 
@@ -30,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`)) {
@@ -90,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-overrides.ts

@@ -0,0 +1,85 @@
+import { arrayFrom } 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 type { CommandOptions } from '@/commands/Command';
+
+export interface Options {
+    story?: boolean;
+}
+
+export class GenerateOverridesCommand extends Command {
+
+    protected static command: string = 'generate:overrides';
+    protected static description: string = 'Generate AerogelJS component overrides';
+
+    protected static options: CommandOptions = {
+        story: {
+            description: 'Create overrides story using Histoire',
+            type: 'boolean',
+        },
+    };
+
+    private options: Options;
+
+    constructor(options: Options = {}) {
+        super();
+
+        this.options = options;
+    }
+
+    protected async run(): Promise<void> {
+        this.assertAerogelOrDirectory('src/components');
+        this.assertHistoireInstalled();
+
+        const files = new Set<string>();
+
+        await this.createComponents(files);
+        await this.createStory(files);
+
+        const filesList = arrayFrom(files)
+            .map((file) => `- ${file}`)
+            .join('\n');
+
+        Log.info(`Overrides created successfully! The following files were created:\n\n${filesList}`);
+        Log.info('\nRemember to declare your components in main.ts and main.histoire.ts!');
+    }
+
+    protected assertHistoireInstalled(): void {
+        if (!this.options.story) {
+            return;
+        }
+
+        if (!File.contains('package.json', '"histoire"') && !File.contains('package.json', '"@aerogel/histoire"')) {
+            Log.fail(`
+                Histoire is not installed yet! You can install it running:
+                npx gel install histoire
+            `);
+        }
+    }
+
+    protected async createComponents(files: Set<string>): Promise<void> {
+        await Log.animate('Creating components', async () => {
+            if (File.exists('src/components/ModalWrapper.vue')) {
+                Log.fail('ModalWrapper component already exists!');
+            }
+
+            Template.instantiate(templatePath('overrides'), 'src').forEach((file) => files.add(file));
+        });
+    }
+
+    protected async createStory(files: Set<string>): Promise<void> {
+        if (!this.options.story) {
+            return;
+        }
+
+        await Log.animate('Creating story', async () => {
+            Template.instantiate(templatePath('overrides-story'), 'src/components/overrides/').forEach((file) =>
+                files.add(file));
+        });
+    }
+
+}

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

@@ -15,7 +15,7 @@ describe('Generate Service command', () => {
 
         // Assert
         FileMock.expectCreated('src/services/FooBar.ts').toContain('class FooBarService extends Service');
-        FileMock.expectCreated('src/services/FooBar.ts').toContain('export default facade(new FooBarService());');
+        FileMock.expectCreated('src/services/FooBar.ts').toContain('export default facade(FooBarService);');
     });
 
 });

package/src/commands/generate-service.ts

@@ -13,9 +13,9 @@ 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;
 
@@ -25,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>();
@@ -122,7 +122,7 @@ export class GenerateServiceCommand extends Command {
     protected getBootstrapOptions(mainConfig: SourceFile): ObjectLiteralExpression | 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];

package/src/commands/info.ts

@@ -0,0 +1,14 @@
+import Command from '@/commands/Command';
+import Log from '@/lib/Log';
+
+export class InfoCommand extends Command {
+
+    protected static command: string = 'info';
+    protected static description: string = 'Show debugging information about the CLI';
+
+    protected async run(): Promise<void> {
+        Log.info('[AerogelJS CLI info]');
+        Log.info('Installation directory: ' + __dirname);
+    }
+
+}

package/src/commands/install.ts

@@ -12,9 +12,9 @@ const plugins = [new Soukai(), new Solid(), new Histoire()].reduce(
 
 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;
 
@@ -26,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/File.mock.ts

@@ -41,10 +41,6 @@ export class FileMockService extends FileService {
         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

@@ -73,4 +73,4 @@ export class FileService {
 
 }
 
-export default facade(new FileService());
+export default facade(FileService);

package/src/lib/Log.mock.ts

@@ -24,14 +24,10 @@ export class LogServiceMock extends LogService {
         throw new Error(`Fail: ${message}`);
     }
 
-    public reset(): void {
-        this.logs = [];
-    }
-
     protected stdout(): void {
         //
     }
 
 }
 
-export default facade(new LogServiceMock());
+export default facade(LogServiceMock);

package/src/lib/Log.ts

@@ -92,4 +92,4 @@ export class LogService {
 
 }
 
-export default facade(new LogService());
+export default facade(LogService);

package/src/lib/Shell.mock.ts

@@ -17,4 +17,4 @@ export class ShellServiceMock extends ShellService {
 
 }
 
-export default facade(new ShellServiceMock());
+export default facade(ShellServiceMock);

package/src/lib/Shell.ts

@@ -25,4 +25,4 @@ export class ShellService {
 
 }
 
-export default facade(new ShellService());
+export default facade(ShellService);

package/src/plugins/Histoire.ts

@@ -6,10 +6,12 @@ import Template from '@/lib/Template';
 import { isLinkedLocalApp } from '@/lib/utils/app';
 import { packagePath, templatePath } from '@/lib/utils/paths';
 import type { Editor } from '@/lib/Editor';
+import { formatCodeBlock } from '@noeldemartin/utils';
 
 export class Histoire extends Plugin {
 
     private installedPatchPackage: boolean = false;
+    private installedPostCSSPseudoClasses: boolean = false;
 
     constructor() {
         super('histoire');
@@ -17,6 +19,7 @@ export class Histoire extends Plugin {
 
     public async beforeInstall(): Promise<void> {
         this.installedPatchPackage = false;
+        this.installedPostCSSPseudoClasses = false;
     }
 
     protected async afterInstall(): Promise<void> {
@@ -51,6 +54,12 @@ export class Histoire extends Plugin {
             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();
     }
 
@@ -70,10 +79,17 @@ export class Histoire extends Plugin {
         File.write(
             'package.json',
             packageJson.replace(
-                '"lint": "noeldemartin-lint src",',
+                '"lint": "noeldemartin-lint src cypress",',
                 this.installedPatchPackage
-                    ? '"histoire": "histoire dev", "lint": "noeldemartin-lint src", "postinstall": "patch-package",'
-                    : '"histoire": "histoire dev", "lint": "noeldemartin-lint src",',
+                    ? formatCodeBlock(`
+                        "histoire": "histoire dev",
+                        "lint": "noeldemartin-lint cypress src",
+                        "postinstall": "patch-package",
+                    `)
+                    : formatCodeBlock(`
+                        "histoire": "histoire dev",
+                        "lint": "noeldemartin-lint cypress src",
+                    `),
             ),
         );
 
@@ -84,6 +100,10 @@ export class Histoire extends Plugin {
         Log.info('Creating config files...');
 
         Template.instantiate(templatePath('histoire'));
+
+        if (this.installedPostCSSPseudoClasses) {
+            Template.instantiate(templatePath('postcss-pseudo-classes'));
+        }
     }
 
     protected isForDevelopment(): boolean {

package/src/plugins/Plugin.ts

@@ -123,7 +123,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];

package/src/plugins/Solid.ts

@@ -26,6 +26,7 @@ export class Solid extends Plugin {
 
     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();
     }
@@ -50,17 +51,17 @@ export class Solid extends Plugin {
                 .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",',
+                        '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 -p 4000 -f ./solid-data",',
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -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"',
+                    '"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"',
                 ),
         );
 

package/src/testing/setup.ts

@@ -11,14 +11,11 @@ import ShellMock from '@/lib/Shell.mock';
 
 setTestingNamespace(vi);
 
-File.setMockInstance(FileMock);
-Log.setMockInstance(LogMock);
-Shell.setMockInstance(ShellMock);
+File.setMockFacade(FileMock);
+Log.setMockFacade(LogMock);
+Shell.setMockFacade(ShellMock);
 
 beforeEach(() => {
-    FileMock.reset();
-    LogMock.reset();
-
     File.mock();
     Log.mock();
     Shell.mock();

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

@@ -6,8 +6,8 @@ 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
@@ -16,13 +16,13 @@ jobs:
             - run: npm run test:ci
             - run: npm run cy:test-snapshots:ci
             - name: Upload Cypress screenshots
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               if: ${{ failure() }}
               with:
                   name: cypress_screenshots
                   path: cypress/screenshots
             - name: Upload Cypress snapshots
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               if: ${{ failure() }}
               with:
                   name: cypress_snapshots