@aurodesignsystem-dev/auro-cli 0.0.0-pr309.0 → 0.0.0-pr310.0

package/README.md

@@ -1,60 +1,161 @@
 # Auro CLI
 
-Auro CLI is a command-line interface designed to help consumers of the Auro Design System and the developers maintaining it.
+[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-cli/test-and-release.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-cli/actions/workflows/test-and-release.yml)
+[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-cli.svg?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-cli)
+[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-cli.svg?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
 
-## `Dev` Command Features
+A CLI tool for the Auro Design System. It runs the local dev server, syncs repo config, builds components and docs, and drives parts of the release pipeline.
 
-- **Start Development Server**: Quickly launch a web development server with default or custom configurations.
-- **Customizable Options**: Specify the port and the directory to open when the server starts.
-- **Hot Module Replacement**: Integrates with HMR (Hot Module Replacement) for a better development experience.
-- **Graceful Error Handling**: Handles invalid inputs and missing options gracefully.
+Published as `@aurodesignsystem/auro-cli`.
 
-## Table of Contents
+## Install
 
-- [Installation](#installation)
-- [Usage](#usage)
-- [Commands](#commands)
-- [Options](#options)
-- [Examples](#examples)
-
-## Installation
+```bash
+npm install @aurodesignsystem/auro-cli
+```
 
-To install Auro CLI, clone the repository and install the dependencies:
+Or run a single command without installing:
 
 ```bash
-npm install @aurodesignsystem/auro-cli
+npx --package=@aurodesignsystem/auro-cli auro <command>
 ```
 
-## Usage
+## Commands
+
+Run `auro <command> --help` for options on any command. Defaults are shown where they exist.
+
+### At a glance
+
+**Development**
+
+| Command | Does |
+|---------|------|
+| `auro dev` | Runs the dev server for a component. |
+| `auro build` | Builds a component. |
+| `auro docs` | Generates API docs from the Custom Elements Manifest. |
+| `auro test` | Runs the web test runner. |
+
+**Repo maintenance**
+
+| Command | Does |
+|---------|------|
+| `auro sync` | Pulls `.github/` config from auro-templates. |
+| `auro migrate` | Runs a migration script by id. |
+| `auro agent` | Interactive cross-repo migration runner (work in progress). |
+| `auro ado` | Creates an ADO work item from a GitHub issue. |
+
+**Release pipeline** (CI runs these)
+
+| Command | Does |
+|---------|------|
+| `auro rc-workflow` | Cuts the RC branch and opens the RC PR. |
+| `auro pr-release` | Sets the PR preview version in `package.json`. |
+| `auro check-commits` (alias `auro cc`) | Classifies commits and can label the PR. |
+
+## Full reference
+
+### Development
+
+#### `auro dev`
+
+Runs the dev server for a component. Builds first, then serves.
+
+- `-s, --serve`: start a server.
+- `-p, --port <number>`: server port.
+- `-o, --open`: open the browser once the server is up.
+- `-w, --watch`: rebuild on change.
+- `-m, --module-paths [paths...]`: path(s) to a node_modules folder.
+- `--skip-docs`: skip doc generation (default: off).
+- `-r, --readme-template <url>`: URL to the README template.
+- `--wca-input [files...]`: source file(s) to analyze for API docs.
+- `--wca-output [files...]`: output file(s) for API docs.
+
+#### `auro build`
+
+Builds a component.
+
+- `-m, --module-paths [paths...]`: path(s) to a node_modules folder.
+- `-w, --watch`: rebuild on change.
+- `--skip-docs`: skip doc generation (default: off).
+- `-r, --readme-template <url>`: URL to the README template.
+- `--wca-input [files...]`: source file(s) to analyze for API docs.
+- `--wca-output [files...]`: output file(s) for API docs.
+
+#### `auro docs`
 
-To use Auro CLI, run the following command in your terminal:
+Generates API documentation from the Custom Elements Manifest.
+
+- `-c, --cem`: generate the Custom Elements Manifest (default: off).
+- `-a, --api`: create `api.md` from the CEM (default: off).
+- `-w, --watch`: rebuild docs on change (default: off).
+- `-r, --readme-template <url>`: URL to the README template.
+- `--skip-readme`: skip README.md processing (default: off).
+- `-s, --serve`: start a server.
+- `-p, --port <number>`: server port.
+- `-o, --open`: open the browser once the server is up.
+
+#### `auro test`
+
+Runs the web test runner against the component library.
+
+- `-w, --watch`: watch mode.
+- `-c, --coverage-report`: generate a coverage report.
+- `-o, --open`: open the coverage report in the browser.
+- `-f, --files <glob>`: test files glob pattern.
 
 ```bash
-auro dev
+auro test --coverage-report --open
 ```
 
-This will start the development server with default options.
+### Repo maintenance
 
-## Commands
+#### `auro sync`
 
-`auro dev`
-Runs the web development server.
+Pulls `.github/` config from auro-templates and rewrites this repo's copy.
 
-#### Options
+- `-r, --ref <branch/tag/commit>`: git ref to pull from (default: `main`).
+- `-t, --template <name>`: which template to use (default: `default`).
 
-- `-o, --open <type>` Open the server to a specific directory (default: demo/).
-- `-p, --port <type>` Change the server port (default: undefined).
+Heads up: after it validates the template, it removes the whole `.github/` folder and rebuilds it. Any local `.github/` file not in the template is lost. It does not make a branch, so changes land on your current branch. Run it on a branch you are willing to change.
 
-#### Examples
+#### `auro migrate`
 
-Start the server on a specific port:
+Runs a codemod-style migration script by id.
 
-```
-auro dev --port 8000
-```
+- `-i, --id <string>` (required): the migration to run.
+- `-m, --multi-gitter`: run it across every repo in the multi-gitter config.
 
-Open the server to a specific directory:
+#### `auro agent`
 
-```
-auro dev --open src/
-```
+Interactive. Runs a migration across Auro components in dependency order. It prompts for the migration id and which components to start from. Needs multi-gitter installed. (Work in progress)
+
+#### `auro ado`
+
+Creates an Azure DevOps work item from a GitHub issue.
+
+- `-g, --gh-issue <issue>`: the GitHub issue to use.
+
+### Release pipeline
+
+CI runs these. You do not usually run them by hand. The workflows in auro-actions call them.
+
+#### `auro rc-workflow`
+
+Cuts the release-candidate branch and opens the RC pull request. Runs on a push to dev. No options.
+
+#### `auro pr-release`
+
+Sets the PR preview version in `package.json`, computed from the npm registry. Does not publish.
+
+- `-n, --namespace <namespace>`: package namespace (default: `@aurodesignsystem-dev`).
+- `-p, --pr-number <number>`: the PR number (default: `0`).
+
+The version comes out as `0.0.0-pr<PR#>.<n>`, where `<n>` is the next free increment on npm.
+
+#### `auro check-commits` (alias `auro cc`)
+
+Reads the repo's commits, classifies each by conventional-commit type, and reports the result.
+
+- `-l, --set-label`: label the PR by the highest-priority commit type.
+- `-d, --debug`: print detailed commit info.
+- `-r, --release-notes`: generate release notes from the commits.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurodesignsystem-dev/auro-cli",
-  "version": "0.0.0-pr309.0",
+  "version": "0.0.0-pr310.0",
   "description": "A cli tool to support the Auro Design System",
   "repository": {
     "type": "git",