frontpl 0.1.1 → 0.3.0

package/README.md

@@ -1,11 +1,96 @@
 # frontpl
 
-Interactive CLI to scaffold standardized frontend project templates.
+Interactive CLI to scaffold standardized frontend project templates (with optional CI/Release workflows).
+
+> Node.js >= 22
+
+## Install
+
+```sh
+# If published on npm:
+npm i -g frontpl
+# or
+pnpm add -g frontpl
+
+# Or run once via npx:
+npx frontpl --help
+```
+
+## Quick start
+
+```sh
+frontpl my-frontend
+# or
+frontpl init my-frontend
+```
+
+Follow the prompts to choose:
+
+- Package manager (`npm`/`pnpm`/`yarn`/`bun`/`deno`)
+- Optional tooling: `oxlint`, `oxfmt`, `vitest`, `tsdown`
+
+When `oxlint` is enabled, generated projects use `@kingsword/lint-config` via `oxlint.config.ts`.
+
+- Git init
+- GitHub Actions workflows:
+  - CI only
+  - CI + release (release supports tag/commit/both)
+
+## Commands
+
+### `frontpl [name]` / `frontpl init [name]`
+
+Scaffold a new project into `./<name>` (or prompt for a name when omitted).
+
+Generated output includes (based on options):
+
+- `.editorconfig`, `.gitignore`, `.gitattributes`
+- `package.json` (+ scripts like optional `lint`, `format:check`, `test`, `build`)
+- `tsconfig.json`, `src/index.ts`
+- Optional configs: `oxlint.config.ts`, `.oxfmtrc.json`, `tsdown.config.ts`
+- Optional GitHub Actions workflows in `.github/workflows/`
+
+### `frontpl ci`
+
+Add or update CI/Release workflows for an existing project (run it in your repo root).
+
+What it does:
+
+- Detects the package manager via `package.json#packageManager` or lockfiles
+- Suggests a `workingDirectory` (supports monorepo layouts like `packages/*` / `apps/*`)
+- Detects Node.js major version from `.nvmrc`, `.node-version`, or `package.json#engines.node` (defaults to `22`)
+- Generates `.github/workflows/ci.yml`
+- Optionally generates `.github/workflows/release.yml` (tag/commit/both)
+
+## GitHub Actions (CI + Release)
+
+frontpl generates workflows that call reusable workflows from `kingsword09/workflows` (pinned to `@v1` by default):
+
+- CI: `cli-ci.yml`
+- Release (tag, recommended): `cli-release-tag.yml`
+- Release (commit, legacy): `cli-release.yml`
+
+### Release modes
+
+- **Tag (recommended)**: trigger on tag push (`vX.Y.Z`), validate `package.json#version` matches the tag.
+- **Commit (legacy)**: trigger on `main` push, publish only when the commit message matches `chore(release): vX.Y.Z` (also supports `chore: release vX.Y.Z`), and the workflow will create/push the tag.
+- **Both**: a single `release.yml` listens to both `main` and `tags`, and routes to the corresponding reusable workflow.
+
+### Publishing auth
+
+- **Trusted publishing (OIDC)**: enable `trustedPublishing: true` (no `NPM_TOKEN` required). Your repo must be configured on npm as a trusted publisher for the calling workflow.
+- **NPM token**: set `trustedPublishing: false` and provide `NPM_TOKEN` in GitHub secrets.
 
 ## Development
 
 ```sh
 pnpm install
+pnpm run lint
 pnpm run build
 node dist/cli.mjs --help
+node dist/cli.mjs ci
 ```
+
+## Lint preset
+
+This repository itself uses `@kingsword/lint-config` (see `oxlint.config.ts`).

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { t as runInit } from "./init-Cva-s-yN.mjs";
+import { n as runCi, t as runInit } from "./init-CQKT_mPD.mjs";
 import bin from "tiny-bin";
 
 //#region src/cli.ts
@@ -8,6 +8,8 @@ async function main() {
 		await runInit({ nameArg: args[0] });
 	}).command("init", "Scaffold a new project").argument("[name]", "Project name (directory name)").action(async (_options, args) => {
 		await runInit({ nameArg: args[0] });
+	}).command("ci", "Add CI/release workflows to an existing project").action(async () => {
+		await runCi();
 	}).run();
 }
 main();

package/dist/index.d.mts

@@ -1,3 +1,6 @@
+//#region src/commands/ci.d.ts
+declare function runCi(): Promise<undefined>;
+//#endregion
 //#region src/commands/init.d.ts
 declare function runInit({
   nameArg
@@ -5,4 +8,39 @@ declare function runInit({
   nameArg?: string;
 }): Promise<void>;
 //#endregion
-export { runInit };
+//#region src/lib/templates.d.ts
+declare function oxlintConfigTemplate({
+  useVitest
+}: {
+  useVitest: boolean;
+}): string;
+declare function packageJsonTemplate(opts: {
+  name: string;
+  packageManager: string;
+  typescriptVersion: string;
+  useOxlint: boolean;
+  oxlintVersion?: string;
+  oxlintTsgolintVersion?: string;
+  kingswordLintConfigVersion?: string;
+  useOxfmt: boolean;
+  oxfmtVersion?: string;
+  useVitest: boolean;
+  vitestVersion?: string;
+  useTsdown: boolean;
+  tsdownVersion?: string;
+}): string;
+declare function githubCliCiWorkflowTemplate(opts: {
+  packageManager: "npm" | "pnpm" | "yarn" | "bun" | "deno";
+  nodeVersion: number;
+  workingDirectory: string;
+  runLint: boolean;
+  runFormatCheck: boolean;
+  runTests: boolean;
+  installCommand?: string;
+  lintCommand?: string;
+  formatCheckCommand?: string;
+  testCommand?: string;
+  workflowsRef?: string;
+}): string;
+//#endregion
+export { githubCliCiWorkflowTemplate, oxlintConfigTemplate, packageJsonTemplate, runCi, runInit };

package/dist/index.mjs

@@ -1,3 +1,3 @@
-import { t as runInit } from "./init-Cva-s-yN.mjs";
+import { a as packageJsonTemplate, i as oxlintConfigTemplate, n as runCi, r as githubCliCiWorkflowTemplate, t as runInit } from "./init-CQKT_mPD.mjs";
 
-export { runInit };
+export { githubCliCiWorkflowTemplate, oxlintConfigTemplate, packageJsonTemplate, runCi, runInit };