color-name-list 13.12.0 → 13.13.1

package/CONTRIBUTING.md

@@ -7,17 +7,26 @@ interactions with the project.
 
 ## Adding colors
 
-1. Only update the `src/colornames.csv` file and run `npm run test`
+1. Only update the `src/colornames.csv` file and run `npm test`.
 2. Make sure the names you commit are not racist or offensive or a protected
    brand name (No Facebook Blue, Coca Cola Red etc.., no nationality or tan etc..).
 3. Read the "Rules for new color names" directly below
 4. Make sure that neither name nor hex value of your added colors are already
-   in use. `npm run test` will test that for you.
-5. Update the `README.md` with the source of your colors, unless you invented
-   that color, in this case add yourself to the contributors in the `README.md`
+  in use. `npm test` will test that for you.
+5. Do not edit generated files. Do not commit changes to `README.md`,
+  `changes.svg` or anything in `dist/`.
+6. Add the source of your colors in the Pull Request description.
+  Maintainers will update documentation if needed.
 
 **We use automated semantic versioning** make sure to use git cz (or npm run commit).
 
+## Generated files and CI
+
+- PRs run `npm ci`, `npm run build`, and `npm test` in CI.
+- CI may update `README.md` and `changes.svg` automatically and push
+  to your PR branch.
+- Do not include generated files (`dist/`, `README.md`, `changes.svg`) in commits.
+
 ## Rules for new color names
 
 - No duplicate names or hex values.
@@ -41,6 +50,7 @@ interactions with the project.
   **feat(colors): Add fantastic new colors names.** rather then
   feat(colors): Added new names.
 - Make sure to run `npm run test` before committing.
+  For color name changes this is the only command you need locally.
 
 ### Attribution
 

package/README.md

@@ -13,7 +13,7 @@
 [![npm](https://img.shields.io/npm/dt/color-name-list.svg)](https://www.npmjs.com/package/color-name-list)
 [![github sponsor count](https://img.shields.io/github/sponsors/meodai)](https://github.com/sponsors/meodai)
 
-A meticulously curated collection of __29979__ unique color names, sourced from
+A meticulously curated collection of __29985__ unique color names, sourced from
 [various references](#sources-) and thousands of thoughtful user contributions.
 
 > The names of color function like a thread attached to a frightfully slender
@@ -62,9 +62,20 @@ Please review the [naming rules](CONTRIBUTING.md) before contributing!
 ### Contributing via Git 🫱🏽‍🫲🏻
 
 To contribute via Git, edit the `src/colornames.csv` file
-and ensure it builds correctly (`npm run ci && npm run build`).
+and ensure tests pass locally (`npm test`).
 
-## Color Count: __29979__ 🎉
+See the full guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+CI notes:
+
+- Pull Requests run `npm ci`, `npm run build`, and `npm test`.
+- CI auto-updates `README.md` and `changes.svg` if needed and pushes to your PR branch.
+- Do not commit generated files (`dist/`, `changes.svg`).
+- For color name changes, only submit updates to `src/colornames.csv`.
+- No need to run `npm run build` locally; CI generates outputs.
+- Optional locally: `npm run lint:markdown` to match CI markdown checks.
+
+## Color Count: __29985__ 🎉
 
 ~__0.18%__ of the RGB color space
 
@@ -144,9 +155,15 @@ only on a few dependencies: [Color-Name-API](https://github.com/meodai/color-nam
 
 ### Usage JS ⌨
 
-__Size Warning (1.16 MB)__: For browser usage,
+__Size Warning (1.14 MB)__: For browser usage,
 consider the [public rest API](#api-)
 
+#### Data Shape
+
+```ts
+type ColorName = { name: string; hex: string };
+```
+
 #### Exact Color
 
 ```javascript
@@ -159,6 +176,16 @@ let someNamedColor = colornames.find((color) => color.name === 'Eigengrau');
 console.log(someColor.hex); // => #16161d
 ```
 
+#### CommonJS
+
+```js
+// Returns the array directly when using CommonJS
+const colornames = require('color-name-list');
+
+const white = colornames.find((c) => c.hex === '#ffffff');
+console.log(white.name); // => white
+```
+
 #### Closest Named Color
 
 With 16,777,216 possible RGB colors, you may want to use a library such as

package/changes.svg

@@ -1,4 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 600 220">
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 600 570">
   <defs>
     <style type="text/css">
       @import url('https://rsms.me/inter/inter.css');
@@ -9,6 +9,6 @@
       }
     </style>
   </defs>
-  <rect fill="#212121" x="0" y="0" width="600" height="220"/>
-  <text x="40" y="90" fill="#555b59">Crucible</text><text x="40" y="160" fill="#ebeb57">Pineapple High</text>
+  <rect fill="#212121" x="0" y="0" width="600" height="570"/>
+  <text x="40" y="90" fill="#c8b960">Almond Puff</text><text x="40" y="160" fill="#5f1a10">Altar Wine</text><text x="40" y="230" fill="#83c0e5">Billow</text><text x="40" y="300" fill="#877732">Dragon Well</text><text x="40" y="370" fill="#363e7d">Evening Magic</text><text x="40" y="440" fill="#377b70">Pearl Green</text><text x="40" y="510" fill="#5e0e0b">Sacramental Red</text>
 </svg>

package/dist/colornames.bestof.csv

@@ -1276,6 +1276,7 @@ Ethereal Moonlight,#d5e4ec
 Ethereal Woods,#3e5e4e
 Eucalyptus,#329760
 Evening Glow,#fdd792
+Evening Magic,#363e7d
 Everglade,#264334
 Evergreen,#125b49
 Everlasting Ice,#f6fdfa
@@ -3175,6 +3176,7 @@ Peanut Butter Jelly,#ce4a2d
 Pear,#d1e231
 Pearl,#eae0c8
 Pearl Brite,#e6e6e3
+Pearl Green,#377b70
 Pearl Powder,#faffed
 Pearl White,#f3f2ed
 Pearly,#f4e3df
@@ -3668,6 +3670,7 @@ Rusty Red,#af2f0d
 Ruthless Empress,#573894
 Sablé,#f6d8be
 Sable Cloaked,#c4a7a1
+Sacramental Red,#5e0e0b
 Sacred Scarlet,#950c1b
 Sacrifice Altar,#850101
 Sacro Bosco,#229911