color-name-list 11.24.1 → 11.24.2

package/CONTRIBUTING.md

@@ -41,7 +41,7 @@ interactions with the project.
 - Write your commit messages in imperative form:
   **feat(colors): Add fantastic new colors names.** rather then
   feat(colors): Added new names.
-- Make sure to run `npm run build` before committing. (No need to `npm ci` the
+- Make sure to run `npm run test` before committing. (No need to `npm ci` the
   dependencies are only needed if you need to run the API)
 
 ### Attribution

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "color-name-list",
-  "version": "11.24.1",
+  "version": "11.24.2",
   "description": "long list of color names",
   "main": "dist/colornames.json",
   "browser": "dist/colornames.umd.js",
@@ -24,9 +24,10 @@
   "scripts": {
     "commit": "git-cz",
     "pull-colors": "curl -L 'https://docs.google.com/spreadsheets/d/e/2PACX-1vQube6Y0wHyEtJnjg0eU3N7VseoxVnD4L9uDqvWZdl_tzzrHDVN10IPP7cdFipX8j70atNMLfPCB0Q6/pub?gid=40578722&single=true&output=csv' -o src/colornames.csv",
-    "test": "npm run test:precommit && npm run build && vitest run",
+    "test": "npm run test:precommit && vitest run",
     "test:watch": "vitest",
-    "test:precommit": "npm run build --testonly",
+    "test:precommit": "npm run build:test",
+    "build:test": "node scripts/build.js --testonly",
     "build": "node scripts/build.js && npm run prettier",
     "prettier": "prettier --write ./dist/*",
     "lint": "npm run lint:scripts && npm run lint:markdown",

package/scripts/build.js

@@ -4,7 +4,8 @@ import { parseCSVString, findDuplicates, objArrToString } from './lib.js';
 import { exec } from 'child_process';
 
 const args = process.argv;
-const isTestRun = !!args.find((arg) => arg === '--testOnly');
+// treat --testonly / --testOnly the same
+const isTestRun = args.some((arg) => arg.toLowerCase() === '--testonly');
 
 // only hex colors with 6 values
 const hexColorValidation = /^#[0-9a-f]{6}$/;
@@ -88,10 +89,10 @@ colorsSrc.values[bestOfKey].forEach((str) => {
 });
 
 showLog();
-
+// In test mode we still perform the build so tests can import dist artifacts,
+// but we avoid mutating repository files like README.md or generating the SVG.
 if (isTestRun) {
-  console.log('⇪ See test results above ⇪');
-  process.exit();
+  console.log('Test mode: skipping README & SVG generation.');
 }
 
 // creates JS related files
@@ -336,37 +337,41 @@ for (const outputFormat in outputFormats) {
   }
 }
 
-// updates the color count in readme file
-const readme = fs.readFileSync(path.normalize(`${baseFolder}${readmeFileName}`), 'utf8').toString();
-fs.writeFileSync(
-  path.normalize(`${baseFolder}${readmeFileName}`),
-  readme
-    .replace(
-      // update color count in text
-      /__\d+__/g,
-      `__${colorsSrc.entries.length}__`
-    )
-    .replace(
-      // update color count in badge
-      /\d+-colors-orange/,
-      `${colorsSrc.entries.length}-colors-orange`
-    )
-    .replace(
-      // update color count in percentage
-      /__\d+(\.\d+)?%__/,
-      `__${((colorsSrc.entries.length / (256 * 256 * 256)) * 100).toFixed(2)}%__`
-    )
-    .replace(
-      // update file size
-      /\d+(\.\d+)? MB\)__/g,
-      `${(
-        fs.statSync(path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.json`)).size /
-        1024 /
-        1024
-      ).toFixed(2)} MB)__`
-    ),
-  'utf8'
-);
+if (!isTestRun) {
+  // updates the color count in readme file
+  const readme = fs
+    .readFileSync(path.normalize(`${baseFolder}${readmeFileName}`), 'utf8')
+    .toString();
+  fs.writeFileSync(
+    path.normalize(`${baseFolder}${readmeFileName}`),
+    readme
+      .replace(
+        // update color count in text
+        /__\d+__/g,
+        `__${colorsSrc.entries.length}__`
+      )
+      .replace(
+        // update color count in badge
+        /\d+-colors-orange/,
+        `${colorsSrc.entries.length}-colors-orange`
+      )
+      .replace(
+        // update color count in percentage
+        /__\d+(\.\d+)?%__/,
+        `__${((colorsSrc.entries.length / (256 * 256 * 256)) * 100).toFixed(2)}%__`
+      )
+      .replace(
+        // update file size
+        /\d+(\.\d+)? MB\)__/, // no global to only hit first occurrence
+        `${(
+          fs.statSync(path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.json`)).size /
+          1024 /
+          1024
+        ).toFixed(2)} MB)__`
+      ),
+    'utf8'
+  );
+}
 
 /**
  * outputs the collected logs
@@ -479,4 +484,6 @@ function diffSVG() {
   );
 }
 
-diffSVG();
+if (!isTestRun) {
+  diffSVG();
+}

package/scripts/sortSrc.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
 /**
- * Script to sort the colornames.csv file alphabetically by name
- * This helps maintain order when new colors are added to the list
- */
+* Script to sort the colornames.csv file alphabetically by name
+* This helps maintain order when new colors are added to the list
+*/
 
 import fs from 'fs';
 import path from 'path';
@@ -18,11 +18,17 @@ const csvPath = path.join(__dirname, '..', 'src', 'colornames.csv');
 // Read the CSV file
 const readAndSortCSV = () => {
   try {
-    // Read the file
-    const data = fs.readFileSync(csvPath, 'utf8');
+    // Read file & normalise line endings to LF
+    const raw = fs.readFileSync(csvPath, 'utf8').replace(/\r\n?/g, '\n');
 
-    // Split the data into lines
-    const lines = data.trim().split('\n');
+    // Split (keeping possible last empty line which we'll drop below)
+    let lines = raw.split('\n');
+
+    // Drop trailing empty / whitespace-only lines
+    while (lines.length && !lines[lines.length - 1].trim()) lines.pop();
+
+    // Trim trailing whitespace on each line
+    lines = lines.map(l => l.replace(/\s+$/,''));
 
     // The header should be kept as the first line
     const header = lines[0];
@@ -38,10 +44,10 @@ const readAndSortCSV = () => {
       return nameA.localeCompare(nameB);
     });
 
-    // Combine the header and sorted lines
-    const sortedData = [header, ...sortedColorLines].join('\n');
+    // Combine header & sorted lines (no blank line). Ensure exactly one final newline.
+    const sortedData = [header, ...sortedColorLines].join('\n') + '\n';
 
-    // Write the sorted data back to the file
+    // Write back
     fs.writeFileSync(csvPath, sortedData, 'utf8');
 
     console.log(`✅ Successfully sorted ${sortedColorLines.length} colors alphabetically by name`);

package/tests/sorting.test.js

@@ -0,0 +1,45 @@
+import { describe, it, expect } from 'vitest';
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * Ensures that the source CSV file is already sorted alphabetically (case-insensitive)
+ * by the color name. If not, it throws with a helpful message telling how to fix it.
+ */
+describe('Source CSV sorting', () => {
+  it('colornames.csv should be sorted by name (case-insensitive)', () => {
+    const csvPath = path.resolve('./src/colornames.csv');
+    const raw = fs.readFileSync(csvPath, 'utf8').replace(/\r\n/g, '\n').trimEnd();
+    const lines = raw.split('\n');
+    expect(lines.length).toBeGreaterThan(1);
+
+    const header = lines.shift();
+    expect(header.startsWith('name,hex')).toBe(true);
+
+    const entries = lines
+      .filter((l) => l.trim().length)
+      .map((l, idx) => {
+        const [name, hex] = l.split(',');
+        return { originalIndex: idx + 2, line: l, name, lower: name.toLowerCase(), hex };
+      });
+
+    for (let i = 1; i < entries.length; i++) {
+      const prev = entries[i - 1];
+      const curr = entries[i];
+      if (prev.lower.localeCompare(curr.lower) > 0) {
+        throw new Error(
+          [
+            'Source file src/colornames.csv is not sorted alphabetically by name.',
+            `Out of order around lines ${prev.originalIndex} -> ${curr.originalIndex}:`,
+            `  "${prev.name}" should come AFTER "${curr.name}"`,
+            '',
+            'To fix automatically run:',
+            '  npm run sort-colors',
+            '',
+            'Commit the updated src/colornames.csv after sorting.'
+          ].join('\n')
+        );
+      }
+    }
+  });
+});