@aurodesignsystem-dev/auro-cli 0.0.0-pr324.0 → 0.0.0-pr325.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +81 -0
- package/dist/auro-cli.js +409 -51
- package/dist/auro-cli.js.map +4 -4
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -143,6 +143,8 @@ CI runs these. You do not usually run them by hand. The workflows in auro-action
|
|
|
143
143
|
|
|
144
144
|
Cuts the release-candidate branch and opens the RC pull request. Runs on a push to dev. No options.
|
|
145
145
|
|
|
146
|
+
See [Auro Teams GitFlow](src/scripts/rc-workflow/auro-gitflow.md) for how the team plans and tracks releases in ADO, and the [Manual Release Candidate Process](src/scripts/rc-workflow/manual-rc-process.md) for running the RC steps by hand.
|
|
147
|
+
|
|
146
148
|
#### `auro pr-release`
|
|
147
149
|
|
|
148
150
|
Sets the PR preview version in `package.json`, computed from the npm registry. Does not publish.
|
|
@@ -159,3 +161,82 @@ Reads the repo's commits, classifies each by conventional-commit type, and repor
|
|
|
159
161
|
- `-l, --set-label`: label the PR by the highest-priority commit type.
|
|
160
162
|
- `-d, --debug`: print detailed commit info.
|
|
161
163
|
- `-r, --release-notes`: generate release notes from the commits.
|
|
164
|
+
|
|
165
|
+
### AI assistant context
|
|
166
|
+
|
|
167
|
+
#### `auro context`
|
|
168
|
+
|
|
169
|
+
Prints an AI-ready context document describing the Auro Design System, its components, and usage patterns. Designed to be piped into or pasted into AI coding assistants (Claude, Cursor, Copilot, etc.) to prime them on Auro.
|
|
170
|
+
|
|
171
|
+
The Component Reference table is enriched from each component's Custom Elements Manifest so descriptions stay current. For components installed in the current project, the manifest is read from `node_modules` (matching your installed version); everything else is fetched from unpkg. The curated built-in list is the fallback for any component that can't be resolved. After generating the document, any installed component that isn't on the latest published release is reported to stderr (so it never pollutes the document itself).
|
|
172
|
+
|
|
173
|
+
- `-o, --output <file>`: write the context document to a file instead of stdout (e.g. `AURO_CONTEXT.md`).
|
|
174
|
+
- `--offline`: skip network fetches — enrich only from locally installed manifests and fall back to the built-in table (also skips the outdated-release check).
|
|
175
|
+
|
|
176
|
+
Print the context to the terminal:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
auro context
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Write the context to a file for your AI tool:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
auro context --output AURO_CONTEXT.md
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
#### `auro cem`
|
|
189
|
+
|
|
190
|
+
Aggregates the Custom Elements Manifests (`custom-elements.json`) of every published Auro component into a single file. Each component's manifest is fetched from the latest published version on unpkg; components that do not publish a manifest yet are skipped. Useful for feeding a complete, machine-readable component API index to IDEs, docs tooling, and AI assistants.
|
|
191
|
+
|
|
192
|
+
#### Options
|
|
193
|
+
|
|
194
|
+
- `-o, --output <file>` Path to write the aggregated manifest (default: `custom-elements.aggregate.json`).
|
|
195
|
+
|
|
196
|
+
#### Examples
|
|
197
|
+
|
|
198
|
+
Generate the aggregated manifest:
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
auro cem
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Write it to a specific path:
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
auro cem --output dist/custom-elements.aggregate.json
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
#### `auro component <name>`
|
|
211
|
+
|
|
212
|
+
Looks up a single Auro component's API — attributes, properties/methods, slots, events, and CSS parts — from its Custom Elements Manifest. Useful for humans and for AI coding assistants that call the CLI in a tool-use loop to avoid guessing an API.
|
|
213
|
+
|
|
214
|
+
If the component is installed in the current project's `node_modules`, its manifest is read locally so the API matches the version you actually have — the success line shows `(local vX.Y.Z)`. Otherwise it's fetched from unpkg (shown as `(unpkg)`). Passing an explicit `--tag`/version always fetches that version from unpkg.
|
|
215
|
+
|
|
216
|
+
#### Options
|
|
217
|
+
|
|
218
|
+
- `-t, --tag <version>` npm dist-tag or version to look up (default: `latest`; forces an unpkg fetch).
|
|
219
|
+
- `--json` Output the raw manifest declaration(s) as JSON instead of formatted text.
|
|
220
|
+
|
|
221
|
+
#### Examples
|
|
222
|
+
|
|
223
|
+
Look up a component (name is normalized, so all of these work):
|
|
224
|
+
|
|
225
|
+
```
|
|
226
|
+
auro component button
|
|
227
|
+
auro component auro-button
|
|
228
|
+
auro component @aurodesignsystem/auro-button
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Look up a specific version or dist-tag:
|
|
232
|
+
|
|
233
|
+
```
|
|
234
|
+
auro component auro-button --tag beta
|
|
235
|
+
auro component auro-button --tag 11.0.0
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
Get machine-readable output:
|
|
239
|
+
|
|
240
|
+
```
|
|
241
|
+
auro component auro-button --json
|
|
242
|
+
```
|