@aerogel/cli 0.0.0-next.a5b6ecb68fdca29d00c8b8906d00aa5bf64a9d7c → 0.0.0-next.b3caf219a503ce9b8c65ef1463132c9507f56c0a

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

@@ -1,20 +1,12 @@
-import { beforeEach, describe, it } from 'vitest';
+import { describe, it } from 'vitest';
 import { formatCodeBlock } from '@noeldemartin/utils';
 
-import FileMock from '@/lib/File.mock';
-import { stubCommandRunner } from '@/testing/utils';
-import type { StubCommandRunner } from '@/testing/utils';
+import FileMock from '@aerogel/cli/lib/File.mock';
 
 import { GenerateModelCommand } from './generate-model';
 
 describe('Generate Model command', () => {
 
-    let run: StubCommandRunner<typeof GenerateModelCommand>;
-
-    beforeEach(() => {
-        run = stubCommandRunner(GenerateModelCommand);
-    });
-
     it('generates models', async () => {
         // Arrange
         FileMock.stub(
@@ -28,7 +20,7 @@ describe('Generate Model command', () => {
         );
 
         // Act
-        await run('FooBar', {
+        await GenerateModelCommand.run('FooBar', {
             fields: 'name:string:required,age:number,birth:Date',
         });
 

package/src/commands/generate-model.ts

@@ -1,11 +1,11 @@
 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 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;
@@ -13,10 +13,10 @@ interface Options {
 
 export class GenerateModelCommand extends Command {
 
-    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 = {
+    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',
     };
 
@@ -30,7 +30,7 @@ export class GenerateModelCommand extends Command {
         this.options = options;
     }
 
-    protected async run(): Promise<void> {
+    protected override 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 '@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,29 +1,21 @@
-import { beforeEach, describe, it } from 'vitest';
+import { describe, it } from 'vitest';
 
-import FileMock from '@/lib/File.mock';
-import { stubCommandRunner } from '@/testing/utils';
-import type { StubCommandRunner } from '@/testing/utils';
+import FileMock from '@aerogel/cli/lib/File.mock';
 
 import { GenerateServiceCommand } from './generate-service';
 
 describe('Generate Service command', () => {
 
-    let run: StubCommandRunner<typeof GenerateServiceCommand>;
-
-    beforeEach(() => {
-        run = stubCommandRunner(GenerateServiceCommand);
-    });
-
     it('generates services', async () => {
         // Arrange
         FileMock.stub('package.json', '@aerogel/core');
 
         // Act
-        await run('FooBar');
+        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());');
+        FileMock.expectCreated('src/services/FooBar.ts').toContain('export default facade(FooBarService);');
     });
 
 });

package/src/commands/generate-service.ts

@@ -2,20 +2,20 @@ import { arrayFrom, formatCodeBlock, stringToCamelCase } from '@noeldemartin/uti
 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';
+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 {
 
-    protected static command: string = 'generate:service';
-    protected static description: string = 'Generate an AerogelJS Service';
-    protected 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;
 
@@ -25,7 +25,7 @@ export class GenerateServiceCommand extends Command {
         this.name = name;
     }
 
-    protected async run(): Promise<void> {
+    protected override async run(): Promise<void> {
         this.assertAerogelOrDirectory('src/services');
 
         const files = new Set<string>();
@@ -95,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 {}
                 }
             `),
         );
@@ -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,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,23 +1,14 @@
-import { beforeEach, describe, it } from 'vitest';
+import { describe, it } from 'vitest';
 
-import FileMock from '@/lib/File.mock';
-import ShellMock from '@/lib/Shell.mock';
-import { stubCommandRunner } from '@/testing/utils';
-import type { StubCommandRunner } from '@/testing/utils';
+import ShellMock from '@aerogel/cli/lib/Shell.mock';
 
 import { InstallCommand } from './install';
 
 describe('Install plugin command', () => {
 
-    let run: StubCommandRunner<typeof InstallCommand>;
-
-    beforeEach(() => {
-        run = stubCommandRunner(InstallCommand);
-    });
-
     it('installs solid', async () => {
         // Act
-        await run('solid');
+        await InstallCommand.run('solid');
 
         // Assert
         ShellMock.expectRan('npm install soukai-solid@next --save-exact');
@@ -26,24 +17,11 @@ describe('Install plugin command', () => {
 
     it('installs soukai', async () => {
         // Act
-        await run('soukai');
+        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 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,20 +1,19 @@
-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(
+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 }),
     {} 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']];
+    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;
 
@@ -26,7 +25,7 @@ export class InstallCommand extends Command {
             Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
     }
 
-    protected 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 { packNotFound, packagePackPath, packagePath, templatePath } 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,7 +22,10 @@ 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))) {

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 {
 
@@ -16,7 +16,6 @@ export class Editor {
         this.modifiedFiles = new Set();
 
         this.project.addSourceFilesAtPaths('src/**/*.ts');
-        this.project.addSourceFilesAtPaths('tailwind.config.js');
         this.project.addSourceFilesAtPaths('vite.config.ts');
         this.project.addSourceFilesAtPaths('package.json');
     }

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

package/src/lib/Log.mock.ts

@@ -15,23 +15,19 @@ export class LogServiceMock extends LogService {
         expect(this.logs, `Expected log to have length ${count}`).toHaveLength(count);
     }
 
-    protected logLine(message: string): void {
+    protected override logLine(message: string): void {
         this.logs.push(message);
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public fail<T = any>(message: string): T {
+    public override fail<T = any>(message: string): T {
         throw new Error(`Fail: ${message}`);
     }
 
-    public reset(): void {
-        this.logs = [];
-    }
-
-    protected stdout(): void {
+    protected override stdout(): void {
         //
     }
 
 }
 
-export default facade(new LogServiceMock());
+export default facade(LogServiceMock);

package/src/lib/Log.test.ts

@@ -1,11 +1,11 @@
-import { bold, hex } from 'chalk';
+import chalk from 'chalk';
 import { describe, it } from 'vitest';
 
-import LogMock from '@/lib/Log.mock';
+import LogMock from '@aerogel/cli/lib/Log.mock';
 
 import Log from './Log';
 
-const info = hex('#00ffff');
+const info = chalk.hex('#00ffff');
 
 describe('Log', () => {
 
@@ -14,7 +14,7 @@ describe('Log', () => {
         Log.info('Foo **bar**');
 
         // Assert
-        LogMock.expectLogged(info(`Foo ${bold('bar')}`));
+        LogMock.expectLogged(info(`Foo ${chalk.bold('bar')}`));
     });
 
     it('renders multiline messages', () => {

package/src/lib/Log.ts

@@ -1,12 +1,12 @@
+import chalk from 'chalk';
+import { clearLine, cursorTo } from 'node:readline';
 import { facade, stringMatchAll } from '@noeldemartin/utils';
-import { bold, hex } from 'chalk';
-import { clearLine, cursorTo } from 'readline';
 
 export class LogService {
 
-    protected renderInfo = hex('#00ffff');
-    protected renderSuccess = hex('#00ff00');
-    protected renderError = hex('#ff0000');
+    protected renderInfo = chalk.hex('#00ffff');
+    protected renderSuccess = chalk.hex('#00ff00');
+    protected renderError = chalk.hex('#ff0000');
 
     public async animate<T>(message: string, operation: () => Promise<T>): Promise<T> {
         const updateStdout = (end: string = '', done: boolean = false) => {
@@ -52,7 +52,7 @@ export class LogService {
         const matches = stringMatchAll<2>(message, /\*\*(.*)\*\*/g);
 
         for (const match of matches) {
-            message = message.replace(match[0], bold(match[1]));
+            message = message.replace(match[0], chalk.bold(match[1]));
         }
 
         return message;
@@ -92,4 +92,4 @@ export class LogService {
 
 }
 
-export default facade(new LogService());
+export default facade(LogService);

package/src/lib/Shell.mock.ts

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

package/src/lib/Shell.ts

@@ -1,4 +1,4 @@
-import { exec } from 'child_process';
+import { exec } from 'node:child_process';
 import { facade } from '@noeldemartin/utils';
 
 export class ShellService {
@@ -25,4 +25,4 @@ export class ShellService {
 
 }
 
-export default facade(new ShellService());
+export default facade(ShellService);