@aerogel/cli 0.0.0-next.f8cdd39997c56dcd46e07c26af8a84d04d610fce → 0.0.0-next.f9394854509d71d644498ac087706a2f8f8eea1c

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.test.ts

@@ -15,7 +15,7 @@ describe('Create command', () => {
         FileMock.expectCreated('./app/.gitignore').toContain('node_modules');
         FileMock.expectCreated('./app/package.json').toContain('"name": "my-app"');
         FileMock.expectCreated('./app/package.json').toContain('"@aerogel/core": "next"');
-        FileMock.expectCreated('./app/index.html').toContain('My App');
+        FileMock.expectCreated('./app/index.html').toContain('{{ app.name }}');
         FileMock.expectCreated('./app/README.md').toContain('My App');
         FileMock.expectCreated('./app/src/App.vue').toContain('<h1 class="text-4xl font-semibold">');
         FileMock.expectCreated('./app/src/App.vue').toContain('{{ $t(\'home.title\') }}');
@@ -38,7 +38,6 @@ describe('Create command', () => {
 
         // Assert
         FileMock.expectCreated('./my-app/package.json').toContain('"name": "my-app"');
-        FileMock.expectCreated('./my-app/index.html').toContain('My App');
     });
 
 });

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

@@ -30,8 +30,13 @@ describe('Generate Component command', () => {
 
     it('generates components with stories', async () => {
         // Arrange
-        FileMock.stub('package.json', '@aerogel/core');
-        FileMock.stub('src/main.histoire.ts');
+        FileMock.stub(
+            'package.json',
+            `
+                "@aerogel/core": "*",
+                "histoire": "*"
+            `,
+        );
 
         // Act
         await GenerateComponentCommand.run('FooBar', { story: true });
@@ -41,4 +46,46 @@ describe('Generate Component command', () => {
         FileMock.expectCreated('src/components/FooBar.story.vue').toContain('<FooBar />');
     });
 
+    it('generates input components with stories', async () => {
+        // Arrange
+        FileMock.stub(
+            'package.json',
+            `
+                "@aerogel/core": "*",
+                "histoire": "*"
+            `,
+        );
+
+        // Act
+        await GenerateComponentCommand.run('FooBar', { input: true, story: true });
+
+        // Assert
+        FileMock.expectCreated('src/components/FooBar.vue').toContain('<AGHeadlessInputInput v-bind="attrs" />');
+        FileMock.expectCreated('src/components/FooBar.story.vue').toContain('.story-foobar .variant-playground');
+        FileMock.expectCreated('src/components/FooBar.story.vue').toContain(
+            '<FooBar name="food" :label="label" :placeholder="placeholder" />',
+        );
+    });
+
+    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 } 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,18 +12,33 @@ import { templatePath } from '@/lib/utils/paths';
 import type { CommandOptions } from '@/commands/Command';
 
 export interface Options {
+    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 = {
+    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',
@@ -40,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();
 
@@ -48,7 +71,7 @@ export class GenerateComponentCommand extends Command {
         const [directoryName, componentName] = this.parsePathComponents();
 
         await this.createComponent(directoryName, componentName, files);
-        await this.createStory(componentName, files);
+        await this.createStory(directoryName, componentName, files);
         await this.declareComponents();
 
         const filesList = arrayFrom(files)
@@ -63,8 +86,11 @@ export class GenerateComponentCommand extends Command {
             return;
         }
 
-        if (!File.exists('src/main.histoire.ts')) {
-            Log.fail('Histoire is not installed yet!');
+        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
+            `);
         }
     }
 
@@ -74,22 +100,42 @@ export class GenerateComponentCommand extends Command {
                 Log.fail(`${this.path} component already exists!`);
             }
 
-            const componentFiles = Template.instantiate(templatePath('component'), `src/components/${directoryName}`, {
-                component: { name: componentName },
+            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,
+                    slug: stringToSlug(componentName),
+                },
             });
 
             componentFiles.forEach((file) => files.add(file));
         });
     }
 
-    protected async createStory(componentName: string, files: Set<string>): Promise<void> {
+    protected async createStory(directoryName: string, componentName: string, files: Set<string>): Promise<void> {
         if (!this.options.story) {
             return;
         }
 
         await Log.animate('Creating story', async () => {
-            const storyFiles = Template.instantiate(templatePath('component-story'), 'src/components', {
-                component: { name: componentName },
+            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,
+                    slug: stringToSlug(componentName),
+                },
             });
 
             storyFiles.forEach((file) => files.add(file));

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

@@ -1,7 +1,7 @@
 import { describe, it } from 'vitest';
+import { formatCodeBlock } from '@noeldemartin/utils';
 
 import FileMock from '@/lib/File.mock';
-import { formatCodeBlock } from '@/lib/utils/format';
 
 import { GenerateModelCommand } from './generate-model';
 

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-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

@@ -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>();
@@ -123,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.test.ts

@@ -1,12 +1,13 @@
 import { describe, it } from 'vitest';
 
+import FileMock from '@/lib/File.mock';
 import ShellMock from '@/lib/Shell.mock';
 
 import { InstallCommand } from './install';
 
 describe('Install plugin command', () => {
 
-    it('installs plugins', async () => {
+    it('installs solid', async () => {
         // Act
         await InstallCommand.run('solid');
 
@@ -15,4 +16,26 @@ describe('Install plugin command', () => {
         ShellMock.expectRan('npm install @aerogel/plugin-solid@next --save-exact');
     });
 
+    it('installs soukai', async () => {
+        // Act
+        await InstallCommand.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('histoire');
+
+        // Assert
+        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

@@ -31,15 +31,17 @@ 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`));
                     file.match(/\.(ts|js|vue)$/) && usingESLint && (await Shell.run(`npx eslint ${file} --fix`));
-                }),
-            );
+                };
+
+            await Promise.all(arrayFrom(this.modifiedFiles).map(async (file) => formatFile(file)));
         });
     }
 

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);