@aerogel/cli 0.0.0-next.59bf5f7cc06e728d0cf6c00de28f1da48d7d6b8e → 0.0.0-next.702e17f12493b62feba1d0af54d7c3b1d07f934c

package/src/commands/generate-component.ts

@@ -1,23 +1,39 @@
+import { arrayFrom, stringToSlug } from '@noeldemartin/utils';
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ArrayLiteralExpression, CallExpression, SourceFile } from 'ts-morph';
+
 import Command from '@/commands/Command';
 import File from '@/lib/File';
 import Log from '@/lib/Log';
 import Template from '@/lib/Template';
-import { basePath } from '@/lib/utils';
+import { app } from '@/lib/utils/app';
+import { editFiles, findDescendant } from '@/lib/utils/edit';
+import { templatePath } from '@/lib/utils/paths';
 import type { CommandOptions } from '@/commands/Command';
 
 export interface Options {
+    button?: 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',
+        },
+        input: {
+            description: 'Create a custom input',
+            type: 'boolean',
+        },
         story: {
             description: 'Create component story using Histoire',
             type: 'boolean',
@@ -34,36 +50,150 @@ export class GenerateComponentCommand extends Command {
         this.options = options;
     }
 
-    public async run(): Promise<void> {
+    protected async validate(): Promise<void> {
+        if (this.options.button && this.options.input) {
+            Log.fail('Cannot use both \'button\' and \'input\' flags!');
+        }
+    }
+
+    protected async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/components');
-        this.options.story && this.assertHistoireInstalled();
+        this.assertHistoireInstalled();
+
+        const files = new Set<string>();
+        const [directoryName, componentName] = this.parsePathComponents();
 
-        if (File.exists(`src/components/${this.path}.vue`)) {
-            Log.fail(`${this.path} component already exists!`);
+        await this.createComponent(directoryName, componentName, files);
+        await this.createStory(directoryName, componentName, files);
+        await this.declareComponents();
+
+        const filesList = arrayFrom(files)
+            .map((file) => `- ${file}`)
+            .join('\n');
+
+        Log.info(`${componentName} component created successfully! The following files were created:\n\n${filesList}`);
+    }
+
+    protected assertHistoireInstalled(): void {
+        if (!this.options.story) {
+            return;
         }
 
-        const [directoryName, componentName] = this.parsePathComponents();
-        const files = Template.instantiate(basePath('templates/component'), `src/components/${directoryName}`, {
-            component: { name: componentName },
+        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 createComponent(directoryName: string, componentName: string, files: Set<string>): Promise<void> {
+        await Log.animate('Creating component', async () => {
+            if (File.exists(`src/components/${this.path}.vue`)) {
+                Log.fail(`${this.path} component already exists!`);
+            }
+
+            const templateName = this.options.input
+                ? 'component-input'
+                : this.options.button
+                    ? 'component-button'
+                    : '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(directoryName: string, componentName: string, files: Set<string>): Promise<void> {
+        if (!this.options.story) {
+            return;
+        }
 
-        if (this.options.story) {
-            const storyFiles = Template.instantiate(basePath('templates/component-story'), 'src/components', {
-                component: { name: componentName },
+        await Log.animate('Creating story', async () => {
+            const templateName = this.options.input
+                ? 'component-input-story'
+                : this.options.button
+                    ? 'component-button-story'
+                    : 'component-story';
+            const storyFiles = Template.instantiate(templatePath(templateName), `src/components/${directoryName}`, {
+                component: {
+                    name: componentName,
+                    slug: stringToSlug(componentName),
+                },
             });
 
-            files.push(...storyFiles);
+            storyFiles.forEach((file) => files.add(file));
+        });
+    }
+
+    protected async declareComponents(): Promise<void> {
+        if (!editFiles()) {
+            return;
         }
 
-        const filesList = files.map((file) => `- ${file}`).join('\n');
+        const editor = app().edit();
+        const viteConfig = editor.requireSourceFile('vite.config.ts');
+        const componentDirsArray = this.getComponentDirsArray(viteConfig);
 
-        Log.info(`${componentName} component created successfully! The following files were created:\n\n${filesList}`);
+        if (!componentDirsArray) {
+            return Log.fail('Could not find component dirs declaration in vite config!');
+        }
+
+        if (
+            componentDirsArray
+                .getDescendantsOfKind(SyntaxKind.StringLiteral)
+                .some((literal) => literal.getText() === '\'src/components\'')
+        ) {
+            return;
+        }
+
+        await Log.animate('Updating vite config', async () => {
+            componentDirsArray.addElement('\'src/components\'');
+
+            await editor.save(viteConfig);
+        });
+
+        await editor.format();
     }
 
-    protected assertHistoireInstalled(): void {
-        if (!File.exists('src/main.histoire.ts')) {
-            Log.fail('Histoire is not installed yet!');
+    protected getComponentDirsArray(viteConfig: SourceFile): ArrayLiteralExpression | null {
+        const pluginCall = findDescendant(viteConfig, {
+            guard: Node.isCallExpression,
+            validate: (callExpression) => callExpression.getText().startsWith('Components('),
+            skip: SyntaxKind.ImportDeclaration,
+        });
+
+        if (!pluginCall) {
+            return null;
+        }
+
+        const dirsAssignment = findDescendant(pluginCall, {
+            guard: Node.isPropertyAssignment,
+            validate: (propertyAssignment) => propertyAssignment.getName() === 'dirs',
+        });
+
+        const dirsArray = dirsAssignment?.getInitializer();
+
+        if (!Node.isArrayLiteralExpression(dirsArray)) {
+            return this.declareComponentDirsArray(pluginCall);
         }
+
+        return dirsArray;
+    }
+
+    protected declareComponentDirsArray(pluginCall: CallExpression): ArrayLiteralExpression | null {
+        const pluginOptions = findDescendant(pluginCall, { guard: Node.isObjectLiteralExpression });
+        const dirsAssignment = pluginOptions?.addPropertyAssignment({
+            name: 'dirs',
+            initializer: '[]',
+        });
+
+        return (dirsAssignment?.getInitializer() as ArrayLiteralExpression) ?? null;
     }
 
     protected parsePathComponents(): [string, string] {

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

@@ -1,11 +1,11 @@
 import { describe, it } from 'vitest';
+import { formatCodeBlock } from '@noeldemartin/utils';
 
 import FileMock from '@/lib/File.mock';
-import { formatCodeBlock } from '@/lib/utils';
 
 import { GenerateModelCommand } from './generate-model';
 
-describe('Generate model command', () => {
+describe('Generate Model command', () => {
 
     it('generates models', async () => {
         // Arrange

package/src/commands/generate-model.ts

@@ -1,10 +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 { basePath, formatCodeBlock } from '@/lib/utils';
+import { templatePath } from '@/lib/utils/paths';
 import type { CommandOptions } from '@/commands/Command';
 
 interface Options {
@@ -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`)) {
@@ -39,15 +39,17 @@ export class GenerateModelCommand extends Command {
 
         this.assertSoukaiInstalled();
 
-        const files = Template.instantiate(basePath('templates/model'), 'src/models', {
-            model: {
-                name: this.name,
-                fieldsDefinition: this.getFieldsDefinition(),
-            },
-            soukaiImports: this.options.fields ? 'FieldType, defineModelSchema' : 'defineModelSchema',
-        });
+        const filesList = await Log.animate('Creating model', async () => {
+            const files = Template.instantiate(templatePath('model'), 'src/models', {
+                model: {
+                    name: this.name,
+                    fieldsDefinition: this.getFieldsDefinition(),
+                },
+                soukaiImports: this.options.fields ? 'FieldType, defineModelSchema' : 'defineModelSchema',
+            });
 
-        const filesList = files.map((file) => `- ${file}`).join('\n');
+            return files.map((file) => `- ${file}`).join('\n');
+        });
 
         Log.info(`${this.name} model created successfully! The following files were created:\n\n${filesList}`);
     }
@@ -87,13 +89,8 @@ export class GenerateModelCommand extends Command {
     protected assertSoukaiInstalled(): void {
         if (!File.contains('package.json', '"soukai"') && !File.contains('package.json', '"@aerogel/plugin-soukai"')) {
             Log.fail(`
-                Soukai is not installed yet! You can install it doing the following:
-
-                1. Run the following command:
-                    npm install soukai @aerogel/plugin-soukai@next
-
-                2. Add this to your plugins array in src/main.ts:
-                    soukai({ models: import.meta.glob('@/models/*', { eager: true }) })
+                Soukai is not installed yet! You can install it running:
+                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

@@ -0,0 +1,21 @@
+import { describe, it } from 'vitest';
+
+import FileMock from '@/lib/File.mock';
+
+import { GenerateServiceCommand } from './generate-service';
+
+describe('Generate Service command', () => {
+
+    it('generates services', async () => {
+        // Arrange
+        FileMock.stub('package.json', '@aerogel/core');
+
+        // Act
+        await GenerateServiceCommand.run('FooBar');
+
+        // Assert
+        FileMock.expectCreated('src/services/FooBar.ts').toContain('class FooBarService extends Service');
+        FileMock.expectCreated('src/services/FooBar.ts').toContain('export default facade(new FooBarService());');
+    });
+
+});

package/src/commands/generate-service.ts

@@ -0,0 +1,151 @@
+import { arrayFrom, formatCodeBlock, stringToCamelCase } from '@noeldemartin/utils';
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ObjectLiteralExpression, SourceFile } from 'ts-morph';
+
+import Command from '@/commands/Command';
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+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 type { Editor } from '@/lib/Editor';
+
+export class GenerateServiceCommand extends Command {
+
+    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;
+
+    constructor(name: string) {
+        super();
+
+        this.name = name;
+    }
+
+    protected async run(): Promise<void> {
+        this.assertAerogelOrDirectory('src/services');
+
+        const files = new Set<string>();
+        const editor = app().edit();
+
+        await this.createService(files);
+
+        if (editFiles()) {
+            await this.registerService(editor);
+            await editor.format();
+        }
+
+        const filesList = arrayFrom(files)
+            .map((file) => `- ${file}`)
+            .join('\n');
+
+        Log.info(`${this.name} service created successfully! The following files were created:\n\n${filesList}`);
+    }
+
+    protected async createService(files: Set<string>): Promise<void> {
+        await Log.animate('Creating service', async () => {
+            if (File.exists(`src/services/${this.name}.ts`)) {
+                Log.fail(`${this.name} service already exists!`);
+            }
+
+            const serviceFiles = Template.instantiate(templatePath('service'), 'src/services', {
+                service: {
+                    name: this.name,
+                },
+            });
+
+            serviceFiles.forEach((file) => files.add(file));
+        });
+    }
+
+    protected async registerService(editor: Editor): Promise<void> {
+        await Log.animate('Registering service', async () => {
+            if (!File.exists('src/services/index.ts')) {
+                await this.createServicesIndex(editor);
+            }
+
+            const servicesIndex = editor.requireSourceFile('src/services/index.ts');
+            const servicesObject = this.getServicesObject(servicesIndex);
+
+            if (!servicesObject) {
+                return Log.fail('Could not find services object in services config, please add it manually.');
+            }
+
+            servicesIndex.addImportDeclaration({
+                defaultImport: this.name,
+                moduleSpecifier: `./${this.name}`,
+            });
+            servicesObject.addPropertyAssignment({
+                name: `$${stringToCamelCase(this.name)}`,
+                initializer: this.name,
+            });
+
+            await editor.save(servicesIndex);
+        });
+    }
+
+    protected async createServicesIndex(editor: Editor): Promise<void> {
+        File.write(
+            'src/services/index.ts',
+            formatCodeBlock(`
+                export const services = {};
+
+                export type AppServices = typeof services;
+
+                declare module '@vue/runtime-core' {
+                    interface ComponentCustomProperties extends AppServices {}
+                }
+            `),
+        );
+
+        editor.addSourceFile('src/services/index.ts');
+
+        const mainConfig = editor.requireSourceFile('src/main.ts');
+        const bootstrapOptions = this.getBootstrapOptions(mainConfig);
+
+        if (!bootstrapOptions) {
+            return Log.fail('Could not find options object in bootstrap config, please add the services manually.');
+        }
+
+        bootstrapOptions.insertShorthandPropertyAssignment(0, { name: 'services' });
+        mainConfig.addImportDeclaration({
+            namedImports: ['services'],
+            moduleSpecifier: './services',
+        });
+
+        await editor.save(mainConfig);
+    }
+
+    protected getBootstrapOptions(mainConfig: SourceFile): ObjectLiteralExpression | null {
+        const bootstrapAppCall = findDescendant(mainConfig, {
+            guard: Node.isCallExpression,
+            validate: (callExpression) => callExpression.getExpression().getText() === 'bootstrap',
+            skip: SyntaxKind.ImportDeclaration,
+        });
+        const bootstrapOptions = bootstrapAppCall?.getArguments()[1];
+
+        if (!Node.isObjectLiteralExpression(bootstrapOptions)) {
+            return null;
+        }
+
+        return bootstrapOptions;
+    }
+
+    protected getServicesObject(servicesIndex: SourceFile): ObjectLiteralExpression | null {
+        const servicesDeclaration = findDescendant(servicesIndex, {
+            guard: Node.isVariableDeclaration,
+            validate: (variableDeclaration) => variableDeclaration.getName() === 'services',
+        });
+        const servicesObject = servicesDeclaration?.getInitializer();
+
+        if (!Node.isObjectLiteralExpression(servicesObject)) {
+            return null;
+        }
+
+        return servicesObject;
+    }
+
+}

package/src/commands/install.test.ts

@@ -0,0 +1,41 @@
+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 solid', async () => {
+        // Act
+        await InstallCommand.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 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

@@ -0,0 +1,33 @@
+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(), new Histoire()].reduce(
+    (pluginsObject, plugin) => Object.assign(pluginsObject, { [plugin.name]: plugin }),
+    {} as Record<string, Plugin>,
+);
+
+export class InstallCommand extends Command {
+
+    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;
+
+    constructor(plugin: string) {
+        super();
+
+        this.plugin =
+            plugins[plugin] ??
+            Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
+    }
+
+    protected async run(): Promise<void> {
+        await this.plugin.install();
+    }
+
+}