Docs and JSON schema for ignore rules dotfiles #30
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA new "Code Security" section has been introduced, including navigation metadata, a documentation page describing ignore rule formats, and a JSON schema for ignore rules. Supporting metadata files were added for the new section, with no modifications to existing content outside of adding the new navigation entry. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
public/code-security/oneleetignore.schema.json (1)
16-48: Tighten the rule-object itself (additionalProperties: false).To avoid silent acceptance of misspelled keys inside each rule:
"items": { "type": "object", + "additionalProperties": false,pages/_meta.ts (1)
8-8: Minor ordering nit – keep keys alphabetised for easier diffing.
"code-security"should slot between"guides"and"integrations"(or wherever alphabetical order is maintained) to reduce merge conflicts in the future.pages/code-security/_meta.ts (1)
1-1: Populate_metato control page ordering / titles.Leaving the object empty means the directory fallback ordering (alphabetical by filename) will apply.
If you intend “Ignore rules” to appear with a specific title or order, define it here now to avoid a breaking nav change later.Example:
export default { "ignore-rules": "Ignore rules" };pages/code-security/ignore-rules.mdx (1)
33-34: Prefer a root-relative$schemaURI to avoid hard-coding the domain.Using an absolute URL ties local / preview builds to production.
Suggest:- "$schema": "https://docs.oneleet.com/code-security/oneleetignore.schema.json", + "$schema": "/code-security/oneleetignore.schema.json",VS Code and hosted docs will both resolve this correctly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (4)
pages/_meta.ts(1 hunks)pages/code-security/_meta.ts(1 hunks)pages/code-security/ignore-rules.mdx(1 hunks)public/code-security/oneleetignore.schema.json(1 hunks)
🔇 Additional comments (1)
pages/code-security/ignore-rules.mdx (1)
41-42: Link setting name is outdated in recent VS Code versions.The setting was renamed to
json.schemaDownload.enable→json.schemaDownload.enable.
Double-check and update to avoid confusing readers. (If it’s still correct in your tested version, feel free to ignore.)
|
Thanks for the approval. Let's merge when we release the code security updates to prod. |
Problem
We need to document Code Security ignore rules dotfiles (.oneleetignore.json, etc).
Solution
Summary by CodeRabbit
New Features
Documentation