Move readme #132
Move readme #132
Conversation
- Moved README.md to packages/arkenv - Updated documentation structure - Improved documentation content - Updated example configurations - Updated plugins section
- Disabled `noUnknownAtRules` in Biome. - Added radix to `parseInt` in `arkenv`. - Added `!important` to octicon styles.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughUpdates documentation across README files, adjusts release script, tweaks linter configuration and a CSS lint ignore, switches a remark plugin in docs source config, and makes Number.parseInt use an explicit base-10 radix in a port parser. No public APIs changed; no runtime control flow added. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Pre-merge checks (2 passed, 1 inconclusive)❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
biome.jsonc (1)
42-44: Don’t disable noUnknownAtRules globally; scope it to CSS.Turning this off at the top-level can hide real at‑rule typos. Prefer an override for CSS only (or for folders using custom at‑rules).
Apply:
"suspicious": { - "noConsole": "warn", - "noUnknownAtRules": "off" + "noConsole": "warn" }, @@ "overrides": [ { "includes": ["**/examples/**/*", "**/playground/**/*"], "linter": { "rules": { "suspicious": { "noConsole": "off" } } } }, + { + "includes": ["**/*.css"], + "linter": { + "rules": { + "suspicious": { + "noUnknownAtRules": "off" + } + } + } + } ]README.md (1)
1-1: Make the pointer a clickable link.Improves UX on GitHub.
-packages/arkenv/README.md +See the [ArkEnv README](packages/arkenv/README.md).Note: Per repo guidelines, ensure environment requirements are documented in packages/arkenv/README.md.
packages/arkenv/src/types.ts (1)
6-14: Good: explicit radix. Consider rejecting mixed strings (e.g., "123abc").parseInt accepts trailing junk; tighten to digits-only.
export const port = type("string", "=>", (data, ctx) => { - const asNumber = Number.parseInt(data, 10); + const raw = data.trim(); + if (!/^\d+$/.test(raw)) { + ctx.mustBe("a string containing only decimal digits"); + } + const asNumber = Number.parseInt(raw, 10); const isInteger = Number.isInteger(asNumber); const isBetween = 0 <= asNumber && asNumber <= 65535; if (!isInteger || !isBetween) { ctx.mustBe("an integer between 0 and 65535"); } return asNumber; });Add a test to lock behavior:
it("rejects non-digit content", () => { expect(() => port.assert("123abc")).toThrow(); });apps/www/app/styles/components/github-alerts.css (1)
96-99: Local ignore is OK; consider avoiding !important.If possible, raise specificity (e.g.,
.markdown-alert-title .octicon) to drop!important.packages/arkenv/README.md (1)
73-74: Clarify README’s “Lightweight” claim and note ArkType peer dependencyAt packages/arkenv/README.md lines 73–74, replace the snippet with:
- 🪶 **Lightweight**: Only a single dependency ([5.6 kB](https://bundlephobia.com/package/[email protected])) + 🪶 **Lightweight**: Small install size (see the bundle size badge). + Note: ArkType is required alongside ArkEnv.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
README.md(0 hunks)README.md(1 hunks)apps/www/app/styles/components/github-alerts.css(1 hunks)apps/www/source.config.ts(2 hunks)biome.jsonc(1 hunks)package.json(1 hunks)packages/arkenv/README.md(1 hunks)packages/arkenv/src/types.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/README.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Document environment requirements in README files
Files:
packages/arkenv/README.mdREADME.md
🧬 Code graph analysis (1)
packages/arkenv/src/types.ts (2)
packages/arkenv/src/scope.test.ts (2)
portType(28-31)portType(22-26)packages/arkenv/src/types.test.ts (2)
port(19-19)it(4-21)
🔇 Additional comments (1)
apps/www/source.config.ts (1)
1-1: Confirm plugin availability in fumadocs-core
Ensure that version 15.7.10 of fumadocs-core actually exportsremarkNpmfrom itsmdx-pluginsentry point and that no extra configuration options are required.
Summary by CodeRabbit
Bug Fixes
Documentation
Chores