@aerogel/cli 0.0.0-next.0dddfa5a33f1886a059ceb0950867ddcfa86480d → 0.0.0-next.1cf8c4f815a37b577f7a1c1e2538b0d08f4e585c

package/src/commands/generate-component.ts

@@ -1,4 +1,4 @@
-import { arrayFilter, arrayFrom, stringToSlug } from '@noeldemartin/utils';
+import { arrayFrom, stringToSlug } from '@noeldemartin/utils';
 import { Node, SyntaxKind } from 'ts-morph';
 import type { ArrayLiteralExpression, CallExpression, SourceFile } from 'ts-morph';
 
@@ -9,7 +9,6 @@ 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;
@@ -26,52 +25,21 @@ export class GenerateComponentCommand extends Command {
         ['path', 'Component path (relative to components folder; extension not necessary)'],
     ];
 
-    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',
-        },
-    };
-
     private path: string;
-    private options: Options;
 
-    constructor(path: string, options: Options = {}) {
+    constructor(path: string) {
         super();
 
         this.path = path;
-        this.options = options;
-    }
-
-    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();
 
         const files = new Set<string>();
         const [directoryName, componentName] = this.parsePathComponents();
 
         await this.createComponent(directoryName, componentName, files);
-        await this.createStory(directoryName, componentName, files);
         await this.declareComponents();
 
         const filesList = arrayFrom(files)
@@ -81,33 +49,13 @@ export class GenerateComponentCommand extends Command {
         Log.info(`${componentName} component created successfully! The following files were created:\n\n${filesList}`);
     }
 
-    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 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'
-                    : this.options.checkbox
-                        ? 'component-checkbox'
-                        : 'component';
-            const componentFiles = Template.instantiate(templatePath(templateName), `src/components/${directoryName}`, {
+            const componentFiles = Template.instantiate(templatePath('component'), `src/components/${directoryName}`, {
                 component: {
                     name: componentName,
                     slug: stringToSlug(componentName),
@@ -118,30 +66,6 @@ export class GenerateComponentCommand extends Command {
         });
     }
 
-    protected async createStory(directoryName: string, componentName: string, files: Set<string>): Promise<void> {
-        if (!this.options.story) {
-            return;
-        }
-
-        await Log.animate('Creating story', async () => {
-            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));
-        });
-    }
-
     protected async declareComponents(): Promise<void> {
         if (!editFiles()) {
             return;

package/src/commands/install.test.ts

@@ -1,27 +1,90 @@
-import { describe, it } from 'vitest';
+import { describe, expect, it } from 'vitest';
 
 import ShellMock from '@aerogel/cli/lib/Shell.mock';
+import FileMock from '@aerogel/cli/lib/File.mock';
 
 import { InstallCommand } from './install';
 
 describe('Install plugin command', () => {
 
     it('installs solid', async () => {
+        // Arrange
+        stubPackageJson();
+
         // 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');
+        ShellMock.expectRan('pnpm install --no-save');
+
+        expectPackageJson({
+            dependencies: {
+                '@aerogel/core': 'next',
+                '@aerogel/plugin-solid': 'next',
+                '@noeldemartin/solid-utils': 'next',
+                'soukai-solid': 'next',
+                'vue': '^3.5.13',
+            },
+        });
     });
 
     it('installs soukai', async () => {
+        // Arrange
+        stubPackageJson();
+
         // Act
-        await InstallCommand.run('soukai');
+        await InstallCommand.run('soukai', { skipInstall: true });
 
         // Assert
-        ShellMock.expectRan('npm install soukai@next --save-exact');
-        ShellMock.expectRan('npm install @aerogel/plugin-soukai@next --save-exact');
+        ShellMock.expectNotRan('pnpm install --no-save');
+
+        expectPackageJson({
+            dependencies: {
+                '@aerogel/core': 'next',
+                '@aerogel/plugin-soukai': 'next',
+                'soukai': 'next',
+                'vue': '^3.5.13',
+            },
+        });
+    });
+
+    it('installs local-first', async () => {
+        // Arrange
+        stubPackageJson();
+
+        // Act
+        await InstallCommand.run('local-first');
+
+        // Assert
+        ShellMock.expectRan('pnpm install --no-save');
+
+        expectPackageJson({
+            dependencies: {
+                '@aerogel/core': 'next',
+                '@aerogel/plugin-local-first': 'next',
+                'vue': '^3.5.13',
+            },
+        });
     });
 
 });
+
+function stubPackageJson(): void {
+    FileMock.stub(
+        'package.json',
+        JSON.stringify(
+            {
+                dependencies: {
+                    '@aerogel/core': 'next',
+                    'vue': '^3.5.13',
+                },
+            },
+            null,
+            2,
+        ),
+    );
+}
+
+function expectPackageJson(packageJson: object): void {
+    expect(JSON.parse(FileMock.read('package.json') ?? '{}')).toEqual(packageJson);
+}

package/src/commands/install.ts

@@ -1,32 +1,47 @@
 import Command from '@aerogel/cli/commands/Command';
+import LocalFirst from '@aerogel/cli/plugins/LocalFirst';
 import Log from '@aerogel/cli/lib/Log';
-import { Solid } from '@aerogel/cli/plugins/Solid';
-import { Soukai } from '@aerogel/cli/plugins/Soukai';
+import Solid from '@aerogel/cli/plugins/Solid';
+import Soukai from '@aerogel/cli/plugins/Soukai';
 import type Plugin from '@aerogel/cli/plugins/Plugin';
+import type { CommandOptions } from '@aerogel/cli/commands/Command';
 
-const plugins = [new Soukai(), new Solid()].reduce(
+const plugins = [new Soukai(), new Solid(), new LocalFirst()].reduce(
     (pluginsObject, plugin) => Object.assign(pluginsObject, { [plugin.name]: plugin }),
     {} as Record<string, Plugin>,
 );
+export interface Options {
+    skipInstall?: boolean;
+}
 
 export class InstallCommand extends Command {
 
     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']];
-
+    protected static override options: CommandOptions = {
+        skipInstall: {
+            type: 'boolean',
+            description: 'Skip installing dependencies, just add them to package.json',
+        },
+    };
+
+    private options: Options;
     private plugin: Plugin;
 
-    constructor(plugin: string) {
+    constructor(plugin: string, options: Options = {}) {
         super();
 
+        this.options = options;
         this.plugin =
             plugins[plugin] ??
             Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
     }
 
     protected override async run(): Promise<void> {
-        await this.plugin.install();
+        await this.plugin.install({
+            skipInstall: this.options.skipInstall,
+        });
     }
 
 }

package/src/lib/App.ts

@@ -1,19 +1,11 @@
-import { stringToSlug } from '@noeldemartin/utils';
+import { resolve } from 'node:path';
 
 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;
-    aerogelCore: string;
-    aerogelCypress: string;
-    aerogelPluginI18n: string;
-    aerogelPluginSoukai: string;
-    aerogelVite: string;
-}
+import { simpleGit } from 'simple-git';
 
 export interface Options {
     local?: boolean;
@@ -27,28 +19,42 @@ export default class App {
         protected options: Options = {},
     ) {}
 
-    public create(path: string): void {
+    public async create(path: string): Promise<void> {
         if (File.exists(path) && (!File.isDirectory(path) || !File.isEmptyDirectory(path))) {
             Log.fail(`Folder at '${path}' already exists!`);
         }
 
-        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',
+        // Clone repository
+        await simpleGit().clone('https://github.com/NoelDeMartin/aerogel-template.git', path, {
+            '--depth': 1,
         });
+
+        File.delete(resolve(path, '.git'));
+
+        // Apply replacements
+        const dependencies = this.getDependencies();
+
+        File.replace(
+            resolve(path, 'vite.config.ts'),
+            'Aerogel({ name: \'Aerogel\' })',
+            `Aerogel({ name: '${this.name}' })`,
+        );
+
+        File.replace(resolve(path, 'src/lang/en.yaml'), 'title: \'App\'', `title: '${this.name}'`);
+
+        for (const [name, version] of Object.entries(dependencies)) {
+            File.replace(resolve(path, 'package.json'), new RegExp(`"${name}": ".*?"`, 'g'), `"${name}": "${version}"`);
+        }
+
+        // Copy template
+        Template.instantiate(templatePath('app'), path, { app: { name: this.name } });
     }
 
     public edit(): Editor {
         return new Editor();
     }
 
-    protected getDependencies(): Dependencies {
+    protected getDependencies(): Record<string, string> {
         const withFilePrefix = <T extends Record<string, string>>(paths: T) =>
             Object.entries(paths).reduce(
                 (pathsWithFile, [name, path]) => Object.assign(pathsWithFile, { [name]: `file:${path}` }) as T,
@@ -57,34 +63,27 @@ export default class App {
 
         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'),
+                '@aerogel/cli': packagePath('cli'),
+                '@aerogel/core': packagePath('core'),
+                '@aerogel/cypress': packagePath('cypress'),
+                '@aerogel/plugin-i18n': packagePath('plugin-i18n'),
+                '@aerogel/plugin-soukai': packagePath('plugin-soukai'),
+                '@aerogel/vite': 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'),
+                '@aerogel/cli': packagePackPath('cli') ?? packNotFound('cli'),
+                '@aerogel/core': packagePackPath('core') ?? packNotFound('core'),
+                '@aerogel/cypress': packagePackPath('cypress') ?? packNotFound('cypress'),
+                '@aerogel/plugin-i18n': packagePackPath('plugin-i18n') ?? packNotFound('plugin-i18n'),
+                '@aerogel/plugin-soukai': packagePackPath('plugin-soukai') ?? packNotFound('plugin-soukai'),
+                '@aerogel/vite': packagePackPath('vite') ?? packNotFound('vite'),
             });
         }
 
-        return {
-            aerogelCli: 'next',
-            aerogelCore: 'next',
-            aerogelCypress: 'next',
-            aerogelPluginI18n: 'next',
-            aerogelPluginSoukai: 'next',
-            aerogelVite: 'next',
-        };
+        return {};
     }
 
 }

package/src/lib/Editor.ts

@@ -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,6 +8,12 @@ export class FileMockService extends FileService {
 
     private virtualFilesystem: Record<string, string | { directory: true }> = {};
 
+    public override delete(path: string): void {
+        if (path in this.virtualFilesystem) {
+            delete this.virtualFilesystem[path];
+        }
+    }
+
     public override exists(path: string): boolean {
         return super.exists(path) || path in this.virtualFilesystem;
     }

package/src/lib/File.ts

@@ -1,7 +1,17 @@
-import { existsSync, lstatSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
-import { facade } from '@noeldemartin/utils';
+import {
+    existsSync,
+    lstatSync,
+    mkdirSync,
+    readFileSync,
+    readdirSync,
+    rmdirSync,
+    unlinkSync,
+    writeFileSync,
+} from 'node:fs';
 import { dirname, resolve } from 'node:path';
 
+import { facade } from '@noeldemartin/utils';
+
 export class FileService {
 
     public contains(path: string, contents: string): boolean {
@@ -12,6 +22,16 @@ export class FileService {
         return existsSync(path);
     }
 
+    public delete(path: string): void {
+        if (this.isDirectory(path)) {
+            rmdirSync(path, { recursive: true });
+
+            return;
+        }
+
+        unlinkSync(path);
+    }
+
     public isSymlink(path: string): boolean {
         const stats = lstatSync(path);
 
@@ -26,6 +46,16 @@ export class FileService {
         return readFileSync(path).toString();
     }
 
+    public replace(path: string, search: string | RegExp, replacement: string): void {
+        const contents = this.read(path);
+
+        if (!contents) {
+            return;
+        }
+
+        this.write(path, contents.replaceAll(search, replacement));
+    }
+
     public getFiles(directoryPath: string): string[] {
         const children = readdirSync(directoryPath, { withFileTypes: true });
         const files: string[] = [];

package/src/lib/Shell.mock.ts

@@ -15,6 +15,10 @@ export class ShellServiceMock extends ShellService {
         expect(this.history, `expected '${command}' command to have been executed`).toContain(command);
     }
 
+    public expectNotRan(command: string): void {
+        expect(this.history, `expected '${command}' command to not have been executed`).not.toContain(command);
+    }
+
 }
 
 export default facade(ShellServiceMock);

package/src/lib/utils/paths.ts

@@ -6,6 +6,10 @@ import File from '@aerogel/cli/lib/File';
 import Log from '@aerogel/cli/lib/Log';
 
 export function basePath(path: string = ''): string {
+    if (process.env.AEROGEL_BASE_PATH) {
+        return resolve(process.env.AEROGEL_BASE_PATH, path);
+    }
+
     if (
         File.contains(
             fileURLToPath(new URL(/* @vite-ignore */ '../../../package.json', import.meta.url)),

package/src/plugins/LocalFirst.ts

@@ -0,0 +1,9 @@
+import Plugin from '@aerogel/cli/plugins/Plugin';
+
+export default class LocalFirst extends Plugin {
+
+    constructor() {
+        super('local-first');
+    }
+
+}

package/src/plugins/Plugin.ts

@@ -1,10 +1,12 @@
 import { Node, SyntaxKind } from 'ts-morph';
+import { stringToCamelCase } from '@noeldemartin/utils';
 import type { ArrayLiteralExpression, ImportDeclarationStructure, OptionalKind, SourceFile } from 'ts-morph';
 
 import Log from '@aerogel/cli/lib/Log';
 import Shell from '@aerogel/cli/lib/Shell';
 import File from '@aerogel/cli/lib/File';
 import { app, isLinkedLocalApp, isLocalApp } from '@aerogel/cli/lib/utils/app';
+import { addNpmDependency } from '@aerogel/cli/utils/package';
 import { editFiles, findDescendant, when } from '@aerogel/cli/lib/utils/edit';
 import { packNotFound, packagePackPath, packagePath } from '@aerogel/cli/lib/utils/paths';
 import type { Editor } from '@aerogel/cli/lib/Editor';
@@ -17,15 +19,21 @@ export default abstract class Plugin {
         this.name = name;
     }
 
-    public async install(): Promise<void> {
+    public async install(options: { skipInstall?: boolean } = {}): Promise<void> {
         this.assertNotInstalled();
 
         await this.beforeInstall();
-        await this.installDependencies();
+        await this.addDependencies();
+
+        if (!options.skipInstall) {
+            await this.installDependencies();
+        }
 
         if (editFiles()) {
             const editor = app().edit();
 
+            editor.addSourceFile('package.json');
+
             await this.updateFiles(editor);
             await editor.format();
         }
@@ -49,23 +57,32 @@ export default abstract class Plugin {
         // Placeholder for overrides, don't place any functionality here.
     }
 
+    protected async addDependencies(): Promise<void> {
+        Log.info('Adding plugin dependencies');
+        this.addNpmDependencies();
+    }
+
     protected async installDependencies(): Promise<void> {
         await Log.animate('Installing plugin dependencies', async () => {
-            await this.installNpmDependencies();
+            await Shell.run('pnpm install --no-save');
         });
     }
 
     protected async updateFiles(editor: Editor): Promise<void> {
-        if (!this.isForDevelopment()) {
-            await this.updateBootstrapConfig(editor);
+        if (this.isForDevelopment()) {
+            return;
         }
-    }
 
-    protected async installNpmDependencies(): Promise<void> {
-        const flags = this.isForDevelopment() ? '--save-dev' : '';
+        await this.updateBootstrapConfig(editor);
+    }
 
+    protected addNpmDependencies(): void {
         if (isLinkedLocalApp()) {
-            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())} ${flags}`);
+            addNpmDependency(
+                this.getNpmPackageName(),
+                `file:${packagePath(this.getLocalPackageName())}`,
+                this.isForDevelopment(),
+            );
 
             return;
         }
@@ -73,12 +90,12 @@ export default abstract class Plugin {
         if (isLocalApp()) {
             const packPath = packagePackPath(this.getLocalPackageName()) ?? packNotFound(this.getLocalPackageName());
 
-            await Shell.run(`npm install file:${packPath} ${flags}`);
+            addNpmDependency(this.getNpmPackageName(), `file:${packPath}`, this.isForDevelopment());
 
             return;
         }
 
-        await Shell.run(`npm install ${this.getNpmPackageName()}@next --save-exact ${flags}`);
+        addNpmDependency(this.getNpmPackageName(), 'next', this.isForDevelopment());
     }
 
     protected async updateBootstrapConfig(editor: Editor): Promise<void> {
@@ -101,25 +118,6 @@ export default abstract class Plugin {
         });
     }
 
-    protected async updateTailwindConfig(editor: Editor, options: { content: string }): Promise<void> {
-        await Log.animate('Updating tailwind configuration', async () => {
-            const tailwindConfig = editor.requireSourceFile('tailwind.config.js');
-            const contentArray = this.getTailwindContentArray(tailwindConfig);
-
-            if (!contentArray) {
-                return Log.fail(`
-                    Could not find content array in tailwind config, please add the following manually:
-
-                    ${options.content}
-                `);
-            }
-
-            contentArray.addElement(options.content);
-
-            await editor.save(tailwindConfig);
-        });
-    }
-
     protected getBootstrapPluginsDeclaration(mainConfig: SourceFile): ArrayLiteralExpression | null {
         const bootstrapAppCall = findDescendant(mainConfig, {
             guard: Node.isCallExpression,
@@ -154,7 +152,7 @@ export default abstract class Plugin {
 
     protected getBootstrapImport(): OptionalKind<ImportDeclarationStructure> {
         return {
-            defaultImport: this.name,
+            defaultImport: stringToCamelCase(this.name),
             moduleSpecifier: `@aerogel/plugin-${this.name}`,
         };
     }
@@ -172,7 +170,7 @@ export default abstract class Plugin {
     }
 
     protected getBootstrapConfig(): string {
-        return `${this.name}()`;
+        return `${stringToCamelCase(this.name)}()`;
     }
 
 }