@aerogel/cli 0.0.0-next.0be1479064cfd43fb6eafa2552cb7f8775554d93 → 0.0.0-next.0d1cf82f9dfbe1d3e7ec5644f85f97a43c8c2334

package/src/commands/generate-component.ts

@@ -1,29 +1,44 @@
-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';
 
-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 { editFiles, findDescendant } from '@/lib/utils/edit';
-import { basePath } from '@/lib/utils/paths';
-import type { CommandOptions } from '@/commands/Command';
+import Command from '@aerogel/cli/commands/Command';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Template from '@aerogel/cli/lib/Template';
+import { app } from '@aerogel/cli/lib/utils/app';
+import { editFiles, findDescendant } from '@aerogel/cli/lib/utils/edit';
+import { templatePath } from '@aerogel/cli/lib/utils/paths';
+import type { CommandOptions } from '@aerogel/cli/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 override command: string = 'generate:component';
+    protected static override description: string = 'Generate an AerogelJS Component';
+    protected static override parameters: [string, string][] = [
         ['path', 'Component path (relative to components folder; extension not necessary)'],
     ];
 
-    public static options: CommandOptions = {
+    protected static override 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 override 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 override 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,24 +100,42 @@ export class GenerateComponentCommand extends Command {
                 Log.fail(`${this.path} component already exists!`);
             }
 
-            const componentFiles = Template.instantiate(
-                basePath('templates/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(basePath('templates/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 FileMock from '@aerogel/cli/lib/File.mock';
 
 import { GenerateModelCommand } from './generate-model';
 

package/src/commands/generate-model.ts

@@ -1,12 +1,11 @@
-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 } from '@/lib/utils/paths';
-import { formatCodeBlock } from '@/lib/utils/format';
-import type { CommandOptions } from '@/commands/Command';
+import Command from '@aerogel/cli/commands/Command';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Template from '@aerogel/cli/lib/Template';
+import { templatePath } from '@aerogel/cli/lib/utils/paths';
+import type { CommandOptions } from '@aerogel/cli/commands/Command';
 
 interface Options {
     fields?: string;
@@ -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 override command: string = 'generate:model';
+    protected static override description: string = 'Generate an AerogelJS Model';
+    protected static override parameters: [string, string][] = [['name', 'Model name']];
+    protected static override 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 override async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/models');
 
         if (File.exists(`src/models/${this.name}.ts`)) {
@@ -41,7 +40,7 @@ export class GenerateModelCommand extends Command {
         this.assertSoukaiInstalled();
 
         const filesList = await Log.animate('Creating model', async () => {
-            const files = Template.instantiate(basePath('templates/model'), 'src/models', {
+            const files = Template.instantiate(templatePath('model'), 'src/models', {
                 model: {
                     name: this.name,
                     fieldsDefinition: this.getFieldsDefinition(),
@@ -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 '@aerogel/cli/commands/Command';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Template from '@aerogel/cli/lib/Template';
+import { templatePath } from '@aerogel/cli/lib/utils/paths';
+import type { CommandOptions } from '@aerogel/cli/commands/Command';
+
+export interface Options {
+    story?: boolean;
+}
+
+export class GenerateOverridesCommand extends Command {
+
+    protected static override command: string = 'generate:overrides';
+    protected static override description: string = 'Generate AerogelJS component overrides';
+
+    protected static override options: CommandOptions = {
+        story: {
+            description: 'Create overrides story using Histoire',
+            type: 'boolean',
+        },
+    };
+
+    private options: Options;
+
+    constructor(options: Options = {}) {
+        super();
+
+        this.options = options;
+    }
+
+    protected override 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

@@ -1,6 +1,6 @@
 import { describe, it } from 'vitest';
 
-import FileMock from '@/lib/File.mock';
+import FileMock from '@aerogel/cli/lib/File.mock';
 
 import { GenerateServiceCommand } from './generate-service';
 
@@ -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,22 +1,21 @@
-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';
 
-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 { basePath } from '@/lib/utils/paths';
-import { editFiles, findDescendant } from '@/lib/utils/edit';
-import { formatCodeBlock } from '@/lib/utils/format';
-import type { Editor } from '@/lib/Editor';
+import Command from '@aerogel/cli/commands/Command';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Template from '@aerogel/cli/lib/Template';
+import { app } from '@aerogel/cli/lib/utils/app';
+import { templatePath } from '@aerogel/cli/lib/utils/paths';
+import { editFiles, findDescendant } from '@aerogel/cli/lib/utils/edit';
+import type { Editor } from '@aerogel/cli/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 override command: string = 'generate:service';
+    protected static override description: string = 'Generate an AerogelJS Service';
+    protected static override 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 override async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/services');
 
         const files = new Set<string>();
@@ -52,7 +51,7 @@ export class GenerateServiceCommand extends Command {
                 Log.fail(`${this.name} service already exists!`);
             }
 
-            const serviceFiles = Template.instantiate(basePath('templates/service'), 'src/services', {
+            const serviceFiles = Template.instantiate(templatePath('service'), 'src/services', {
                 service: {
                     name: this.name,
                 },
@@ -96,8 +95,8 @@ export class GenerateServiceCommand extends Command {
 
                 export type AppServices = typeof services;
 
-                declare module '@vue/runtime-core' {
-                    interface ComponentCustomProperties extends AppServices {}
+                declare module '@aerogel/core' {
+                    interface Services extends AppServices {}
                 }
             `),
         );
@@ -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,15 @@
+import { URL, fileURLToPath } from 'node:url';
+
+import Command from '@aerogel/cli/commands/Command';
+import Log from '@aerogel/cli/lib/Log';
+export class InfoCommand extends Command {
+
+    protected static override command: string = 'info';
+    protected static override description: string = 'Show debugging information about the CLI';
+
+    protected override async run(): Promise<void> {
+        Log.info('[AerogelJS CLI info]');
+        Log.info('Installation directory: ' + fileURLToPath(new URL(/* @vite-ignore */ './', import.meta.url)));
+    }
+
+}

package/src/commands/install.test.ts

@@ -1,18 +1,27 @@
 import { describe, it } from 'vitest';
 
-import ShellMock from '@/lib/Shell.mock';
+import ShellMock from '@aerogel/cli/lib/Shell.mock';
 
 import { InstallCommand } from './install';
 
 describe('Install plugin command', () => {
 
-    it('installs plugins', async () => {
+    it('installs solid', async () => {
         // Act
         await InstallCommand.run('solid');
 
         // Assert
-        ShellMock.expectRan('npm install soukai-solid@next');
-        ShellMock.expectRan('npm install @aerogel/plugin-solid@next');
+        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');
     });
 
 });

package/src/commands/install.ts

@@ -1,8 +1,8 @@
-import Command from '@/commands/Command';
-import Log from '@/lib/Log';
-import { Solid } from '@/plugins/Solid';
-import { Soukai } from '@/plugins/Soukai';
-import type Plugin from '@/plugins/Plugin';
+import Command from '@aerogel/cli/commands/Command';
+import Log from '@aerogel/cli/lib/Log';
+import { Solid } from '@aerogel/cli/plugins/Solid';
+import { Soukai } from '@aerogel/cli/plugins/Soukai';
+import type Plugin from '@aerogel/cli/plugins/Plugin';
 
 const plugins = [new Soukai(), new Solid()].reduce(
     (pluginsObject, plugin) => Object.assign(pluginsObject, { [plugin.name]: plugin }),
@@ -11,9 +11,9 @@ const plugins = [new Soukai(), new Solid()].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 override command: string = 'install';
+    protected static override description: string = 'Install an AerogelJS plugin';
+    protected static override parameters: [string, string][] = [['plugin', 'Plugin to install']];
 
     private plugin: Plugin;
 
@@ -25,7 +25,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 override async run(): Promise<void> {
         await this.plugin.install();
     }
 

package/src/lib/App.ts

@@ -1,10 +1,10 @@
 import { stringToSlug } from '@noeldemartin/utils';
 
-import File from '@/lib/File';
-import Log from '@/lib/Log';
-import Template from '@/lib/Template';
-import { cliBasePath, packNotFound, packagePackPath, packagePath } from '@/lib/utils/paths';
-import { Editor } from '@/lib/Editor';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Template from '@aerogel/cli/lib/Template';
+import { packNotFound, packagePackPath, packagePath, templatePath } from '@aerogel/cli/lib/utils/paths';
+import { Editor } from '@aerogel/cli/lib/Editor';
 
 interface Dependencies {
     aerogelCli: string;
@@ -22,14 +22,17 @@ export interface Options {
 
 export default class App {
 
-    constructor(protected name: string, protected options: Options = {}) {}
+    constructor(
+        protected name: string,
+        protected options: Options = {},
+    ) {}
 
     public create(path: string): void {
         if (File.exists(path) && (!File.isDirectory(path) || !File.isEmptyDirectory(path))) {
             Log.fail(`Folder at '${path}' already exists!`);
         }
 
-        Template.instantiate(cliBasePath('templates/app'), path, {
+        Template.instantiate(templatePath('app'), path, {
             app: {
                 name: this.name,
                 slug: stringToSlug(this.name),

package/src/lib/Editor.ts

@@ -2,9 +2,9 @@ import { arrayFrom } from '@noeldemartin/utils';
 import { Project } from 'ts-morph';
 import type { SourceFile } from 'ts-morph';
 
-import File from '@/lib/File';
-import Log from '@/lib/Log';
-import Shell from '@/lib/Shell';
+import File from '@aerogel/cli/lib/File';
+import Log from '@aerogel/cli/lib/Log';
+import Shell from '@aerogel/cli/lib/Shell';
 
 export class Editor {
 
@@ -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/File.mock.ts

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

package/src/lib/File.ts

@@ -1,6 +1,6 @@
-import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'fs';
+import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
 import { facade } from '@noeldemartin/utils';
-import { dirname, resolve } from 'path';
+import { dirname, resolve } from 'node:path';
 
 export class FileService {
 
@@ -73,4 +73,4 @@ export class FileService {
 
 }
 
-export default facade(new FileService());
+export default facade(FileService);