@aerogel/cli 0.0.0-next.926bde19326fe7b6b24b277666936862b64d8295 → 0.0.0-next.b58141fee5d2fe7d25debdbca6b1d2bf1c13e48e

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,56 @@
+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');
+            const usingESLint = File.exists('.eslintrc.js');
+
+            await Promise.all(
+                arrayFrom(this.modifiedFiles).map(async (file) => {
+                    usingPrettier && (await Shell.run(`npx prettier ${file} --write`));
+                    file.match(/\.(ts|js|vue)$/) && usingESLint && (await Shell.run(`npx eslint ${file} --fix`));
+                }),
+            );
+        });
+    }
+
+    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

@@ -12,6 +12,12 @@ export class FileService {
         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

@@ -19,7 +19,8 @@ export class LogServiceMock extends LogService {
         this.logs.push(message);
     }
 
-    public fail(message: string): void {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public fail<T = any>(message: string): T {
         throw new Error(`Fail: ${message}`);
     }
 

package/src/lib/Log.ts

@@ -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,7 +24,7 @@ export class LogService {
         const result = await operation();
 
         clearInterval(interval);
-        updateStdout('\n');
+        updateStdout('\n', true);
 
         return result;
     }
@@ -36,7 +37,8 @@ export class LogService {
         this.log(this.renderMarkdown(message), this.renderError);
     }
 
-    public fail(message: string): void {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    public fail<T = any>(message: string): T {
         this.error(message);
 
         process.exit(1);

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');
+}

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.test.ts → utils/format.test.ts}

@@ -1,8 +1,8 @@
 import { describe, expect, it } from 'vitest';
 
-import { formatCodeBlock } from './utils';
+import { formatCodeBlock } from './format';
 
-describe('Utils', () => {
+describe('Format utils', () => {
 
     it('Formats code blocks', () => {
         // Arrange

package/src/lib/{utils.ts → utils/format.ts}

@@ -1,13 +1,7 @@
-import { resolve } from 'path';
-
 export interface FormatCodeBlockOptions {
     indent?: number;
 }
 
-export function basePath(path: string): string {
-    return resolve(__dirname, '../', path);
-}
-
 export function formatCodeBlock(code: string, options: FormatCodeBlockOptions = {}): string {
     const lines = code.split('\n');
     const indent = options.indent ?? 0;

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\/cli": "file:(.*)\/aerogel-cli-[\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/Plugin.ts

@@ -0,0 +1,125 @@
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ArrayLiteralExpression, ImportDeclarationStructure, OptionalKind, SourceFile } from 'ts-morph';
+
+import Log from '@/lib/Log';
+import Shell from '@/lib/Shell';
+import File from '@/lib/File';
+import { app, isLinkedLocalApp, isLocalApp } from '@/lib/utils/app';
+import { editFiles, findDescendant, when } from '@/lib/utils/edit';
+import { packNotFound, packagePackPath, packagePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export default abstract class Plugin {
+
+    public readonly name: string;
+
+    constructor(name: string) {
+        this.name = name;
+    }
+
+    public async install(): Promise<void> {
+        this.assertNotInstalled();
+
+        await this.installDependencies();
+
+        if (editFiles()) {
+            const editor = app().edit();
+
+            await this.updateFiles(editor);
+            await editor.format();
+        }
+
+        Log.info(`Plugin ${this.name} installed!`);
+    }
+
+    protected assertNotInstalled(): void {
+        if (File.contains('package.json', `"${this.getNpmPackageName()}"`)) {
+            Log.fail(`${this.name} is already installed!`);
+        }
+    }
+
+    protected async installDependencies(): Promise<void> {
+        await Log.animate('Installing plugin dependencies', async () => {
+            await this.installNpmDependencies();
+        });
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateBootstrapConfig(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        if (isLinkedLocalApp()) {
+            await Shell.run(`npm install file:${packagePath(this.getLocalPackageName())}`);
+
+            return;
+        }
+
+        if (isLocalApp()) {
+            const packPath = packagePackPath(this.getLocalPackageName()) ?? packNotFound(this.getLocalPackageName());
+
+            await Shell.run(`npm install file:${packPath}`);
+
+            return;
+        }
+
+        await Shell.run(`npm install ${this.getNpmPackageName()}@next --save-exact`);
+    }
+
+    protected async updateBootstrapConfig(editor: Editor): Promise<void> {
+        await Log.animate('Injecting plugin in bootstrap configuration', async () => {
+            const mainConfig = editor.requireSourceFile('src/main.ts');
+            const pluginsArray = this.getBootstrapPluginsDeclaration(mainConfig);
+
+            if (!pluginsArray) {
+                return Log.fail(`
+                    Could not find plugins array in bootstrap config, please add the following manually:
+
+                    ${this.getBootstrapConfig()}
+                `);
+            }
+
+            mainConfig.addImportDeclaration(this.getBootstrapImport());
+            pluginsArray.addElement(this.getBootstrapConfig());
+
+            await editor.save(mainConfig);
+        });
+    }
+
+    protected getBootstrapPluginsDeclaration(mainConfig: SourceFile): ArrayLiteralExpression | null {
+        const bootstrapAppCall = findDescendant(mainConfig, {
+            guard: Node.isCallExpression,
+            validate: (callExpression) => callExpression.getExpression().getText() === 'bootstrapApplication',
+            skip: SyntaxKind.ImportDeclaration,
+        });
+        const bootstrapOptions = bootstrapAppCall?.getArguments()[1];
+        const pluginsOption = when(bootstrapOptions, Node.isObjectLiteralExpression)?.getProperty('plugins');
+        const pluginsArray = when(pluginsOption, Node.isPropertyAssignment)?.getInitializer();
+
+        if (!Node.isArrayLiteralExpression(pluginsArray)) {
+            return null;
+        }
+
+        return pluginsArray;
+    }
+
+    protected getBootstrapImport(): OptionalKind<ImportDeclarationStructure> {
+        return {
+            defaultImport: this.name,
+            moduleSpecifier: `@aerogel/plugin-${this.name}`,
+        };
+    }
+
+    protected getNpmPackageName(): string {
+        return `@aerogel/${this.getLocalPackageName()}`;
+    }
+
+    protected getLocalPackageName(): string {
+        return `plugin-${this.name}`;
+    }
+
+    protected getBootstrapConfig(): string {
+        return `${this.name}()`;
+    }
+
+}

package/src/plugins/Solid.ts

@@ -0,0 +1,114 @@
+import { Node, SyntaxKind } from 'ts-morph';
+import type { ArrayLiteralExpression, SourceFile } from 'ts-morph';
+
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+import { findDescendant } from '@/lib/utils/edit';
+import { isLinkedLocalApp } from '@/lib/utils/app';
+import { packagePath } from '@/lib/utils/paths';
+import type { Editor } from '@/lib/Editor';
+
+export class Solid extends Plugin {
+
+    constructor() {
+        super('solid');
+    }
+
+    protected async updateFiles(editor: Editor): Promise<void> {
+        await this.updateTailwindConfig(editor);
+        await this.updateNpmScripts(editor);
+        await this.updateGitIgnore();
+        await super.updateFiles(editor);
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        await Shell.run('npm install soukai-solid@next --save-exact');
+        await Shell.run('npm install @solid/community-server@7 --save');
+        await super.installNpmDependencies();
+    }
+
+    protected async updateTailwindConfig(editor: Editor): Promise<void> {
+        await Log.animate('Updating tailwind configuration', async () => {
+            const tailwindConfig = editor.requireSourceFile('tailwind.config.js');
+            const contentArray = this.getTailwindContentArray(tailwindConfig);
+            const contentValue = isLinkedLocalApp()
+                ? `'${packagePath('plugin-solid')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/plugin-solid/dist/**/*.js\'';
+
+            if (!contentArray) {
+                return Log.fail(`
+                    Could not find content array in tailwind config, please add the following manually:
+
+                    ${contentValue}
+                `);
+            }
+
+            contentArray.addElement(contentValue);
+
+            await editor.save(tailwindConfig);
+        });
+    }
+
+    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(
+                    '"cy:dev": "concurrently --kill-others \\"npm run test:serve-app\\" \\"npm run cy:open\\"",',
+                    '"cy:dev": "concurrently --kill-others ' +
+                        '\\"npm run test:serve-app\\" \\"npm run test:serve-pod\\" \\"npm run cy:open\\"",',
+                )
+                .replace(
+                    '"cy:test": "start-server-and-test test:serve-app http-get://localhost:5001 cy:run",',
+                    '"cy:test": "start-server-and-test ' +
+                        'test:serve-app http-get://localhost:5001 test:serve-pod http-get://localhost:4000 cy:run",',
+                )
+                .replace(
+                    '"dev": "vite",',
+                    '"dev": "vite",\n' +
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -p 4000 -f ./solid-data",',
+                )
+                .replace(
+                    '"test:serve-app": "vite --port 5001"',
+                    '"test:serve-app": "vite --port 5001",\n' +
+                        '"test:serve-pod": "community-solid-server -p 4000 -l warn"',
+                ),
+        );
+
+        editor.addModifiedFile('package.json');
+    }
+
+    protected async updateGitIgnore(): Promise<void> {
+        Log.info('Updating .gitignore');
+
+        const gitignore = File.read('.gitignore') ?? '';
+
+        File.write('.gitignore', `${gitignore}/solid-data\n`);
+    }
+
+    protected getTailwindContentArray(tailwindConfig: SourceFile): ArrayLiteralExpression | null {
+        const contentAssignment = findDescendant(tailwindConfig, {
+            guard: Node.isPropertyAssignment,
+            validate: (propertyAssignment) => propertyAssignment.getName() === 'content',
+            skip: SyntaxKind.JSDoc,
+        });
+        const contentArray = contentAssignment?.getInitializer();
+
+        if (!Node.isArrayLiteralExpression(contentArray)) {
+            return null;
+        }
+
+        return contentArray;
+    }
+
+}

package/src/plugins/Soukai.ts

@@ -0,0 +1,19 @@
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+
+export class Soukai extends Plugin {
+
+    constructor() {
+        super('soukai');
+    }
+
+    protected async installNpmDependencies(): Promise<void> {
+        await Shell.run('npm install soukai@next --save-exact');
+        await super.installNpmDependencies();
+    }
+
+    protected getBootstrapConfig(): string {
+        return 'soukai({ models: import.meta.glob(\'@/models/*\', { eager: true }) })';
+    }
+
+}

package/src/testing/setup.ts

@@ -24,16 +24,46 @@ beforeEach(() => {
     Shell.mock();
 });
 
+vi.mock('@/lib/utils/app', async () => {
+    const original = (await vi.importActual('@/lib/utils/app')) as object;
+
+    return {
+        ...original,
+        isLocalApp: () => false,
+        isLinkedLocalApp: () => false,
+    };
+});
+
+vi.mock('@/lib/utils/edit', async () => {
+    const original = (await vi.importActual('@/lib/utils/edit')) as object;
+
+    return {
+        ...original,
+        editFiles: () => false,
+    };
+});
+
 // TODO find out why these need to be mocked
+vi.mock('@/lib/utils/paths', async () => {
+    const original = (await vi.importActual('@/lib/utils/paths')) as object;
+
+    function basePath(path: string = '') {
+        return resolve(__dirname, '../../', path);
+    }
+
+    function packagePath(packageName: string) {
+        return basePath(`../${packageName}`);
+    }
 
-vi.mock('@/lib/utils', async () => {
-    const utils = (await vi.importActual('@/lib/utils')) as object;
+    function templatePath(name: string = '') {
+        return resolve(__dirname, `../../templates/${name}`);
+    }
 
     return {
-        ...utils,
-        basePath(path: string) {
-            return resolve(__dirname, '../../', path);
-        },
+        ...original,
+        basePath,
+        packagePath,
+        templatePath,
     };
 });
 

package/templates/app/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['@noeldemartin/eslint-config-vue'],
+};

package/templates/app/.github/workflows/ci.yml

@@ -12,6 +12,18 @@ jobs:
                   node-version-file: '.nvmrc'
             - run: npm ci
             - run: npm run lint
-            - run: npm run test:ci
-            - run: npm run cy:test
             - run: npm run build
+            - run: npm run test:ci
+            - run: npm run cy:test-snapshots:ci
+            - name: Upload Cypress screenshots
+              uses: actions/upload-artifact@v3
+              if: ${{ failure() }}
+              with:
+                  name: cypress_screenshots
+                  path: cypress/screenshots
+            - name: Upload Cypress snapshots
+              uses: actions/upload-artifact@v3
+              if: ${{ failure() }}
+              with:
+                  name: cypress_snapshots
+                  path: cypress/snapshots

package/templates/app/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug Current Test File",
+            "autoAttachChildProcesses": true,
+            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+            "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+            "args": ["run", "${fileBasenameNoExtension}"],
+            "smartStep": true,
+            "console": "integratedTerminal"
+        }
+    ]
+}