chore: initial commit

Author: jamieweavis

.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm clean-install
+      - run: npm run lint
+      - run: npm run build
+
+  test:
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm clean-install
+      - run: npm test
+
+#  release:
+#    needs: [test]
+#    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+#    runs-on: ubuntu-latest
+#    permissions:
+#      contents: write # to be able to publish a GitHub release
+#      issues: write # to be able to comment on released issues
+#      pull-requests: write # to be able to comment on released pull requests
+#      id-token: write # to enable use of OIDC for npm provenance
+#    steps:
+#      - uses: actions/checkout@v4
+#      - uses: actions/setup-node@v4
+#        with:
+#          node-version: 22.x
+#      - run: npm clean-install
+#      - run: npm audit signatures
+#      - run: npm run build
+#      - run: npx semantic-release
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+.parcel-cache/
+node_modules/
+coverage/
+lib/

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1 @@
+npx --no -- lint-staged

.husky/pre-push

@@ -0,0 +1 @@
+npm run lint && npm run build && npm run test

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Jamie Weavis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,108 @@
+# String to Tailwind Color
+
+> Generates a random but deterministic Tailwind CSS color and shade from a string
+
+[![ci](https://github.com/jamieweavis/string-to-tailwind-color/workflows/ci/badge.svg)](https://github.com/jamieweavis/string-to-tailwind-color/actions)
+[![downloads](https://img.shields.io/npm/dt/string-to-tailwind-color.svg)](https://npmjs.com/package/string-to-tailwind-color)
+[![version](https://img.shields.io/npm/v/string-to-tailwind-color.svg)](https://github.com/jamieweavis/string-to-tailwind-color/releases)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jamieweavis/string-to-tailwind-color/blob/main/LICENSE)
+
+## Install
+
+```sh
+npm install string-to-tailwind-color
+```
+
+## Usage
+
+Generate a random but deterministic Tailwind CSS color and shade from a string:
+
+```javascript
+import { stringToTailwindColor } from 'string-to-tailwind-color';
+
+const foo = stringToTailwindColor('foo');
+console.log(foo); // 'teal-500'
+
+const bar = stringToTailwindColor('bar');
+console.log(bar); // 'emerald-100'
+```
+
+By default all colors and shades are used - to use a subset of colors and/or shades, you can pass an options object as the second argument:
+
+```javascript
+import { stringToTailwindColor } from 'string-to-tailwind-color';
+
+const foo = stringToTailwindColor('foo', {
+  colors: ['red', 'green', 'blue'],
+  shades: [300, 500, 700],
+});
+
+console.log(foo); // 'red-300'
+```
+
+> [!NOTE]
+> For a full list of colors and shades see [https://tailwindcss.com/docs/colors](https://tailwindcss.com/docs/colors)
+
+
+If you don't like the color generated for a particular string, you can use the `hashOffset` option to rotate the color (incrememnting by 1 will give you a shade higher, decrementing by 1 will give you a shade lower, colors will also rotate):
+
+```javascript
+import { stringToTailwindColor } from 'string-to-tailwind-color';
+
+const a = stringToTailwindColor('foo');
+console.log(a); // 'teal-500'
+
+const b = stringToTailwindColor('foo', { hashOffset: 1 });
+console.log(b); // 'teal-600'
+
+const c = stringToTailwindColor('foo', { hashOffset: 11 });
+console.log(c); // 'cyan-500'
+```
+
+Use in combination with background color (`bg-`), text color (`text-`), border color (`border-`), etc:
+
+```javascript
+import { stringToTailwindColor } from 'string-to-tailwind-color';
+
+const SomeComponent = ({ text }) => {
+  const color = stringToTailwindColor(text);
+  return (
+    <p className={`bg-${color} text-${color} border-${color}`}>
+      {text}
+    </p>
+  );
+};
+```
+
+> [!NOTE]
+> For a full list of classes compatible with color see [https://tailwindcss.com/docs/colors#using-color-utilities](https://tailwindcss.com/docs/colors#using-color-utilities)
+
+## Use Cases
+
+Generate a color for a tag component based on it's contents:
+
+```javascript
+import { stringToTailwindColor } from 'string-to-tailwind-color';
+
+const Tag = ({ name }) => {
+  const color = stringToTailwindColor(name, {
+    colors: ['red', 'green', 'blue', 'yellow', 'purple', 'pink'],
+    shades: [300, 400, 500, 600, 700],
+  });
+  return (
+    <span className={`bg-${color} text-white px-2 py-1 rounded`}>
+      {name}
+    </span>
+  );
+};
+```
+
+## Built with
+
+- [Node.js](https://github.com/nodejs/node)
+- [TypeScript](https://github.com/microsoft/TypeScript)
+- [Parcel](https://github.com/parcel-bundler/parcel)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

biome.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": []
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  }
+}