@aerogel/cli 0.0.0-next.59bf5f7cc06e728d0cf6c00de28f1da48d7d6b8e → 0.0.0-next.6c02970f90d4e979a72530f1fa0c650785d6538f

package/src/plugins/Solid.ts

@@ -0,0 +1,79 @@
+import File from '@/lib/File';
+import Log from '@/lib/Log';
+import Plugin from '@/plugins/Plugin';
+import Shell from '@/lib/Shell';
+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, {
+            content: isLinkedLocalApp()
+                ? `'${packagePath('plugin-solid')}/dist/**/*.js'`
+                : '\'./node_modules/@aerogel/plugin-solid/dist/**/*.js\'',
+        });
+
+        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 @noeldemartin/solid-utils@next --save-exact');
+        await Shell.run('npm install @solid/community-server@7 --save');
+        await super.installNpmDependencies();
+    }
+
+    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:3000 cy:run",',
+                )
+                .replace(
+                    '"dev": "vite",',
+                    '"dev": "vite",\n' +
+                        '"dev:serve-pod": "community-solid-server -c @css:config/file.json -f ./solid-data",',
+                )
+                .replace(
+                    '"test:serve-app": "vite --port 5001 --mode testing"',
+                    '"test:serve-app": "vite --port 5001 --mode testing",\n' +
+                        '"test:serve-pod": "community-solid-server -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`);
+    }
+
+}

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

@@ -11,29 +11,56 @@ import ShellMock from '@/lib/Shell.mock';
 
 setTestingNamespace(vi);
 
-File.setMockInstance(FileMock);
-Log.setMockInstance(LogMock);
-Shell.setMockInstance(ShellMock);
+File.setMockFacade(FileMock);
+Log.setMockFacade(LogMock);
+Shell.setMockFacade(ShellMock);
 
 beforeEach(() => {
-    FileMock.reset();
-    LogMock.reset();
-
     File.mock();
     Log.mock();
     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/.github/workflows/ci.yml

@@ -6,12 +6,24 @@ jobs:
     ci:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
                   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@v4
+              if: ${{ failure() }}
+              with:
+                  name: cypress_screenshots
+                  path: cypress/screenshots
+            - name: Upload Cypress snapshots
+              uses: actions/upload-artifact@v4
+              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"
+        }
+    ]
+}

package/templates/app/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "emeraldwalk.runonsave": {
+        "commands": [
+            {
+                "match": ".*",
+                "cmd": "npx prettier-eslint ${file} --write"
+            }
+        ]
+    }
+}

package/templates/app/README.md

@@ -0,0 +1,3 @@
+# <% app.name %>
+
+App created with [AerogelJS](https://aerogel.js.org)

package/templates/app/cypress/cypress.config.ts

@@ -0,0 +1,14 @@
+import { setupAerogelNodeEvents } from '@aerogel/cypress/config';
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+    e2e: {
+        baseUrl: 'http://localhost:5001',
+        video: false,
+        retries: {
+            runMode: 3,
+            openMode: 0,
+        },
+        setupNodeEvents: setupAerogelNodeEvents,
+    },
+});

package/templates/app/cypress/support/e2e.ts

@@ -1,3 +1 @@
-import install from '@aerogel/cypress';
-
-install();
+import '@aerogel/cypress/support';

package/templates/app/cypress/tsconfig.json

@@ -3,10 +3,12 @@
         "target": "es5",
         "lib": ["es5", "dom"],
         "types": ["cypress", "node"],
+        "strict": true,
         "baseUrl": ".",
         "paths": {
+            "@/*": ["../src/*"],
             "@cy/*": ["./*"]
         }
     },
-    "include": ["**/*.ts"]
+    "include": ["**/*.ts", "../src/**/*.ts"]
 }

package/templates/app/index.html

@@ -3,10 +3,11 @@
     <head>
         <meta charset="UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <title><% app.name %></title>
+        <title>{{ app.name }}</title>
+        {{ socialMeta() }}
     </head>
-    <body class="h-full w-full">
-        <div id="app" class="h-full"></div>
+    <body class="h-full w-full text-base font-normal leading-tight text-gray-900 antialiased">
+        <div id="app" class="loading h-full"></div>
         <script type="module" src="./src/main.ts"></script>
     </body>
 </html>

package/templates/app/package.json

@@ -5,40 +5,63 @@
     "scripts": {
         "build": "vite build",
         "cy:dev": "concurrently --kill-others \"npm run test:serve-app\" \"npm run cy:open\"",
-        "cy:open": "cypress open --e2e --browser chromium",
-        "cy:run": "cypress run",
+        "cy:open": "cypress open --config-file ./cypress/cypress.config.ts --e2e --browser chromium",
+        "cy:run": "cypress run --config-file ./cypress/cypress.config.ts",
         "cy:test": "start-server-and-test test:serve-app http-get://localhost:5001 cy:run",
+        "cy:test-snapshots": "docker run -it -u `id -u ${whoami}` -e CYPRESS_SNAPSHOTS=true -v ./:/app -w /app cypress/base:18.16.0 sh -c \"npx cypress install && npm run cy:test\"",
+        "cy:test-snapshots:ci": "docker run -e CYPRESS_SNAPSHOTS=true -v ./:/app -w /app cypress/base:18.16.0 sh -c \"npx cypress install && npm run cy:test\"",
         "dev": "vite",
-        "lint": "noeldemartin-lint src",
+        "lint": "noeldemartin-lint src cypress",
         "test": "vitest --run",
         "test:ci": "vitest --run --reporter verbose",
-        "test:serve-app": "vite --port 5001"
+        "test:serve-app": "vite --port 5001 --mode testing"
     },
     "dependencies": {
-        "@aerogel/core": "<% #local %>file:<% &local.aerogelPath %>/core<% /local %><% ^local %>next<% /local %>",
-        "@aerogel/plugin-i18n": "<% #local %>file:<% &local.aerogelPath %>/plugin-i18n<% /local %><% ^local %>next<% /local %>",
-        "@aerogel/plugin-soukai": "<% #local %>file:<% &local.aerogelPath %>/plugin-soukai<% /local %><% ^local %>next<% /local %>",
+        "@aerogel/core": "<% &dependencies.aerogelCore %>",
+        "@aerogel/plugin-i18n": "<% &dependencies.aerogelPluginI18n %>",
+        "@aerogel/plugin-soukai": "<% &dependencies.aerogelPluginSoukai %>",
         "@intlify/unplugin-vue-i18n": "^0.12.2",
         "@noeldemartin/utils": "next",
         "@tailwindcss/forms": "^0.5.3",
         "@tailwindcss/typography": "^0.5.9",
+        "soukai": "next",
         "tailwindcss": "^3.3.2",
         "vue": "^3.3.0",
         "vue-i18n": "9.3.0-beta.19"
     },
     "devDependencies": {
-        "@aerogel/cli": "<% #local %>file:<% &local.aerogelPath %>/cli<% /local %><% ^local %>next<% /local %>",
-        "@aerogel/cypress": "<% #local %>file:<% &local.aerogelPath %>/cypress<% /local %><% ^local %>next<% /local %>",
-        "@aerogel/vite": "<% #local %>file:<% &local.aerogelPath %>/vite<% /local %><% ^local %>next<% /local %>",
+        "@aerogel/cli": "<% &dependencies.aerogelCli %>",
+        "@aerogel/cypress": "<% &dependencies.aerogelCypress %>",
+        "@aerogel/vite": "<% &dependencies.aerogelVite %>",
+        "@iconify/json": "^2.2.134",
+        "@noeldemartin/eslint-config-vue": "next",
+        "@noeldemartin/scripts": "next",
         "@total-typescript/ts-reset": "^0.4.2",
         "@types/node": "^20.3.1",
         "autoprefixer": "^10.4.14",
         "concurrently": "^8.2.0",
         "cypress": "^12.17.0",
+        "eslint": "^8.40.0",
+        "prettier": "^2.8.8",
+        "prettier-eslint-cli": "^7.1.0",
+        "prettier-plugin-tailwindcss": "^0.2.8",
         "start-server-and-test": "^2.0.0",
+        "typescript": "~5.4",
         "unplugin-icons": "^0.16.3",
         "unplugin-vue-components": "^0.24.1",
         "vite": "^4.3.0",
-        "vitest": "^0.33.0"
+        "vitest": "^0.33.0",
+        "vue-tsc": "^1.8.15"
+    },
+    "eslintConfig": {
+        "extends": [
+            "@noeldemartin/eslint-config-vue"
+        ]
+    },
+    "prettier": {
+        "plugins": [
+            "prettier-plugin-tailwindcss"
+        ],
+        "printWidth": 120
     }
 }

package/templates/app/src/App.vue

@@ -1,7 +1,9 @@
 <template>
-    <AGAppLayout>
-        <main class="flex flex-grow flex-col items-center justify-center bg-blue-50">
-            <h1 class="text-4xl font-semibold">{{ $t('home.title') }}</h1>
+    <AGAppLayout class="bg-blue-50">
+        <main class="flex flex-grow flex-col items-center justify-center">
+            <h1 class="text-4xl font-semibold">
+                {{ $t('home.title') }}
+            </h1>
             <a href="https://aerogel.js.org" target="_blank" class="mt-2 underline opacity-75 hover:opacity-100">
                 {{ $t('home.getStarted') }}
             </a>

package/templates/app/src/assets/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Disallow:

package/templates/app/src/main.ts

@@ -1,13 +1,13 @@
 import i18n from '@aerogel/plugin-i18n';
 import soukai from '@aerogel/plugin-soukai';
-import { bootstrapApplication } from '@aerogel/core';
+import { bootstrap } from '@aerogel/core';
 
-import './assets/styles.css';
+import './assets/css/styles.css';
 import App from './App.vue';
 
-bootstrapApplication(App, {
+bootstrap(App, {
     plugins: [
         i18n({ messages: import.meta.glob('@/lang/*.yaml') }),
-        soukai({ models: import.meta.glob('@/models/*', { eager: true }) }),
+        soukai({ models: import.meta.glob(['@/models/*', '!**/*.test.ts'], { eager: true }) }),
     ],
 });

package/templates/app/src/types/globals.d.ts

@@ -1,3 +1,2 @@
 /// <reference types="vite/client" />
-/// <reference types="vue-router" />
 /// <reference types="vue-i18n" />

package/templates/app/tailwind.config.js

@@ -1,5 +1,5 @@
 /** @type {import('tailwindcss').Config} */
 module.exports = {
-    content: ['./index.html', './src/**/*.{vue,ts}', './node_modules/@aerogel/core/dist/**/*.js'],
+    content: ['./index.html', './src/**/*.{vue,ts}', '<% &contentPath %>'],
     plugins: [require('@tailwindcss/forms'), require('@tailwindcss/typography')],
 };

package/templates/app/tsconfig.json

@@ -6,6 +6,7 @@
         "strict": true,
         "jsx": "preserve",
         "noUncheckedIndexedAccess": true,
+        "skipLibCheck": true,
         "resolveJsonModule": true,
         "esModuleInterop": true,
         "lib": ["esnext", "dom"],

package/templates/app/vite.config.ts

@@ -3,22 +3,27 @@ import Components from 'unplugin-vue-components/vite';
 import I18n from '@intlify/unplugin-vue-i18n/vite';
 import Icons from 'unplugin-icons/vite';
 import IconsResolver from 'unplugin-icons/resolver';
+import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
-export default {
+export default defineConfig({
+    publicDir: resolve(__dirname, './src/assets/public/'),
     plugins: [
-        Aerogel(),
+        Aerogel({ name: '<% app.name %>' }),
         Components({
-            dirs: ['src/pages'],
             dts: false,
             resolvers: [AerogelResolver(), IconsResolver()],
         }),
         I18n({ include: resolve(__dirname, './src/lang/**/*.yaml') }),
-        Icons(),
+        Icons({
+            iconCustomizer(_, __, props) {
+                props['aria-hidden'] = 'true';
+            },
+        }),
     ],
     resolve: {
         alias: {
             '@': resolve(__dirname, './src'),
         },
     },
-};
+});

package/templates/component-button/[component.name].vue

@@ -0,0 +1,42 @@
+<template>
+    <AGHeadlessButton :class="variantClasses" :disabled="disabled">
+        <slot />
+    </AGHeadlessButton>
+</template>
+
+<script setup lang="ts">
+import { Colors, booleanProp, enumProp, removeInteractiveClasses } from '@aerogel/core';
+import { computed } from 'vue';
+
+const props = defineProps({
+    color: enumProp(Colors, Colors.Primary),
+    disabled: booleanProp(),
+});
+
+const colorClasses = computed(() => {
+    switch (props.color) {
+        case Colors.Secondary:
+            // Add your custom color classes here.
+            return '';
+        case Colors.Clear:
+            // Add your custom color classes here.
+            return '';
+        case Colors.Danger:
+            // Add your custom color classes here.
+            return '';
+        case Colors.Primary:
+        default:
+            // Add your custom color classes here.
+            return '';
+    }
+});
+
+const variantClasses = computed(() => {
+    if (props.disabled) {
+        // Add additional classes for disabled state here.
+        return removeInteractiveClasses(colorClasses.value);
+    }
+
+    return colorClasses.value;
+});
+</script>

package/templates/component-button-story/[component.name].story.vue

@@ -0,0 +1,77 @@
+<template>
+    <Story :layout="{ type: 'grid' }">
+        <Variant title="Playground">
+            <<% component.name %> :color="color">
+                {{ content }}
+            </<% component.name %>>
+
+            <template #controls>
+                <HstText v-model="content" title="Content" />
+                <HstSelect v-model="color" title="Color" :options="colorOptions" />
+            </template>
+        </Variant>
+
+        <Variant title="Default">
+            <<% component.name %>>
+                Click me!
+            </<% component.name %>>
+        </Variant>
+
+        <Variant title="Hover">
+            <<% component.name %> class=":hover">
+                Click me!
+            </<% component.name %>>
+        </Variant>
+
+        <Variant title="Focus">
+            <<% component.name %> class=":focus :focus-visible">
+                Click me!
+            </<% component.name %>>
+        </Variant>
+
+        <Variant title="Disabled">
+            <<% component.name %> disabled>
+                You can't click me
+            </<% component.name %>>
+        </Variant>
+
+        <Variant title="Colors" :layout="{ width: '300px' }">
+            <div class="flex items-center gap-2">
+                <<% component.name %> color="primary">
+                    Primary
+                </<% component.name %>>
+                <<% component.name %> color="secondary">
+                    Secondary
+                </<% component.name %>>
+                <<% component.name %> color="danger">
+                    Danger
+                </<% component.name %>>
+                <<% component.name %> color="clear">
+                    Clear
+                </<% component.name %>>
+            </div>
+        </Variant>
+    </Story>
+</template>
+
+<script setup lang="ts">
+import { Colors } from '@aerogel/core';
+import { invert } from '@noeldemartin/utils';
+import { ref } from 'vue';
+import type { Color } from '@aerogel/core';
+
+const content = ref('Click me!');
+const color = ref<Color>(Colors.Primary);
+const colorOptions = invert(Colors);
+</script>
+
+<style>
+.story-<% component.slug %> {
+    grid-template-columns: repeat(2, 300px) !important;
+}
+
+.story-<% component.slug %> .variant-playground,
+.story-<% component.slug %> .variant-colors{
+    grid-column: 1 / -1;
+}
+</style>

package/templates/component-checkbox/[component.name].vue

@@ -0,0 +1,34 @@
+<template>
+    <AGHeadlessInput
+        ref="$input"
+        :name="name"
+        :class="className"
+        :label="label"
+    >
+        <AGHeadlessInputInput
+            v-bind="attrs"
+            type="checkbox"
+        />
+        <div v-if="$slots.default">
+            <AGHeadlessInputLabel>
+                <slot />
+            </AGHeadlessInputLabel>
+            <AGHeadlessInputError />
+        </div>
+    </AGHeadlessInput>
+</template>
+
+<script setup lang="ts">
+import { AGHeadlessInputLabel, componentRef, stringProp, useInputAttrs } from '@aerogel/core';
+import type { IAGHeadlessInput } from '@aerogel/core';
+
+defineOptions({ inheritAttrs: false });
+defineProps({
+    name: stringProp(),
+    label: stringProp(),
+    inputClass: stringProp(''),
+});
+
+const $input = componentRef<IAGHeadlessInput>();
+const [attrs, className] = useInputAttrs();
+</script>