feat(context): add auro context command for AI assistant onboarding#296
Open
lindseyo1123 wants to merge 3 commits into
Open
feat(context): add auro context command for AI assistant onboarding#296lindseyo1123 wants to merge 3 commits into
lindseyo1123 wants to merge 3 commits into
Conversation
Adds a new 'auro context' command that prints an AI-ready context document describing the Auro Design System — component list, package names, usage patterns, and rules — for priming AI coding assistants (Claude, Cursor, Copilot, etc.). - src/static/auroContext.ts: the context document, exposed via a new #static/* import alias - src/commands/context.ts: the command, supporting stdout and --output <file> - Wires #static/* into package.json imports, tsconfig paths, and the esbuild build config - Documents the command in the README Inspired by prior art in Meta's Astryx design system (npx astryx init).
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @lindseyo1123, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
🚀 PR Release Published! |
Addresses review findings — the doc shipped examples that would mislead the AI assistants it exists to ground: - auro-formkit: label is a slot, not an attribute; import via subpath (no root export) instead of a bare package import - auro-icon: use a real icon name (plane-side-fill) and drop the non-existent customSize property - design tokens: correct prefixes to --ds-basic-* / --ds-advanced-* - auro-pane and auro-nav: accurate descriptions
|
🚀 PR Release Published! |
Reconcile the component set with llms.txt and the auro cem component list so all three sources agree.
|
🚀 PR Release Published! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
auro contextcommand that prints an AI-ready context document describing the Auro Design System — component list, package names, usage patterns, and coding rules — for priming AI coding assistants (Claude, Cursor, Copilot, etc.).When a developer asks an AI assistant to "build a form with Auro," the assistant often hallucinates component names or falls back to plain HTML because it has no grounding in Auro's actual API. Piping this context document in fixes that cold-start problem.
Usage
Changes
src/static/auroContext.ts— the context document, exposed via a new#static/*import aliassrc/commands/context.ts— the command, supporting stdout and--output <file>#static/*intopackage.jsonimports,tsconfig.jsonpaths, and the esbuild build config (build-scripts/build-config.js)src/index.tsREADME.mdTesting
npm run buildsucceedsauro contextprints the document to stdout (exit 0)auro context --output <file>writes the document and prints a success messagePrior art
Inspired by Meta's Astryx design system, which ships an
npx astryx initflow that generates AI-agent documentation for consuming projects. This is the Auro equivalent as a first step toward broader agent-readiness.