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

package/src/commands/install.test.ts

@@ -0,0 +1,41 @@
+import { describe, it } from 'vitest';
+
+import FileMock from '@/lib/File.mock';
+import ShellMock from '@/lib/Shell.mock';
+
+import { InstallCommand } from './install';
+
+describe('Install plugin command', () => {
+
+    it('installs solid', async () => {
+        // Act
+        await InstallCommand.run('solid');
+
+        // Assert
+        ShellMock.expectRan('npm install soukai-solid@next --save-exact');
+        ShellMock.expectRan('npm install @aerogel/plugin-solid@next --save-exact');
+    });
+
+    it('installs soukai', async () => {
+        // Act
+        await InstallCommand.run('soukai');
+
+        // Assert
+        ShellMock.expectRan('npm install soukai@next --save-exact');
+        ShellMock.expectRan('npm install @aerogel/plugin-soukai@next --save-exact');
+    });
+
+    it('installs histoire', async () => {
+        // Arrange
+        FileMock.stub('package.json', '"@aerogel/core"');
+
+        // Act
+        await InstallCommand.run('histoire');
+
+        // Assert
+        ShellMock.expectRan('npm install histoire@0.17.6 --save-dev');
+        ShellMock.expectRan('npm install @aerogel/histoire@next --save-exact --save-dev');
+        ShellMock.expectRan('npm install patch-package --save-dev');
+    });
+
+});

package/src/commands/install.ts

@@ -0,0 +1,33 @@
+import Command from '@/commands/Command';
+import Log from '@/lib/Log';
+import { Histoire } from '@/plugins/Histoire';
+import { Solid } from '@/plugins/Solid';
+import { Soukai } from '@/plugins/Soukai';
+import type Plugin from '@/plugins/Plugin';
+
+const plugins = [new Soukai(), new Solid(), new Histoire()].reduce(
+    (pluginsObject, plugin) => Object.assign(pluginsObject, { [plugin.name]: plugin }),
+    {} as Record<string, Plugin>,
+);
+
+export class InstallCommand extends Command {
+
+    protected static command: string = 'install';
+    protected static description: string = 'Install an AerogelJS plugin';
+    protected static parameters: [string, string][] = [['plugin', 'Plugin to install']];
+
+    private plugin: Plugin;
+
+    constructor(plugin: string) {
+        super();
+
+        this.plugin =
+            plugins[plugin] ??
+            Log.fail(`Plugin '${plugin}' doesn't exist. Available plugins: ${Object.keys(plugins).join(', ')}`);
+    }
+
+    protected async run(): Promise<void> {
+        await this.plugin.install();
+    }
+
+}

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,58 @@
+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');
+        this.project.addSourceFilesAtPaths('package.json');
+    }
+
+    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') || 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`));
+                    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.addModifiedFile(file.getFilePath());
+    }
+
+    public addModifiedFile(path: string): void {
+        this.modifiedFiles.add(path);
+    }
+
+}

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/Shell.mock.ts

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

package/src/lib/Template.ts

@@ -6,7 +6,11 @@ import File from '@/lib/File';
 
 export default class Template {
 
-    public static instantiate(path: string, destination: string, replacements: Record<string, unknown>): string[] {
+    public static instantiate(
+        path: string,
+        destination: string = './',
+        replacements: Record<string, unknown> = {},
+    ): string[] {
         const template = new Template(path);
 
         return template.instantiate(destination, replacements);
@@ -25,10 +29,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', '"@aerogel/core": "file:');
+}
+
+export function isLinkedLocalApp(): boolean {
+    return File.isSymlink('node_modules/@aerogel/core');
+}

package/src/lib/utils/edit.ts

@@ -0,0 +1,44 @@
+import { arrayFrom } from '@noeldemartin/utils';
+import type { Node, SyntaxKind } from 'ts-morph';
+
+export function editFiles(): boolean {
+    // TODO mock editor instead of relying on this for unit tests
+    return true;
+}
+
+export function findDescendant<T extends Node>(
+    node: Node | undefined,
+    options: {
+        guard?: (node: Node | undefined) => node is T;
+        validate?: (node: T) => boolean;
+        skip?: SyntaxKind | SyntaxKind[];
+    } = {},
+): T | undefined {
+    if (!node) {
+        return;
+    }
+
+    const guard = options.guard ?? (() => true);
+    const validate = options.validate ?? (() => true);
+    const skipKinds = arrayFrom(options.skip ?? []);
+
+    return node.forEachDescendant((descendant, traversal) => {
+        if (guard(descendant) && validate(descendant)) {
+            return descendant;
+        }
+
+        const descendantKind = descendant.getKind();
+
+        if (skipKinds.includes(descendantKind)) {
+            traversal.skip();
+        }
+    });
+}
+
+export function when<T extends Node>(node: Node | undefined, assertion: (node: Node) => node is T): T | undefined {
+    if (!node || !assertion(node)) {
+        return;
+    }
+
+    return node as T;
+}

package/src/lib/utils/paths.ts

@@ -0,0 +1,34 @@
+import { resolve } from 'path';
+import { stringMatch } from '@noeldemartin/utils';
+
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+
+export function basePath(path: string = ''): string {
+    if (File.contains(resolve(__dirname, '../../../package.json'), '"name": "aerogel"')) {
+        return resolve(__dirname, '../', path);
+    }
+
+    const packageJson = File.read(resolve(__dirname, '../../../../package.json'));
+    const matches = stringMatch<2>(packageJson ?? '', /"@aerogel\/core": "file:(.*)\/aerogel-core-[\d.]*\.tgz"/);
+    const cliPath = matches?.[1] ?? Log.fail<string>('Could not determine base path');
+
+    return resolve(cliPath, path);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function packNotFound(packageName: string): any {
+    return Log.fail(`Could not find ${packageName} pack file, did you run 'npm pack'?`);
+}
+
+export function packagePackPath(packageName: string): string | null {
+    return File.getFiles(packagePath(packageName)).find((file) => file.endsWith('.tgz')) ?? null;
+}
+
+export function packagePath(packageName: string): string {
+    return basePath(`../${packageName}`);
+}
+
+export function templatePath(name: string): string {
+    return resolve(__dirname, `../templates/${name}`);
+}

package/src/plugins/Histoire.ts

@@ -0,0 +1,105 @@
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+import Template from '@/lib/Template';
+import { isLinkedLocalApp } from '@/lib/utils/app';
+import { packagePath, templatePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export class Histoire extends Plugin {
+
+    private installedPatchPackage: boolean = false;
+    private installedPostCSSPseudoClasses: boolean = false;
+
+    constructor() {
+        super('histoire');
+    }
+
+    public async beforeInstall(): Promise<void> {
+        this.installedPatchPackage = false;
+        this.installedPostCSSPseudoClasses = false;
+    }
+
+    protected async afterInstall(): Promise<void> {
+        if (!this.installedPatchPackage) {
+            return;
+        }
+
+        await Log.animate('Patching dependencies', async () => {
+            await Shell.run('npx patch-package');
+        });
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateTailwindConfig(editor, {
+            content: isLinkedLocalApp()
+                ? `'${packagePath('histoire')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/histoire/dist/**/*.js\'',
+        });
+
+        await this.updateNpmScripts(editor);
+        await this.createConfigFiles();
+        await super.updateFiles(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        // We need this specific version because we're patching it using patch-package
+        await Shell.run('npm install histoire@0.17.6 --save-dev');
+
+        if (!File.contains('package.json', '"patch-package"')) {
+            await Shell.run('npm install patch-package --save-dev');
+
+            this.installedPatchPackage = true;
+        }
+
+        if (!File.contains('package.json', '"postcss-pseudo-classes"')) {
+            await Shell.run('npm install postcss-pseudo-classes --save-dev');
+
+            this.installedPostCSSPseudoClasses = true;
+        }
+
+        await super.installNpmDependencies();
+    }
+
+    protected getLocalPackageName(): string {
+        return this.name;
+    }
+
+    protected async updateNpmScripts(editor: Editor): Promise<void> {
+        Log.info('Updating npm scripts...');
+
+        const packageJson = File.read('package.json');
+
+        if (!packageJson) {
+            return Log.fail('Could not find package.json file');
+        }
+
+        File.write(
+            'package.json',
+            packageJson.replace(
+                '"lint": "noeldemartin-lint src",',
+                this.installedPatchPackage
+                    ? '"histoire": "histoire dev", "lint": "noeldemartin-lint src", "postinstall": "patch-package",'
+                    : '"histoire": "histoire dev", "lint": "noeldemartin-lint src",',
+            ),
+        );
+
+        editor.addModifiedFile('package.json');
+    }
+
+    protected async createConfigFiles(): Promise<void> {
+        Log.info('Creating config files...');
+
+        Template.instantiate(templatePath('histoire'));
+
+        if (this.installedPostCSSPseudoClasses) {
+            Template.instantiate(templatePath('postcss-pseudo-classes'));
+        }
+    }
+
+    protected isForDevelopment(): boolean {
+        return true;
+    }
+
+}