feature(v5.0.0): hex to grb returns undefined instead of null

[DmitryMarkov]

Summary by CodeRabbit

• New Features

  • Introduced a new GitHub Actions workflow for building, linting, and publishing npm packages.
  • Added .coderabbit.yaml for language server integration and review automation.

• Enhancements

  • Updated dependencies in package.json to enhance performance and compatibility.
  • Added more colors and reorganization in the color palette.

• Refactor

  • Improved readability and maintainability of various functions using modern JavaScript syntax and better structuring.
  • Reordered export statements for better organization.

• Configuration

  • Updated ESLint configuration to use a new extendable configuration.
  • Updated TypeScript compiler options in tsconfig.json.

• Documentation

  • Updated the pull request template for better clarity and structure.

[coderabbitai]

Walkthrough

The changes span configuration updates, dependency adjustments, and workflow enhancements. Highlights include an updated ESLint configuration, a new GitHub Actions pipeline for building and publishing, and several TypeScript enhancements. Key scripts have been cleaned up for better readability and maintainability, focusing on functionality improvements and consistency. The updates collectively aim to streamline the development process and ensure code quality through better tooling and automation.

Changes

File	Summary
.eslintrc	Changed extends to use @allthings/eslint-config.
`.github/PULL_REQUEST_TEMPLATE…	Updated PR template without changes to public entities.
.github/workflows/ci.yaml	Introduced a new pipeline with steps for building, linting, and publishing an npm package.
bin/node-version-manager.sh	Setup NVM, install packages, and configure aliases without public entity changes.
package.json	Incremented version to 5.0.0 and updated several dependencies.
renovate.json	Updated configuration to use a new JSON schema URL and modified extension references.
src/ColorPalette.ts	Reorganized and added color definitions; added ESLint disable comments.
src/alpha.ts	Renamed RGBColor to IRGBColor and updated related functions for clarity.
src/hexToRgb.ts	Refactored hexToRgb to handle hex color conversion more efficiently.
src/index.ts	Reordered export statements, moving ColorPalette export to the end.
src/rgbToHex.ts	Updated rgbToHex to use arrow function syntax and template literals.
tsconfig.json	Updated TypeScript compiler options to enhance code quality and consistency.
.coderabbit.yaml	Introduced language server settings and review automation options.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 14b3d56 and e2b97c7.

Files selected for processing (2)

• .coderabbit.yaml (1 hunks)
• bin/node-version-manager.sh (1 hunks)

Files skipped from review due to trivial changes (1)

• .coderabbit.yaml

Files skipped from review as they are similar to previous changes (1)

• bin/node-version-manager.sh

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a9cb6b6 and 14b3d56.

Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

Files selected for processing (12)

• .eslintrc (1 hunks)
• .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
• .github/workflows/ci.yaml (1 hunks)
• bin/node-version-manager.sh (1 hunks)
• package.json (1 hunks)
• renovate.json (1 hunks)
• src/ColorPalette.ts (3 hunks)
• src/alpha.ts (1 hunks)
• src/hexToRgb.ts (1 hunks)
• src/index.ts (1 hunks)
• src/rgbToHex.ts (1 hunks)
• tsconfig.json (1 hunks)

Files not reviewed due to errors (1)

• .github/workflows/ci.yaml (no review received)

Files skipped from review due to trivial changes (6)

• .eslintrc
• .github/PULL_REQUEST_TEMPLATE.md
• package.json
• renovate.json
• src/index.ts
• src/rgbToHex.ts

Additional context used

Shellcheck

bin/node-version-manager.sh

[warning] 2-2: ShellCheck can't follow non-constant source. Use a directive to specify location. (SC1090)

---

[warning] 4-4: ShellCheck can't follow non-constant source. Use a directive to specify location. (SC1090)

---

[warning] 5-5: ShellCheck can't follow non-constant source. Use a directive to specify location. (SC1090)

Additional comments not posted (6)

bin/node-version-manager.sh (1)

7-11: Ensure Node.js version management is robust.

The script uses NVM to manage Node.js versions. It's crucial to ensure that the environment variable NVM_NODE_VERSION is always set before this script runs to avoid errors.

Verification successful

---

Node.js version management check is robust.

The script correctly checks if the environment variable NVM_NODE_VERSION is set before executing the NVM commands, ensuring robust Node.js version management.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Check if NVM_NODE_VERSION is set before running the script.

if [ -z "$NVM_NODE_VERSION" ]; then
  echo "NVM_NODE_VERSION is not set."
  exit 1
else
  echo "NVM_NODE_VERSION is set to $NVM_NODE_VERSION."
fi

Length of output: 91

tsconfig.json (1)

3-16: Updated TypeScript configuration enhances project robustness.

The changes in the TypeScript configuration, such as enabling allowSyntheticDefaultImports, noImplicitAny, and updating the target to es2021, are positive steps towards ensuring better code quality and compatibility.

src/hexToRgb.ts (1)

2-20: Refactored hexToRgb function enhances readability and functionality.

The refactoring of the hexToRgb function to handle shorthand hex colors and return RGB values more explicitly is a significant improvement. The use of regex for expanding shorthand colors and parsing them into RGB values is efficient and clear.

src/alpha.ts (2)

11-21: Improved color blending in calculateTransparentColor.

The function calculateTransparentColor uses a straightforward blending formula to mix colors based on the alpha value. This method ensures that colors are blended accurately, improving the function's utility in various contexts.

---

25-42: Robust error handling and functionality in alpha function.

The alpha function now includes robust error handling for invalid HEX colors and offers a clear choice between returning a transparent color or an RGBA string. This makes the function more reliable and versatile.

src/ColorPalette.ts (1)

Line range hint 1-75: Well-organized and clearly defined color palette.

The reorganization of color definitions into categories such as background, text, primary, state, and social enhances the usability and maintainability of the color palette. This structured approach allows for easier modifications and better scalability.