@aerogel/cli 0.0.0-next.c8f032a868370824898e171969aec1bb6827688e → 0.0.0-next.f16bd1d894543c5303039c49f6f33488a1ffe931

package/src/commands/generate-model.ts

@@ -4,7 +4,8 @@ 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 { formatCodeBlock } from '@/lib/utils/format';
 import type { CommandOptions } from '@/commands/Command';
 
 interface Options {
@@ -14,7 +15,7 @@ interface Options {
 export class GenerateModelCommand extends Command {
 
     public static command: string = 'generate:model';
-    public static description: string = 'Generate an AerogelJS model';
+    public static description: string = 'Generate an AerogelJS Model';
     public static parameters: [string, string][] = [['name', 'Model name']];
     public static options: CommandOptions = {
         fields: 'Create model with the given fields',
@@ -37,15 +38,19 @@ export class GenerateModelCommand extends Command {
             Log.fail(`${this.name} model already exists!`);
         }
 
-        const files = Template.instantiate(basePath('templates/model'), 'src/models', {
-            model: {
-                name: this.name,
-                fieldsDefinition: this.getFieldsDefinition(),
-            },
-            soukaiImports: this.options.fields ? 'FieldType, defineModelSchema' : 'defineModelSchema',
-        });
+        this.assertSoukaiInstalled();
+
+        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}`);
     }
@@ -58,16 +63,37 @@ export class GenerateModelCommand extends Command {
         const code = this.options.fields
             .split(',')
             .map((field) => {
-                const [name, type] = field.split(':');
+                const [name, type, rules] = field.split(':');
 
                 return {
                     name,
                     type: stringToStudlyCase(type ?? 'string'),
+                    required: rules === 'required',
                 };
             })
-            .reduce((definition, field) => definition + `\n${field.name}: FieldType.${field.type},`, '');
+            .reduce((definition, field) => {
+                const fieldDefinition = field.required
+                    ? formatCodeBlock(`
+                        ${field.name}: {
+                            type: FieldType.${field.type},
+                            required: true,
+                        }
+                    `)
+                    : `${field.name}: FieldType.${field.type}`;
+
+                return definition + `\n${fieldDefinition},`;
+            }, '');
 
         return formatCodeBlock(code, { indent: 8 });
     }
 
+    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 running:
+                npx ag install soukai
+            `);
+        }
+    }
+
 }

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,152 @@
+import { arrayFrom, 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 { 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']];
+
+    private name: string;
+
+    constructor(name: string) {
+        super();
+
+        this.name = name;
+    }
+
+    public 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() === 'bootstrapApplication',
+            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,18 @@
+import { describe, it } from 'vitest';
+
+import ShellMock from '@/lib/Shell.mock';
+
+import { InstallCommand } from './install';
+
+describe('Install plugin command', () => {
+
+    it('installs plugins', 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');
+    });
+
+});

package/src/commands/install.ts

@@ -0,0 +1,32 @@
+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';
+
+const plugins = [new Soukai(), new Solid()].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']];
+
+    private plugin: Plugin;
+
+    constructor(plugin: string) {
+        super();
+
+        this.plugin =
+            plugins[plugin] ??
+            Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
+    }
+
+    public async run(): Promise<void> {
+        await this.plugin.install();
+    }
+
+}

package/src/lib/App.ts

@@ -3,23 +3,85 @@ import { stringToSlug } from '@noeldemartin/utils';
 import File from '@/lib/File';
 import Log from '@/lib/Log';
 import Template from '@/lib/Template';
-import { basePath } from '@/lib/utils';
+import { packNotFound, packagePackPath, packagePath, templatePath } from '@/lib/utils/paths';
+import { Editor } from '@/lib/Editor';
+
+interface Dependencies {
+    aerogelCli: string;
+    aerogelCore: string;
+    aerogelCypress: string;
+    aerogelPluginI18n: string;
+    aerogelPluginSoukai: string;
+    aerogelVite: string;
+}
+
+export interface Options {
+    local?: boolean;
+    linkedLocal?: boolean;
+}
 
 export default class App {
 
-    constructor(public name: string) {}
+    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(basePath('templates/app'), path, {
+        Template.instantiate(templatePath('app'), path, {
             app: {
                 name: this.name,
                 slug: stringToSlug(this.name),
             },
+            dependencies: this.getDependencies(),
+            contentPath: this.options.linkedLocal
+                ? `${packagePath('core')}/dist/**/*.js`
+                : './node_modules/@aerogel/core/dist/**/*.js',
         });
     }
 
+    public edit(): Editor {
+        return new Editor();
+    }
+
+    protected getDependencies(): Dependencies {
+        const withFilePrefix = <T extends Record<string, string>>(paths: T) =>
+            Object.entries(paths).reduce(
+                (pathsWithFile, [name, path]) => Object.assign(pathsWithFile, { [name]: `file:${path}` }) as T,
+                {} as T,
+            );
+
+        if (this.options.linkedLocal) {
+            return withFilePrefix({
+                aerogelCli: packagePath('cli'),
+                aerogelCore: packagePath('core'),
+                aerogelCypress: packagePath('cypress'),
+                aerogelPluginI18n: packagePath('plugin-i18n'),
+                aerogelPluginSoukai: packagePath('plugin-soukai'),
+                aerogelVite: packagePath('vite'),
+            });
+        }
+
+        if (this.options.local) {
+            return withFilePrefix({
+                aerogelCli: packagePackPath('cli') ?? packNotFound('cli'),
+                aerogelCore: packagePackPath('core') ?? packNotFound('core'),
+                aerogelCypress: packagePackPath('cypress') ?? packNotFound('cypress'),
+                aerogelPluginI18n: packagePackPath('plugin-i18n') ?? packNotFound('plugin-i18n'),
+                aerogelPluginSoukai: packagePackPath('plugin-soukai') ?? packNotFound('plugin-soukai'),
+                aerogelVite: packagePackPath('vite') ?? packNotFound('vite'),
+            });
+        }
+
+        return {
+            aerogelCli: 'next',
+            aerogelCore: 'next',
+            aerogelCypress: 'next',
+            aerogelPluginI18n: 'next',
+            aerogelPluginSoukai: 'next',
+            aerogelVite: 'next',
+        };
+    }
+
 }

package/src/lib/Editor.ts

@@ -0,0 +1,51 @@
+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';
+
+export class Editor {
+
+    private project: Project;
+    private modifiedFiles: Set<string>;
+
+    constructor() {
+        this.project = new Project({ tsConfigFilePath: 'tsconfig.json' });
+        this.modifiedFiles = new Set();
+
+        this.project.addSourceFilesAtPaths('src/**/*.ts');
+        this.project.addSourceFilesAtPaths('tailwind.config.js');
+        this.project.addSourceFilesAtPaths('vite.config.ts');
+    }
+
+    public addSourceFile(path: string): void {
+        this.project.addSourceFilesAtPaths(path);
+    }
+
+    public requireSourceFile(path: string): SourceFile {
+        return this.project.getSourceFileOrThrow(path);
+    }
+
+    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) => {
+                    usingPrettier && (await Shell.run(`npx prettier ${file} --write`));
+                    usingESLint && (await Shell.run(`npx eslint ${file} --fix`));
+                }),
+            );
+        });
+    }
+
+    public async save(file: SourceFile): Promise<void> {
+        await file.save();
+
+        this.modifiedFiles.add(file.getFilePath());
+    }
+
+}

package/src/lib/File.ts

@@ -4,10 +4,20 @@ import { dirname, resolve } from 'path';
 
 export class FileService {
 
+    public contains(path: string, contents: string): boolean {
+        return !!this.read(path)?.includes(contents);
+    }
+
     public exists(path: string): boolean {
         return existsSync(path);
     }
 
+    public isSymlink(path: string): boolean {
+        const stats = lstatSync(path);
+
+        return stats.isSymbolicLink();
+    }
+
     public read(path: string): string | null {
         if (!this.isFile(path)) {
             return null;

package/src/lib/Log.mock.ts

@@ -1,5 +1,5 @@
 import { expect } from 'vitest';
-import { arrayFrom, facade } from '@noeldemartin/utils';
+import { facade } from '@noeldemartin/utils';
 
 import { LogService } from './Log';
 
@@ -11,14 +11,23 @@ export class LogServiceMock extends LogService {
         expect(this.logs, `Expected message "${message}" to have been logged`).toContain(message);
     }
 
-    protected log(messages: string | string[]): void {
-        this.logs.push(...arrayFrom(messages));
+    public expectLogLength(count: number): void {
+        expect(this.logs, `Expected log to have length ${count}`).toHaveLength(count);
     }
 
-    public fail(message: string): void {
+    protected logLine(message: string): void {
+        this.logs.push(message);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public fail<T = any>(message: string): T {
         throw new Error(`Fail: ${message}`);
     }
 
+    public reset(): void {
+        this.logs = [];
+    }
+
     protected stdout(): void {
         //
     }

package/src/lib/Log.test.ts

@@ -5,12 +5,11 @@ import LogMock from '@/lib/Log.mock';
 
 import Log from './Log';
 
+const info = hex('#00ffff');
+
 describe('Log', () => {
 
     it('renders markdown bold', () => {
-        // Arrange
-        const info = hex('#00ffff');
-
         // Act
         Log.info('Foo **bar**');
 
@@ -18,4 +17,21 @@ describe('Log', () => {
         LogMock.expectLogged(info(`Foo ${bold('bar')}`));
     });
 
+    it('renders multiline messages', () => {
+        // Act
+        Log.info(`
+            This is multiline,
+                but the indentation should be respected.
+
+            As well as the new lines.
+        `);
+
+        // Assert
+        LogMock.expectLogLength(4);
+        LogMock.expectLogged(info('This is multiline,'));
+        LogMock.expectLogged(info('    but the indentation should be respected.'));
+        LogMock.expectLogged(info(''));
+        LogMock.expectLogged(info('As well as the new lines.'));
+    });
+
 });

package/src/lib/Log.ts

@@ -1,4 +1,4 @@
-import { arrayFrom, facade, stringMatchAll } from '@noeldemartin/utils';
+import { facade, stringMatchAll } from '@noeldemartin/utils';
 import { bold, hex } from 'chalk';
 import { clearLine, cursorTo } from 'readline';
 
@@ -9,8 +9,9 @@ export class LogService {
     protected renderError = hex('#ff0000');
 
     public async animate<T>(message: string, operation: () => Promise<T>): Promise<T> {
-        const updateStdout = (end: string = '') => {
-            const progress = this.renderInfo(this.renderMarkdown(message) + '.'.repeat(frame % 4)) + end;
+        const updateStdout = (end: string = '', done: boolean = false) => {
+            const progress =
+                this.renderInfo(this.renderMarkdown(message) + (done ? '...' : '.'.repeat(frame % 4))) + end;
 
             this.stdout(progress);
         };
@@ -23,33 +24,28 @@ export class LogService {
         const result = await operation();
 
         clearInterval(interval);
-        updateStdout('\n');
+        updateStdout('\n', true);
 
         return result;
     }
 
-    public info(messages: string | string[]): void {
-        arrayFrom(messages).forEach((message) => {
-            this.log(this.renderInfo(this.renderMarkdown(message)));
-        });
+    public info(message: string): void {
+        this.log(this.renderMarkdown(message), this.renderInfo);
     }
 
-    public error(messages: string | string[]): void {
-        arrayFrom(messages).forEach((message) => {
-            this.log(this.renderError(this.renderMarkdown(message)));
-        });
+    public error(message: string): void {
+        this.log(this.renderMarkdown(message), this.renderError);
     }
 
-    public fail(messages: string | string[]): void {
-        this.error(messages);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public fail<T = any>(message: string): T {
+        this.error(message);
 
         process.exit(1);
     }
 
-    public success(messages: string | string[]): void {
-        arrayFrom(messages).forEach((message) => {
-            this.log(this.renderSuccess(this.renderMarkdown(message)));
-        });
+    public success(message: string): void {
+        this.log(this.renderMarkdown(message), this.renderSuccess);
     }
 
     protected renderMarkdown(message: string): string {
@@ -62,9 +58,29 @@ export class LogService {
         return message;
     }
 
-    protected log(messages: string | string[]): void {
+    protected log(message: string, formatMessage?: (message: string) => string): void {
+        this.formatMessage(message).forEach((line) => {
+            this.logLine(formatMessage ? formatMessage(line) : line);
+        });
+    }
+
+    protected formatMessage(message: string): string[] {
+        if (message[0] === '\n') {
+            message = message.slice(1).trimEnd();
+
+            const lines = message.split('\n');
+            const firstLetter = message.trim()[0] ?? '';
+            const indentation = lines.find((line) => line.trim().length > 0)?.indexOf(firstLetter) ?? 0;
+
+            return lines.map((line) => line.slice(indentation));
+        }
+
+        return [message];
+    }
+
+    protected logLine(line: string): void {
         // eslint-disable-next-line no-console
-        arrayFrom(messages).forEach((message) => console.log(message));
+        console.log(line);
     }
 
     protected stdout(message: string): void {

package/src/lib/Template.ts

@@ -25,10 +25,11 @@ export default class Template {
                 file.substring(this.path.length + 1),
             );
             const fileContents = readFileSync(file).toString();
+            const filePath =
+                destination + (relativePath.endsWith('.template') ? relativePath.slice(0, -9) : relativePath);
 
-            File.write(destination + relativePath, render(fileContents, replacements, undefined, ['<%', '%>']));
-
-            files.push(destination + relativePath);
+            File.write(filePath, render(fileContents, replacements, undefined, ['<%', '%>']));
+            files.push(filePath);
         }
 
         return files;

package/src/lib/utils/app.ts

@@ -0,0 +1,15 @@
+import App from '@/lib/App';
+import File from '@/lib/File';
+
+export function app(): App {
+    // TODO parse app name
+    return new App('');
+}
+
+export function isLocalApp(): boolean {
+    return File.contains('package.json', 'file');
+}
+
+export function isLinkedLocalApp(): boolean {
+    return File.isSymlink('node_modules/@aerogel/core');
+}