color-name-list 12.1.0 → 13.0.0

package/package.json

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

package/scripts/build.js

@@ -1,22 +1,8 @@
 import fs from 'fs';
 import path from 'path';
-import { parseCSVString, findDuplicates, objArrToString } from './lib.js';
+import { parseCSVString, objArrToString } from './lib.js';
 import { exec } from 'child_process';
 
-const args = process.argv;
-// 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}$/;
-const errors = [];
-
-// spaces regex
-const spacesValidation = /^\s+|\s{2,}|\s$/;
-
-// quote regex
-const quoteValidation = /"|'|`/;
-
 // setting
 const __dirname = path.dirname(new URL(import.meta.url).pathname);
 const baseFolder = __dirname + '/../';
@@ -29,7 +15,6 @@ const readmeFileName = 'README.md';
 const fileNameShortPostfix = '.short';
 const maxShortNameLength = 12;
 
-const sortBy = 'name';
 const csvKeys = ['name', 'hex'];
 const bestOfKey = 'good name';
 
@@ -40,63 +25,6 @@ const src = fs
 
 const colorsSrc = parseCSVString(src);
 
-// sort by sorting criteria
-colorsSrc.entries.sort((a, b) => {
-  return a[sortBy].localeCompare(b[sortBy]);
-});
-
-csvKeys.forEach((key) => {
-  // find duplicates
-  const dupes = findDuplicates(colorsSrc.values[key]);
-  dupes.forEach((dupe) => {
-    log(key, dupe, `found a double ${key}`);
-  });
-});
-
-// loop hex values for validations
-colorsSrc.values['hex'].forEach((hex) => {
-  // validate HEX values
-  if (!hexColorValidation.test(hex)) {
-    log(
-      'hex',
-      hex,
-      `${hex} is not a valid hex value. (Or to short, we avoid using the hex shorthands, no capital letters)`
-    );
-  }
-});
-
-// loop names
-colorsSrc.values['name'].forEach((name) => {
-  // check for spaces
-  if (spacesValidation.test(name)) {
-    log('name', name, `${name} found either a leading or trailing space (or both)`);
-  }
-  if (quoteValidation.test(name)) {
-    log('name', name, `${name} found a quote character, should be an apostrophe ’`);
-  }
-});
-
-// loop good name markers
-colorsSrc.values[bestOfKey].forEach((str) => {
-  // check for spaces
-  if (spacesValidation.test(str)) {
-    // Use the actual CSV key so we can resolve the offending entries (names)
-    log(bestOfKey, str, `${str} found either a leading or trailing space (or both)`);
-  }
-
-  if (!(str == 'x' || str == '')) {
-    // Use the actual CSV key so we can resolve the offending entries (names)
-    log(bestOfKey, str, `${str} must be a lowercase "x" character or empty`);
-  }
-});
-
-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('Test mode: skipping README & SVG generation.');
-}
-
 // creates JS related files
 const JSONExportString = JSON.stringify(
   [...colorsSrc.entries].map(
@@ -339,91 +267,37 @@ for (const outputFormat in outputFormats) {
   }
 }
 
-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
- */
-function showLog() {
-  let errorLevel = 0;
-  let totalErrors = 0;
-  errors.forEach((error, i) => {
-    totalErrors = i + 1;
-    errorLevel = error.errorLevel || errorLevel;
-    console.log(`${error.errorLevel ? '⛔' : '⚠'}  ${error.message}`);
-    if (Array.isArray(error.entries) && error.entries.length) {
-      // Print a concise list of offending names for quick scanning
-      const nameList = error.entries
-        .map((e) => (e && e.name ? `${e.name}${e.hex ? ` (${e.hex})` : ''}` : ''))
-        .filter(Boolean)
-        .join(', ');
-      if (nameList) {
-        console.log(`Offending name(s): ${nameList}`);
-      }
-    }
-    // Keep the JSON dump for full context
-    console.log(JSON.stringify(error.entries));
-    console.log('*-------------------------*');
-  });
-  if (errorLevel) {
-    throw new Error(`⚠ failed because of the ${totalErrors} error${totalErrors > 1 ? 's' : ''} above ⚠`);
-  }
-  return totalErrors;
-}
-
-/**
- * logs errors and warning
- * @param   {string} key        key to look for in input
- * @param   {string} value      value to look for
- * @param   {string} message    error message
- * @param   {Number} errorLevel if any error is set to 1, the program will exit
- */
-function log(key, value, message, errorLevel = 1) {
-  const error = {};
-  // looks for the original item that caused the error
-  error.entries = colorsSrc.entries.filter((entry) => {
-    return entry[key] === value;
-  });
-
-  error.message = message;
-  error.errorLevel = errorLevel;
-
-  errors.push(error);
-}
+// 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'
+);
 
 // gets SVG template
 const svgTpl = fs.readFileSync(path.normalize(__dirname + '/changes.svg.tpl'), 'utf8').toString();
@@ -497,6 +371,4 @@ function diffSVG() {
   );
 }
 
-if (!isTestRun) {
-  diffSVG();
-}
+diffSVG();

package/scripts/lib.js

@@ -131,23 +131,78 @@ export const normalizeNameForDuplicates = (name) => {
  * @returns {Array<{norm:string, entries:Array<{name:string, lineNumber?:number}>}>}
  */
 export const findNearDuplicateNameConflicts = (items, options = {}) => {
-  const { allowlist = [] } = options;
-
-  // Normalize allowlist entries so callers can provide raw names or already-normalized keys.
+  const {
+    allowlist = [],
+    foldPlurals = false,
+    pluralAllowlist = [],
+    foldStopwords = false,
+    stopwords = [],
+  } = options;
+
+  // Precompute stopword set (normalized to lowercase ASCII) when folding is enabled
+  const stopSet = foldStopwords
+    ? new Set(
+        (Array.isArray(stopwords) ? stopwords : [])
+          .filter((w) => typeof w === 'string' && w.trim().length)
+          .map((w) =>
+            String(w)
+              .toLowerCase()
+              .normalize('NFD')
+              .replace(/[\u0300-\u036f]/g, '')
+          )
+      )
+    : null;
+
+  // Helper: normalize name using current options (stopword folding if enabled)
+  const normalizeForOptions = (name) => {
+    const base = String(name)
+      .toLowerCase()
+      .normalize('NFD')
+      .replace(/[\u0300-\u036f]/g, '');
+    const tokens = base.match(/[a-z0-9]+/g) || [];
+    const filtered = foldStopwords && stopSet && stopSet.size ? tokens.filter((t) => !stopSet.has(t)) : tokens;
+    return filtered.length ? filtered.join('') : normalizeNameForDuplicates(name);
+  };
+
+  // Normalize allowlist entries using the same normalization function.
   const allowSet = new Set(
     (Array.isArray(allowlist) ? allowlist : [])
       .filter((v) => typeof v === 'string' && v.trim().length)
-      .map((v) => normalizeNameForDuplicates(String(v)))
+      .map((v) => normalizeForOptions(String(v)))
   );
 
   const byNorm = new Map();
   for (const item of items) {
     if (!item || typeof item.name !== 'string') continue;
-    const norm = normalizeNameForDuplicates(item.name);
+    const norm = normalizeForOptions(item.name);
     if (!byNorm.has(norm)) byNorm.set(norm, []);
     byNorm.get(norm).push({ name: item.name, lineNumber: item.lineNumber });
   }
 
+  // Optional plural folding: merge keys ending in 's' with their singular if present.
+  if (foldPlurals) {
+    const pluralAllowSet = new Set(
+      (Array.isArray(pluralAllowlist) ? pluralAllowlist : [])
+        .filter((v) => typeof v === 'string' && v.trim().length)
+        // Use the same normalization as used for keys (respects stopword folding)
+        .map((v) => normalizeForOptions(String(v)))
+    );
+    // We iterate over a snapshot of keys because we'll mutate the map.
+    for (const key of Array.from(byNorm.keys())) {
+      if (key.length < 4) continue; // avoid over-aggressive folding for tiny words
+      if (!key.endsWith('s')) continue;
+      if (key.endsWith('ss')) continue; // glass vs glas, moss vs mos, keep
+      if (pluralAllowSet.has(key)) continue; // explicit allow: don't fold
+      const singular = key.slice(0, -1);
+      if (byNorm.has(singular)) {
+        // merge arrays
+        const merged = [...byNorm.get(singular), ...byNorm.get(key)];
+        byNorm.set(singular, merged);
+        byNorm.delete(key);
+      }
+    }
+  }
+
   const conflicts = [];
   for (const [norm, arr] of byNorm.entries()) {
     if (allowSet.has(norm)) continue; // explicitly allowed

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';
@@ -28,7 +28,7 @@ const readAndSortCSV = () => {
     while (lines.length && !lines[lines.length - 1].trim()) lines.pop();
 
     // Trim trailing whitespace on each line
-    lines = lines.map(l => l.replace(/\s+$/,''));
+    lines = lines.map((l) => l.replace(/\s+$/, ''));
 
     // The header should be kept as the first line
     const header = lines[0];
@@ -52,7 +52,6 @@ const readAndSortCSV = () => {
 
     console.log(`✅ Successfully sorted ${sortedColorLines.length} colors alphabetically by name`);
     console.log(`📝 File saved: ${csvPath}`);
-
   } catch (error) {
     console.error('❌ Error sorting the CSV file:', error);
     process.exit(1);