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

* feature: hex to grb returns undefined instead of null

* chore: bump deps

* ci: add CI

* ci: add bin

* chore: fix comments, add rabbit config

.coderabbit.yaml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: "en-US"
+reviews:
+  poem: false
+  review_status: false
+  auto_review:
+    enabled: true
+    drafts: false

.eslintrc

@@ -1,10 +1,5 @@
 {
-  "extends": [
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
-  "plugins": ["@typescript-eslint"],
-  "parser": "@typescript-eslint/parser",
+  "extends": ["@allthings/eslint-config"],
   "rules": {
     "@typescript-eslint/explicit-function-return-type": "off"
   }

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+This PR implements ...

.github/workflows/ci.yaml

@@ -0,0 +1,80 @@
+name: pipeline
+on: [ push ]
+
+env:
+  TAG_NAME: $(echo "${{ github.ref_name }}" | sed 's/[^a-zA-Z0-9._-]/_/g')
+  NVM_NODE_VERSION: 18
+  PROJECT: colors
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-lint:
+    runs-on:
+      group: default-runners
+      labels: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+        env:
+          CURRENT_RUNNER: ${{ runner.name }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NVM_NODE_VERSION }}
+
+      - name: build-and-lint
+        shell: bash
+        run: |
+          ./bin/node-version-manager.sh yarn install --production=false --frozen-lockfile
+          ./bin/node-version-manager.sh yarn build
+          ./bin/node-version-manager.sh yarn lint
+
+  dry-run-publish:
+    needs: [ build-and-lint ]
+    runs-on:
+      group: default-runners
+      labels: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+        env:
+          CURRENT_RUNNER: ${{ runner.name }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NVM_NODE_VERSION }}
+
+      - name: dry-run-publish
+        shell: bash
+        run: |
+          ./bin/node-version-manager.sh yarn install --production=false --frozen-lockfile
+          ./bin/node-version-manager.sh yarn build
+          ./bin/node-version-manager.sh npm publish --access public --tag latest --dry-run
+
+  publish-npm:
+    needs: [ dry-run-publish ]
+    # TODO: not working yet
+    if: false
+    # if: github.ref == 'refs/heads/master'
+    runs-on:
+      group: default-runners
+      labels: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+        env:
+          CURRENT_RUNNER: ${{ runner.name }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NVM_NODE_VERSION }}
+
+      - name: publish-npm
+        shell: bash
+        run: |
+          ./bin/node-version-manager.sh yarn install --production=false --frozen-lockfile
+          ./bin/node-version-manager.sh yarn build
+          ./bin/node-version-manager.sh npm publish --access public --tag latest

bin/node-version-manager.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# shellcheck disable=SC1090
+source ~/.bashrc
+export NVM_DIR=~/.nvm
+source ~/.nvm/nvm.sh
+source ~/.nvm/bash_completion
+{
+  nvm install "v$NVM_NODE_VERSION" --lts
+  nvm alias default "v$NVM_NODE_VERSION"
+  nvm alias node "v$NVM_NODE_VERSION"
+  nvm alias system "v$NVM_NODE_VERSION"
+  nvm use "v$NVM_NODE_VERSION"
+  npm install -g yarn
+
+  "$@"
+} || {
+  echo "An error occurred during execution."
+  exit 1
+}

package.json

@@ -2,19 +2,17 @@
   "name": "@allthings/colors",
   "author": "Allthings",
   "license": "MIT",
-  "version": "4.0.2",
+  "version": "5.0.0",
   "files": [
     "dist"
   ],
   "main": "dist/index.js",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
-    "eslint": "^8.38.0",
-    "eslint-config-prettier": "^8.8.0",
-    "prettier": "^2.8.7",
-    "rimraf": "^5.0.0",
-    "typescript": "^5.0.4"
+    "@allthings/eslint-config": "^2.1.1",
+    "eslint": "^8.57.0",
+    "prettier": "^3.3.2",
+    "rimraf": "^5.0.7",
+    "typescript": "^5.5.2"
   },
   "prettier": {
     "semi": false,

renovate.json

@@ -1,3 +1,4 @@
 {
-  "extends": ["@allthings", ":preserveSemverRanges"]
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["github>allthings/renovate-config", "docker:disable"]
 }

src/ColorPalette.ts

@@ -1,3 +1,4 @@
+/* eslint-disable sort-keys */
 const palette = {
   lightBlack: '#2c2c2c',
   lightBlackIntense: '#232323',
@@ -49,12 +50,14 @@ const background = {
   white: palette.white,
   none: palette.none,
 }
+
 const text = {
   primary: '#333333',
   secondary: '#626262',
   gray: '#bbbbbb',
   lightGray: '#e7ecee',
 }
+
 const primary = {
   gray: palette.lightGreyIntense,
   blue: palette.blue,
@@ -63,11 +66,13 @@ const primary = {
   red: palette.brownIntense,
   orange: palette.yellowOrangeIntense,
 }
+
 const state = {
   success: palette.mintIntense,
   warning: palette.yellowOrangeIntense,
   error: palette.redIntense,
 }
+
 const social = {
   facebook: '#3b5998',
   google: '#c53929',

src/alpha.ts

@@ -1,39 +1,42 @@
 import hexToRgb from './hexToRgb'
 import rgbToHex from './rgbToHex'
 
-export interface RGBColor {
+/* eslint-disable sort-keys, typescript-sort-keys/interface */
+export interface IRGBColor {
   r: number
   g: number
   b: number
 }
 
-function calculateTransparentColor(color: RGBColor, alpha: number) {
+const calculateTransparentColor = (color: IRGBColor, alphaNumber: number) => {
   const blendingColor = {
     r: 255,
     g: 255,
     b: 255,
   }
 
   return rgbToHex(
-    (1 - alpha) * blendingColor.r + alpha * color.r,
-    (1 - alpha) * blendingColor.g + alpha * color.g,
-    (1 - alpha) * blendingColor.b + alpha * color.b,
+    (1 - alphaNumber) * blendingColor.r + alphaNumber * color.r,
+    (1 - alphaNumber) * blendingColor.g + alphaNumber * color.g,
+    (1 - alphaNumber) * blendingColor.b + alphaNumber * color.b,
   )
 }
 
-export default function alpha(
+const alpha = (
   hex: string,
-  alpha: number,
+  alphaNumber: number,
   actualColor?: boolean,
-): string {
+): string => {
   const rgb = hexToRgb(hex)
-  if (rgb === null) {
+  if (rgb === undefined) {
     throw new Error(
       `\`hex\` value provided to \`alpha\` is not a HEX color, \`${hex}\` given.`,
     )
   }
 
   return actualColor
-    ? calculateTransparentColor(rgb, alpha)
-    : `rgba(${rgb.r}, ${rgb.g}, ${rgb.b}, ${alpha})`
+    ? calculateTransparentColor(rgb, alphaNumber)
+    : `rgba(${rgb.r}, ${rgb.g}, ${rgb.b}, ${alphaNumber})`
 }
+
+export default alpha

src/hexToRgb.ts

@@ -1,16 +1,23 @@
-import { RGBColor } from './alpha'
-
-export default function hexToRgb(hex: string): RGBColor | null {
+/* eslint-disable sort-keys */
+const hexToRgb = (
+  hex: string,
+): { b: number; g: number; r: number } | undefined => {
   // Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
   const shorthandRegex = /^#?([a-f\d])([a-f\d])([a-f\d])$/i
-  hex = hex.replace(shorthandRegex, (_m, r, g, b) => r + r + g + g + b + b)
+  const replacedHex = hex.replace(
+    shorthandRegex,
+    (_m, r, g, b) => r + r + g + g + b + b,
+  )
+
+  const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(replacedHex)
 
-  const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex)
   return result
     ? {
-        r: parseInt(result[1], 16),
-        g: parseInt(result[2], 16),
-        b: parseInt(result[3], 16),
+        r: Number.parseInt(result[1], 16),
+        g: Number.parseInt(result[2], 16),
+        b: Number.parseInt(result[3], 16),
       }
-    : null
+    : undefined
 }
+
+export default hexToRgb

src/index.ts

@@ -1,4 +1,4 @@
-export { default as ColorPalette } from './ColorPalette'
 export { default as alpha } from './alpha'
+export { default as ColorPalette } from './ColorPalette'
 export { default as hexToRgb } from './hexToRgb'
 export { default as rgbToHex } from './rgbToHex'

src/rgbToHex.ts

@@ -1,8 +1,8 @@
-export default function rgbToHex(
-  red: number,
-  green: number,
-  blue: number,
-): string {
+const rgbToHex = (red: number, green: number, blue: number): string => {
+  // eslint-disable-next-line no-bitwise
   const rgb = blue | (green << 8) | (red << 16)
-  return '#' + (0x1000000 + rgb).toString(16).slice(1)
+
+  return `#${(0x1_00_00_00 + rgb).toString(16).slice(1)}`
 }
+
+export default rgbToHex

tsconfig.json

@@ -1,19 +1,19 @@
 {
   "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
+    "allowSyntheticDefaultImports": true,
     "declaration": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "outDir": "dist",
     "removeComments": true,
     "strict": true,
-    "noImplicitAny": true,
     "strictNullChecks": true,
     "strictFunctionTypes": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true
+    "target": "es2021"
   },
   "include": ["src"],
   "exclude": ["node_modules", "lib"]