color-name-list 13.13.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

@@ -62,7 +62,18 @@ 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`).
+
+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__ 🎉
 
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "color-name-list",
-  "version": "13.13.0",
+  "version": "13.13.1",
   "description": "long list of color names",
   "main": "dist/colornames.json",
   "browser": "dist/colornames.umd.js",

package/scripts/build.js

@@ -288,8 +288,8 @@ fs.writeFileSync(
       `__${((colorsSrc.entries.length / (256 * 256 * 256)) * 100).toFixed(2)}%__`
     )
     .replace(
-      // update file size
-      /\d+(\.\d+)? MB\)__/, // no global to only hit first occurrence
+      // update file size (update all occurrences)
+      /\d+(\.\d+)? MB\)__+/g,
       `${(
         fs.statSync(path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.json`)).size /
         1024 /