docs: add README for luna-reactlynx, update docs for related packages#86
docs: add README for luna-reactlynx, update docs for related packages#86
luna-reactlynx, update docs for related packages#86Conversation
🦋 Changeset detectedLatest commit: 6ea79e9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
✅ Files skipped from review due to trivial changes (9)
WalkthroughAdded a new public package Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
luna-reactlynx, update README across luna packagesluna-reactlynx, update docs for related packages
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
packages/reactlynx/README.md (1)
91-95: Consolidate duplicatedas: 'var-name'explanation.Lines 92-95 repeat the same idea twice; trimming to one concise explanation will improve readability and reduce drift risk.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/reactlynx/README.md` around lines 91 - 95, Remove the duplicated explanation of the as: 'var-name' mode and replace both blocks with a single concise sentence that states: "as: 'var-name' returns the bare CSS custom property name (--xxx) rather than a complete CSS value, useful for building expressions like var(--xxx, fallback) or calc(...)." Keep the surrounding discussion of format and as: 'result' intact and ensure references to format and as: 'var-name' remain correct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.changeset/config.json:
- Around line 15-16: The package version for `@dugyu/luna-reactlynx` must be
bumped from 0.1.0 to 0.1.1 in its package.json to match `@dugyu/luna-core` (0.1.1)
so the fixed dependency group is consistent; after updating the
`@dugyu/luna-reactlynx` package version, update the corresponding changeset entry
(jolly-bottles-ask.md) so it reflects that reactlynx is joining the fixed group
at 0.1.1 rather than starting at 0.1.0.
In `@packages/reactlynx/package.json`:
- Line 3: Update the "version" field in package.json from "0.1.0" to "0.1.1" so
this package matches the fixed dependency group; locate the version entry in
packages/reactlynx/package.json (the "version" key) and change its value to
"0.1.1".
In `@packages/reactlynx/README.md`:
- Line 190: Replace the ambiguous heading text "Lynx 3.6- friendly" with the
explicit form "Lynx < 3.6 friendly" to match the style used elsewhere (e.g., the
heading at Line 161) so readers clearly understand the version constraint;
update every occurrence of the heading string in the README (including the
second instance noted) to the new "Lynx < 3.6 friendly" phrasing.
- Line 58: Guard the example's access to lynx.__globalProps by using optional
chaining so the themeKey expression won't throw when lynx or __globalProps is
undefined; update the themeKey usage (referencing the themeKey prop and
lynx.__globalProps) to read the lunaTheme via optional chaining (e.g.
lynx?.__globalProps?.lunaTheme) and fall back to 'lunaris-light'.
---
Nitpick comments:
In `@packages/reactlynx/README.md`:
- Around line 91-95: Remove the duplicated explanation of the as: 'var-name'
mode and replace both blocks with a single concise sentence that states: "as:
'var-name' returns the bare CSS custom property name (--xxx) rather than a
complete CSS value, useful for building expressions like var(--xxx, fallback) or
calc(...)." Keep the surrounding discussion of format and as: 'result' intact
and ensure references to format and as: 'var-name' remain correct.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 98c25628-3bda-49ef-8635-2be9422bd584
📒 Files selected for processing (9)
.changeset/config.json.changeset/few-places-repeat.md.changeset/jolly-bottles-ask.mdpackages/core/README.mdpackages/reactlynx/README.mdpackages/reactlynx/package.jsonpackages/styles/README.mdpackages/tailwind/README.mdpackages/tokens/README.md
aa12ee1 to
b66cfc5
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/tailwind/README.md (1)
77-79: Clarify whether@dugyu/luna-reactlynxis required or optional in setup.At Line 79,
@dugyu/luna-reactlynxis listed as runtime integration, but Installation (Lines 9-12) doesn’t show when to install it. Add an “optional if using provider/hooks” install line (or explicitly state it is not required for Tailwind-only usage) to prevent onboarding confusion.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/tailwind/README.md` around lines 77 - 79, Update the README to clarify that `@dugyu/luna-reactlynx` is optional: in the Installation section add a line like "Optional: install `@dugyu/luna-reactlynx` if you plan to use the ReactLynx provider/hooks" or alternatively state explicitly that `@dugyu/luna-reactlynx` is not required for Tailwind-only usage; reference the package names `@dugyu/luna-tailwind` and `@dugyu/luna-reactlynx` so readers know which package is optional and when to install it.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@packages/tailwind/README.md`:
- Around line 77-79: Update the README to clarify that `@dugyu/luna-reactlynx` is
optional: in the Installation section add a line like "Optional: install
`@dugyu/luna-reactlynx` if you plan to use the ReactLynx provider/hooks" or
alternatively state explicitly that `@dugyu/luna-reactlynx` is not required for
Tailwind-only usage; reference the package names `@dugyu/luna-tailwind` and
`@dugyu/luna-reactlynx` so readers know which package is optional and when to
install it.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: b3dc45b6-56cb-4d7c-9e0a-f62b5c60f6fd
📒 Files selected for processing (9)
.changeset/config.json.changeset/few-places-repeat.md.changeset/jolly-bottles-ask.mdpackages/core/README.mdpackages/reactlynx/README.mdpackages/reactlynx/package.jsonpackages/styles/README.mdpackages/tailwind/README.mdpackages/tokens/README.md
✅ Files skipped from review due to trivial changes (7)
- .changeset/jolly-bottles-ask.md
- packages/core/README.md
- .changeset/config.json
- .changeset/few-places-repeat.md
- packages/styles/README.md
- packages/tokens/README.md
- packages/reactlynx/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/reactlynx/package.json
b66cfc5 to
6ea79e9
Compare
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @dugyu/luna-reactlynx@0.2.0 ### Minor Changes - Initial release. ([#86](#86)) ### Patch Changes - Updated dependencies \[[`c47a909`](c47a909)]: - @dugyu/luna-core@0.2.0 ## @dugyu/luna-core@0.2.0 ### Patch Changes - Update README. ([#86](#86)) ## @dugyu/luna-styles@0.2.0 ### Patch Changes - Update README. ([#86](#86)) ## @dugyu/luna-tailwind@0.2.0 ### Patch Changes - Update README. ([#86](#86)) ## @dugyu/luna-tokens@0.2.0 ### Patch Changes - Update README. ([#86](#86)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Summary by CodeRabbit
New Features
@dugyu/luna-reactlynxwith ReactLynx theming integration.Documentation
Chores
@dugyu/luna-reactlynxpublicly publishable and updated package grouping/configuration.