Skip to content

🧾 test: Require Every Appearance Key to Be Listed as Documented - #17357

Merged
berry-13 merged 2 commits into
devfrom
berry-13/theme-docs-keys
Oct 23, 2026
Merged

berry-13 merged 2 commits into
devfrom
berry-13/theme-docs-keys

Conversation

@berry-13

Copy link
Copy Markdown
Collaborator

Pull Request

Summary

The librechat.ai theme page trailed the schema: checkboxRadius, checkboxFillStyle and compactPanelRadius shipped without rows. This adds themedocs.json, the list of appearance keys the page documents, and a spec that fails when themeAppearanceProperties has a key the list lacks (or the list names a key the schema dropped), so a new role cannot land without its docs row. The list matches the page once LibreChat-AI/docs#853 merges.

Type of change

  • Tests / tooling / CI

Testing

  • cd packages/data-provider && npx jest specs/themedocs.spec.ts: 2 passed
  • npx eslint and npx prettier --check on the new files: clean
  • npx tsc --noEmit in packages/data-provider: clean

Risk / compatibility

None. Test-only.

Checklist

Copilot AI balanced review requested due to automatic review settings October 22, 2026 17:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-22T20:05:46.125885Z 9ce5488 New commits
🔒 Security Review ✅ Completed 2026-10-22T17:49:47.589505Z ffbd523 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9ce5488348

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

const keys = Object.keys(themeAppearanceProperties);

it('lists every appearance key', () => {
expect(keys.filter((key) => !documented.includes(key))).toEqual([]);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Verify the documentation instead of the local manifest

When an appearance key is added, a contributor can append the same string to themedocs.json and both new tests pass without adding any documentation—the Playwright counterpart also compares only this manifest with registry.ts. This already happens for checkboxRadius, checkboxFillStyle, and compactPanelRadius, which the manifest declares but the current theme page does not contain. To enforce the stated invariant, compare against the documentation source or have the documentation repository validate/generate its table from this manifest.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deferred on 9ce5488: the manifest is an acknowledgement list; the three checkbox and compact-panel keys are absent from the live page only because LibreChat-AI/docs#853 is not merged. Enforcing against the docs source belongs in the docs repository, tracked at berry-13#413

@berry-13
berry-13 merged commit 920a82b into dev Oct 23, 2026
42 checks passed
@berry-13
berry-13 deleted the berry-13/theme-docs-keys branch October 23, 2026 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants