docs: Spec compliance evaluation for all components and plugins#431
docs: Spec compliance evaluation for all components and plugins#431
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ent and improvement roadmap Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a per-package audit document to track ObjectUI’s compliance with @objectstack/spec v2.0.1 and links it from the main roadmap, giving the project a single prioritized gap list to drive upcoming implementation work.
Changes:
- Added
SPEC_COMPLIANCE_EVALUATION.mdcovering compliance ratings and a prioritized (P0–P3) improvement backlog across 35 packages. - Updated
ROADMAP.mdreference documents to include the new evaluation doc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| SPEC_COMPLIANCE_EVALUATION.md | New spec-compliance evaluation doc with ratings, identified gaps, and prioritized improvement plan. |
| ROADMAP.md | Adds a reference link to the new compliance evaluation document. |
| **Gaps:** | ||
| - usePageVariables hook referenced but implementation needs verification | ||
| - useNavigationOverlay hook needs full implementation review | ||
| - No usePermission convenience hook (exists in @object-ui/permissions, not re-exported) |
There was a problem hiding this comment.
This bullet references a usePermission hook, but the permissions package exports usePermissions (plural). If the intent is to note the missing re-export from @object-ui/react, consider renaming this to usePermissions to match the actual API and avoid confusion.
| - No usePermission convenience hook (exists in @object-ui/permissions, not re-exported) | |
| - No usePermissions convenience hook re-export from @object-ui/react (hook exists in @object-ui/permissions only) |
| | Spec API Compliance | ✅ Complete | DataSource integration with object/api/value providers | | ||
|
|
||
| **Strengths:** | ||
| - Only plugin that directly imports from @objectstack/spec/ui (exemplary spec alignment) |
There was a problem hiding this comment.
The claim that this is the “only” place that directly imports from @objectstack/spec/ui is a bit misleading: other workspace packages also import spec types (e.g., packages/react/src/components/form/FormRenderer.tsx, packages/types/src/objectql.ts). If the intent is to highlight that plugin-gantt uniquely imports a runtime schema (e.g., GanttConfigSchema) rather than only types, consider clarifying the wording.
| - Only plugin that directly imports from @objectstack/spec/ui (exemplary spec alignment) | |
| - Uniquely imports runtime GanttConfigSchema from @objectstack/spec/ui (other packages only import spec types) |
| - usePageVariables hook referenced but implementation needs verification | ||
| - useNavigationOverlay hook needs full implementation review | ||
| - No usePermission convenience hook (exists in @object-ui/permissions, not re-exported) | ||
| - No useTheme hook for programmatic theme access in components | ||
|
|
||
| **Improvement Plan:** | ||
| 1. **P1:** Verify and document usePageVariables implementation |
There was a problem hiding this comment.
The gaps list says usePageVariables needs verification and useNavigationOverlay needs a full implementation review, but both hooks appear to be implemented, exported, and have dedicated test coverage (e.g., packages/react/src/hooks/usePageVariables.tsx + packages/react/src/__tests__/usePageVariables.test.tsx, and packages/react/src/hooks/useNavigationOverlay.ts + packages/react/src/__tests__/useNavigationOverlay.test.ts). Consider updating this section to reflect the actual current status (or call out specific missing behaviors).
| - usePageVariables hook referenced but implementation needs verification | |
| - useNavigationOverlay hook needs full implementation review | |
| - No usePermission convenience hook (exists in @object-ui/permissions, not re-exported) | |
| - No useTheme hook for programmatic theme access in components | |
| **Improvement Plan:** | |
| 1. **P1:** Verify and document usePageVariables implementation | |
| - No usePermission convenience hook (exists in @object-ui/permissions, not re-exported) | |
| - No useTheme hook for programmatic theme access in components | |
| **Improvement Plan:** | |
| 1. **P1:** Document usePageVariables and useNavigationOverlay hooks in the public docs |
Per-package audit of all 35 ObjectUI packages against @objectstack/spec v2.0.1, evaluating functional completeness, UI spec compliance, and API spec compliance.
SPEC_COMPLIANCE_EVALUATION.md
Key metrics
47 improvement items, prioritized
ROADMAP.md
Added cross-reference to the new evaluation document.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.