package-info

Package Info Lookup

Get a comprehensive overview of the package $ARGUMENTS.

Steps

1. Resolve the package path. Map the name to a filesystem path:

   • react-button or @fluentui/react-button → packages/react-components/react-button/
   • Check both library/ (source) and stories/ (storybook) sub-packages

2. Get Nx project details:

   yarn nx show project @fluentui/$ARGUMENTS --json 2>/dev/null || yarn nx show project $ARGUMENTS --json 2>/dev/null
   

3. Read the package.json for version, dependencies, and peer dependencies.

1. Check ownership by searching CODEOWNERS:

   grep -i "$ARGUMENTS" CODEOWNERS
   

2. Summarize the component structure — list files under library/src/components/.

3. Check test coverage — does it have:

   • Unit tests (*.test.tsx)
   • Conformance tests (testing/isConformant.ts)
   • Stories (stories/ package)

4. Report in this format:

   Package: @fluentui/<name>
   Path: packages/react-components/<name>/library/
   Version: x.y.z
   Tier: 3 (Component) | 2 (Foundation) | 1 (Core)
   Owner: <team from CODEOWNERS>
   Dependencies: <list relevant @fluentui deps>
   Components: <list exported components>
   Tests: unit ✓/✗ | conformance ✓/✗ | stories ✓/✗
   

Useful Commands for the Package

yarn nx run <project>:build          # Build
yarn nx run <project>:test           # Unit tests
yarn nx run <project>:lint           # Lint
yarn nx run <project>:type-check     # Type check
yarn nx run <project>:generate-api   # Regenerate API docs (etc/*.api.md)

References

• Package layers: docs/architecture/layers.md
• Team routing: docs/team-routing.md