semmet-angular 0.28.0 → 0.29.0

package/README.en.md

@@ -19,6 +19,7 @@ Brazilian Portuguese documentation is available in [README.md](./README.md).
 ```
 ng add semmet-angular
 ng generate semmet-angular:accordion my-faq
+ng generate semmet-angular:ci
 ```
 
 `ng add semmet-angular` installs the package and configures the delivery workflow once for the target application, including Playwright e2e support and npm scripts. Each generated component is dropped into your project exactly like `ng generate component` would (respecting your `angular.json` project, source root, and selector prefix), and has **zero runtime dependency** on this package — `semmet-angular` is only needed at generation time.
@@ -47,6 +48,16 @@ npm run e2e:ui
 
 `npm run e2e` runs Playwright against the Angular dev server configured by `playwright.config.ts`; `npm run e2e:ui` opens Playwright's interactive UI.
 
+## GitHub Actions CI
+
+```bash
+ng generate semmet-angular:ci
+```
+
+This command generates `.github/workflows/ci.yml` using the package scripts that already exist in `package.json`. The workflow detects the package manager by lockfile (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`), installs dependencies, and runs `verify` when available. If `verify` does not exist yet, it runs `build`, `test`, and `e2e` when those scripts exist.
+
+By default, the schematic does not overwrite an existing workflow. Use `--force` when you want to replace `.github/workflows/ci.yml`.
+
 ## Projected content containers
 
 Some generated components are containers: they own the ARIA wiring, keyboard behavior, focus management, and visual shell, while your app owns the content rendered inside them.

package/README.md

@@ -19,6 +19,7 @@ English documentation is available in [README.en.md](./README.en.md).
 ```bash
 ng add semmet-angular
 ng generate semmet-angular:accordion minha-faq
+ng generate semmet-angular:ci
 ```
 
 `ng add semmet-angular` instala o pacote e configura uma vez o fluxo de entrega da aplicação alvo, incluindo suporte a e2e com Playwright e scripts npm. Cada componente gerado entra no seu projeto do mesmo jeito que entraria com `ng generate component` (respeitando `angular.json`, `sourceRoot` e prefixo de seletor), e tem **zero dependência em tempo de execução** deste pacote — `semmet-angular` só é necessário na geração.
@@ -47,6 +48,16 @@ npm run lint
 
 `lint` só entra quando a aplicação já tem um script `lint`; `build` e `test` seguem a mesma lógica. O `e2e` entra depois da configuração do Playwright feita pelo `ng add`.
 
+## CI com GitHub Actions
+
+```bash
+ng generate semmet-angular:ci
+```
+
+Esse comando gera `.github/workflows/ci.yml` usando os scripts já existentes no `package.json`. O workflow detecta o gerenciador de pacotes por lockfile (`package-lock.json`, `pnpm-lock.yaml` ou `yarn.lock`), instala dependências e executa `verify` quando disponível. Se `verify` ainda não existir, ele roda `build`, `test` e `e2e` conforme esses scripts existirem.
+
+Por padrão, o schematic não sobrescreve um workflow existente. Use `--force` quando quiser substituir `.github/workflows/ci.yml`.
+
 ## Testes Gerados
 
 Todo schematic de componente gera arquivos de teste ao lado do componente:

package/README.pt-BR.md

@@ -17,6 +17,7 @@ Leia a direção geral do produto em [PRODUCT_VISION.md](./PRODUCT_VISION.md).
 ```bash
 ng add semmet-angular
 ng generate semmet-angular:accordion minha-faq
+ng generate semmet-angular:ci
 ```
 
 `ng add semmet-angular` instala o pacote e configura uma vez o fluxo de entrega da aplicação alvo, incluindo suporte a e2e com Playwright e scripts npm. Cada componente gerado entra no seu projeto do mesmo jeito que entraria com `ng generate component` (respeitando `angular.json`, `sourceRoot` e prefixo de seletor), e tem **zero dependência em tempo de execução** deste pacote — `semmet-angular` só é necessário na geração.
@@ -45,6 +46,16 @@ npm run lint
 
 `lint` só entra quando a aplicação já tem um script `lint`; `build` e `test` seguem a mesma lógica. O `e2e` entra depois da configuração do Playwright feita pelo `ng add`.
 
+## CI com GitHub Actions
+
+```bash
+ng generate semmet-angular:ci
+```
+
+Esse comando gera `.github/workflows/ci.yml` usando os scripts já existentes no `package.json`. O workflow detecta o gerenciador de pacotes por lockfile (`package-lock.json`, `pnpm-lock.yaml` ou `yarn.lock`), instala dependências e executa `verify` quando disponível. Se `verify` ainda não existir, ele roda `build`, `test` e `e2e` conforme esses scripts existirem.
+
+Por padrão, o schematic não sobrescreve um workflow existente. Use `--force` quando quiser substituir `.github/workflows/ci.yml`.
+
 ## Testes Gerados
 
 Todo schematic de componente gera arquivos de teste ao lado do componente:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semmet-angular",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Accessible UI Delivery Kit for Angular: schematics that generate ARIA-conformant standalone components with styling, keyboard behavior, unit tests, and Playwright e2e smoke tests.",
   "publisher": "danilodevsilva",
   "license": "MIT",

package/src/ci/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { Schema } from './schema';
+export declare function ci(options: Schema): Rule;

package/src/ci/index.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ci = ci;
+const schematics_1 = require("@angular-devkit/schematics");
+function ci(options) {
+    return (tree) => {
+        const workflowPath = buildWorkflowPath(options.name);
+        if (tree.exists(workflowPath) && !options.force) {
+            throw new schematics_1.SchematicsException(`${workflowPath} already exists. Re-run with --force to overwrite it.`);
+        }
+        const packageJson = readJson(tree, '/package.json');
+        const scripts = packageJson.scripts ?? {};
+        const packageManager = detectPackageManager(tree);
+        const workflow = buildWorkflow(packageManager, Object.keys(scripts), tree.exists('/package-lock.json'));
+        if (tree.exists(workflowPath)) {
+            tree.overwrite(workflowPath, workflow);
+        }
+        else {
+            tree.create(workflowPath, workflow);
+        }
+    };
+}
+function buildWorkflowPath(name = 'ci') {
+    const normalizedName = name.trim().replace(/\.ya?ml$/, '');
+    if (!normalizedName || normalizedName.includes('/') || normalizedName.includes('\\')) {
+        throw new schematics_1.SchematicsException('CI workflow name must be a file name without path separators.');
+    }
+    return `/.github/workflows/${normalizedName}.yml`;
+}
+function detectPackageManager(tree) {
+    if (tree.exists('/pnpm-lock.yaml')) {
+        return 'pnpm';
+    }
+    if (tree.exists('/yarn.lock')) {
+        return 'yarn';
+    }
+    return 'npm';
+}
+function buildWorkflow(packageManager, scriptNames, hasNpmLockfile) {
+    const commands = getPackageManagerCommands(packageManager, hasNpmLockfile);
+    const runSteps = buildRunSteps(commands, scriptNames);
+    const setupPackageManagerStep = commands.setupStep ? `${commands.setupStep}\n` : '';
+    const cacheConfig = commands.cache ? `          cache: ${commands.cache}\n` : '';
+    return `name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+${setupPackageManagerStep}      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+${cacheConfig}
+
+      - name: Install dependencies
+        run: ${commands.install}
+${runSteps}
+`;
+}
+function getPackageManagerCommands(packageManager, hasNpmLockfile) {
+    if (packageManager === 'pnpm') {
+        return {
+            install: 'pnpm install --frozen-lockfile',
+            run: (script) => `pnpm run ${script}`,
+            setupStep: `      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9`,
+            cache: 'pnpm',
+        };
+    }
+    if (packageManager === 'yarn') {
+        return {
+            install: 'yarn install --frozen-lockfile',
+            run: (script) => `yarn ${script}`,
+            cache: 'yarn',
+        };
+    }
+    return {
+        install: hasNpmLockfile ? 'npm ci' : 'npm install',
+        run: (script) => `npm run ${script}`,
+        cache: hasNpmLockfile ? 'npm' : undefined,
+    };
+}
+function buildRunSteps(commands, scriptNames) {
+    const scripts = new Set(scriptNames);
+    const verificationScripts = scripts.has('verify')
+        ? ['verify']
+        : ['build', 'test', 'e2e'].filter((script) => scripts.has(script));
+    if (verificationScripts.length === 0) {
+        return `
+      - name: Check package scripts
+        run: echo "No verify, build, test, or e2e script found in package.json."
+`;
+    }
+    return verificationScripts
+        .map((script) => `
+      - name: Run ${script}
+        run: ${commands.run(script)}
+`)
+        .join('');
+}
+function readJson(tree, path) {
+    const content = tree.readText(path);
+    return JSON.parse(content);
+}
+//# sourceMappingURL=index.js.map

package/src/ci/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAYA,gBAmBC;AA/BD,2DAA6E;AAY7E,SAAgB,EAAE,CAAC,OAAe;IAChC,OAAO,CAAC,IAAU,EAAE,EAAE;QACpB,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAErD,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAChD,MAAM,IAAI,gCAAmB,CAAC,GAAG,YAAY,uDAAuD,CAAC,CAAC;QACxG,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC;QAC1C,MAAM,cAAc,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAExG,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACtC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAI,GAAG,IAAI;IACpC,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAE3D,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACrF,MAAM,IAAI,gCAAmB,CAAC,+DAA+D,CAAC,CAAC;IACjG,CAAC;IAED,OAAO,sBAAsB,cAAc,MAAM,CAAC;AACpD,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAU;IACtC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACnC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,cAA8B,EAAE,WAAqB,EAAE,cAAuB;IACnG,MAAM,QAAQ,GAAG,yBAAyB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtD,MAAM,uBAAuB,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,oBAAoB,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjF,OAAO;;;;;;;;;;;;;;;EAeP,uBAAuB;;;;EAIvB,WAAW;;;eAGE,QAAQ,CAAC,OAAO;EAC7B,QAAQ;CACT,CAAC;AACF,CAAC;AAED,SAAS,yBAAyB,CAAC,cAA8B,EAAE,cAAuB;IACxF,IAAI,cAAc,KAAK,MAAM,EAAE,CAAC;QAC9B,OAAO;YACL,OAAO,EAAE,gCAAgC;YACzC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,MAAM,EAAE;YACrC,SAAS,EAAE;;;qBAGI;YACf,KAAK,EAAE,MAAM;SACd,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,KAAK,MAAM,EAAE,CAAC;QAC9B,OAAO;YACL,OAAO,EAAE,gCAAgC;YACzC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,MAAM,EAAE;YACjC,KAAK,EAAE,MAAM;SACd,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa;QAClD,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,MAAM,EAAE;QACpC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KAC1C,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,QAAgC,EAAE,WAAqB;IAC5E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACrC,MAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/C,CAAC,CAAC,CAAC,QAAQ,CAAC;QACZ,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAErE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO;;;CAGV,CAAC;IACA,CAAC;IAED,OAAO,mBAAmB;SACvB,GAAG,CACF,CAAC,MAAM,EAAE,EAAE,CAAC;oBACE,MAAM;eACX,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC;CAClC,CACI;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,IAAY;IACxC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAwB,CAAC;AACpD,CAAC"}

package/src/ci/index.ts

@@ -0,0 +1,143 @@
+import { Rule, SchematicsException, Tree } from '@angular-devkit/schematics';
+import { Schema } from './schema';
+
+type PackageManager = 'npm' | 'pnpm' | 'yarn';
+
+interface PackageManagerCommands {
+  install: string;
+  run: (script: string) => string;
+  setupStep?: string;
+  cache?: string;
+}
+
+export function ci(options: Schema): Rule {
+  return (tree: Tree) => {
+    const workflowPath = buildWorkflowPath(options.name);
+
+    if (tree.exists(workflowPath) && !options.force) {
+      throw new SchematicsException(`${workflowPath} already exists. Re-run with --force to overwrite it.`);
+    }
+
+    const packageJson = readJson(tree, '/package.json');
+    const scripts = packageJson.scripts ?? {};
+    const packageManager = detectPackageManager(tree);
+    const workflow = buildWorkflow(packageManager, Object.keys(scripts), tree.exists('/package-lock.json'));
+
+    if (tree.exists(workflowPath)) {
+      tree.overwrite(workflowPath, workflow);
+    } else {
+      tree.create(workflowPath, workflow);
+    }
+  };
+}
+
+function buildWorkflowPath(name = 'ci'): string {
+  const normalizedName = name.trim().replace(/\.ya?ml$/, '');
+
+  if (!normalizedName || normalizedName.includes('/') || normalizedName.includes('\\')) {
+    throw new SchematicsException('CI workflow name must be a file name without path separators.');
+  }
+
+  return `/.github/workflows/${normalizedName}.yml`;
+}
+
+function detectPackageManager(tree: Tree): PackageManager {
+  if (tree.exists('/pnpm-lock.yaml')) {
+    return 'pnpm';
+  }
+
+  if (tree.exists('/yarn.lock')) {
+    return 'yarn';
+  }
+
+  return 'npm';
+}
+
+function buildWorkflow(packageManager: PackageManager, scriptNames: string[], hasNpmLockfile: boolean): string {
+  const commands = getPackageManagerCommands(packageManager, hasNpmLockfile);
+  const runSteps = buildRunSteps(commands, scriptNames);
+  const setupPackageManagerStep = commands.setupStep ? `${commands.setupStep}\n` : '';
+  const cacheConfig = commands.cache ? `          cache: ${commands.cache}\n` : '';
+
+  return `name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+${setupPackageManagerStep}      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+${cacheConfig}
+
+      - name: Install dependencies
+        run: ${commands.install}
+${runSteps}
+`;
+}
+
+function getPackageManagerCommands(packageManager: PackageManager, hasNpmLockfile: boolean): PackageManagerCommands {
+  if (packageManager === 'pnpm') {
+    return {
+      install: 'pnpm install --frozen-lockfile',
+      run: (script) => `pnpm run ${script}`,
+      setupStep: `      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9`,
+      cache: 'pnpm',
+    };
+  }
+
+  if (packageManager === 'yarn') {
+    return {
+      install: 'yarn install --frozen-lockfile',
+      run: (script) => `yarn ${script}`,
+      cache: 'yarn',
+    };
+  }
+
+  return {
+    install: hasNpmLockfile ? 'npm ci' : 'npm install',
+    run: (script) => `npm run ${script}`,
+    cache: hasNpmLockfile ? 'npm' : undefined,
+  };
+}
+
+function buildRunSteps(commands: PackageManagerCommands, scriptNames: string[]): string {
+  const scripts = new Set(scriptNames);
+  const verificationScripts = scripts.has('verify')
+    ? ['verify']
+    : ['build', 'test', 'e2e'].filter((script) => scripts.has(script));
+
+  if (verificationScripts.length === 0) {
+    return `
+      - name: Check package scripts
+        run: echo "No verify, build, test, or e2e script found in package.json."
+`;
+  }
+
+  return verificationScripts
+    .map(
+      (script) => `
+      - name: Run ${script}
+        run: ${commands.run(script)}
+`
+    )
+    .join('');
+}
+
+function readJson(tree: Tree, path: string): Record<string, any> {
+  const content = tree.readText(path);
+  return JSON.parse(content) as Record<string, any>;
+}

package/src/ci/schema.d.ts

@@ -0,0 +1,4 @@
+export interface Schema {
+    force?: boolean;
+    name?: string;
+}

package/src/ci/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/src/ci/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["schema.ts"],"names":[],"mappings":""}

package/src/ci/schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "SemmetAngularCi",
+  "title": "Semmet Angular CI Options Schema",
+  "type": "object",
+  "description": "Generates a GitHub Actions CI workflow using the target workspace package scripts.",
+  "additionalProperties": false,
+  "properties": {
+    "force": {
+      "type": "boolean",
+      "default": false,
+      "description": "Overwrite an existing CI workflow."
+    },
+    "name": {
+      "type": "string",
+      "default": "ci",
+      "description": "The workflow file name to create under .github/workflows."
+    }
+  }
+}

package/src/ci/schema.ts

@@ -0,0 +1,4 @@
+export interface Schema {
+  force?: boolean;
+  name?: string;
+}

package/src/collection.json

@@ -6,6 +6,11 @@
       "factory": "./ng-add/index#ngAdd",
       "schema": "./ng-add/schema.json"
     },
+    "ci": {
+      "description": "Generates a GitHub Actions CI workflow using existing package scripts.",
+      "factory": "./ci/index#ci",
+      "schema": "./ci/schema.json"
+    },
     "accordion": {
       "description": "Generates a standalone Angular Accordion component following the W3C ARIA Authoring Practices Guide.",
       "factory": "./accordion/index#accordion",