Dev - #23
Merged
Merged
Conversation
- Created funding.yml to include funding options for the project.
chore: add funding information
- Updated license from ISC to MIT in package-lock.json - Adjusted React and React-DOM versions to 19.2.0 in package-lock.json - Enhanced package.json with detailed metadata including description, repository, and funding information - Updated Node engine requirement to >=20 in package.json - Added build script to package.json
- Set access to public for package publishing
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…or-publish chore: finalize package.json and package-lock.json for publish
- Added JSDoc comments to the For component for better clarity. - Included an example usage in the documentation.
- Added detailed documentation comments for the Match component. - Included usage examples and remarks for better understanding.
- Added detailed documentation comments for the Show component. - Included an example usage in the comments for clarity.
- Added JSDoc comments to describe the functionality of the Switch component. - Included an example usage of the Switch component with Match children.
- Removed links from remarks for clarity
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Docs/add documentation comments
- Added a comprehensive introduction to JSX Utils. - Included a table of contents for easier navigation. - Expanded documentation sections with installation instructions and examples. - Provided usage examples for key components: Show, Match, Switch, and For.
docs: enhance README with detailed library information
- Changed package name from "@fabi-dev/jsx-utils" to "@fabiothefox/jsx-utils"
- Corrected NPM package name for installation. - Updated GitHub installation command with the correct package name. - Adjusted `.npmrc` file instructions to reflect the correct registry.
- Create a GitHub Actions workflow for automated release publishing. - Configure steps for building, testing, and publishing to GitHub Packages. - Include asset packing and uploading as part of the release process.
Ci/add autopublish ci
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves project documentation, package distribution metadata, and adds release automation for publishing the React JSX control-flow utility library.
Changes:
- Rewrites the README with installation, usage examples, and AI transparency notes.
- Adds JSDoc examples for
Show,Match,Switch, andFor. - Updates package metadata and introduces GitHub Packages publishing plus funding metadata.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/components/Switch.tsx |
Adds JSDoc documentation and usage example. |
src/components/Show.tsx |
Adds JSDoc documentation and usage example. |
src/components/Match.tsx |
Adds JSDoc documentation and usage example. |
src/components/For.tsx |
Adds JSDoc documentation and usage example. |
README.md |
Expands project overview, install instructions, examples, and transparency notes. |
package.json |
Updates package identity, exports, metadata, scripts ordering, dependencies, engines, and package manager. |
package-lock.json |
Updates selected root package metadata and dependency ranges. |
.github/workflows/release-publish.yml |
Adds release workflow for build/test/package/upload/publish. |
.github/funding.yml |
Adds funding links for GitHub Sponsors, Ko-fi, and PayPal. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several improvements to the project, focusing on enhancing documentation, updating package metadata, and adding automation for releases. The main highlights include a comprehensive rewrite of the
README.mdfor better clarity and onboarding, improved inline documentation for all main components, and the addition of a GitHub Actions workflow for automated publishing. Package metadata inpackage.jsonhas also been updated for better distribution and discoverability.Documentation Improvements
README.mdto include detailed project description, installation instructions, usage examples, and an AI usage transparency section.Show,Match,Switch, andFor, making the codebase more approachable and editor-friendly. [1] [2] [3] [4]Package Metadata and Publication
package.jsonwith accurate package name, description, author, exports, repository info, keywords, funding, and publish configuration for better npm and GitHub compatibility.package.jsonto ensure compatibility and correct peer dependency versions..github/funding.ymlto provide funding links for GitHub Sponsors, Ko-fi, and PayPal.Continuous Integration / Delivery
.github/workflows/release-publish.ymlGitHub Actions workflow to automate building, testing, packaging, and publishing releases to GitHub Packages, including uploading release assets.