color-name-list 11.9.1 → 11.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "color-name-list",
-  "version": "11.9.1",
+  "version": "11.10.0",
   "description": "long list of color names",
   "main": "dist/colornames.json",
   "browser": "dist/colornames.umd.js",
@@ -24,13 +24,14 @@
   "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": "node scripts/build.js --testOnly",
-    "clean-dist-folder": "rm -rf dist && mkdir dist",
-    "build": "npm run clean-dist-folder && node scripts/build.js && npm run build-history && npm run prettier",
+    "test": "npm run build --testonly && npm run build && vitest run",
+    "test:watch": "vitest",
+    "build": "node scripts/build.js && npm run prettier",
     "prettier": "prettier --write ./dist/*",
     "lint": "eslint ./scripts",
     "semantic-release": "semantic-release",
     "build-history": "node scripts/tools/history.js > dist/history.json",
+    "history": "node scripts/tools/history.js > dist/history.json",
     "prepare": "husky"
   },
   "repository": {
@@ -65,7 +66,8 @@
     "husky": "^9.1.6",
     "prettier": "^3.5.3",
     "seedrandom": "^3.0.5",
-    "semantic-release": "^24.2.0"
+    "semantic-release": "^24.2.0",
+    "vitest": "^3.1.2"
   },
   "engines": {
     "node": ">=20.11.0",

package/scripts/build.js

@@ -135,6 +135,12 @@ const JSONExportStringShort = JSON.stringify(
     )
 );
 
+// make sure dist folder exists
+const distFolder = path.normalize(`${baseFolder}${folderDist}`);
+if (!fs.existsSync(distFolder)) {
+  fs.mkdirSync(distFolder);
+}
+
 fs.writeFileSync(path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.json`), JSONExportString);
 
 fs.writeFileSync(

package/scripts/tools/history.js

@@ -19,7 +19,7 @@ async function main() {
 
   for (const commit of allCommits) {
     // Figure out what changed in that particular commit
-    const diff = cmd(`git show --ignore-cr-at-eol ${commit} -- ./src/colornames.csv`)
+    const diff = cmd(`git show -w --ignore-cr-at-eol ${commit} -- ./src/colornames.csv`)
       .split('\n')
       .filter(Boolean);
 
@@ -30,6 +30,11 @@ async function main() {
     const modified = {};
 
     for (const line of diff) {
+      // Ignore the header row
+      if (line.match(/^(\+|-)?name,hex/)) {
+        continue;
+      }
+
       const res = line.match(/^((?<op>(\+|-)))(?<name>[^,]+),(?<hex>[^,]+)/);
       if (!res) {
         continue;

package/src/colornames.csv

@@ -30288,4 +30288,5 @@ Zumthor,#cdd5d5,
 Zunda Green,#6bc026,x
 Zuni,#008996,
 Zürich Blue,#248bcc,
-Zürich White,#e6e1d9,
+Zürich White,#e6e1d9,
+Pinkish White,#fff1fa,

package/tests/formats.test.js

@@ -0,0 +1,46 @@
+import { describe, it, expect } from 'vitest';
+import fs from 'fs';
+import path from 'path';
+import { parseCSVString } from '../scripts/lib.js';
+
+describe('Other Format Tests', () => {
+  // Load CSV data for comparison
+  const csvSource = fs.readFileSync(path.resolve('./src/colornames.csv'), 'utf8').toString();
+  const csvData = parseCSVString(csvSource);
+  const csvColors = csvData.entries.map(entry => ({
+    name: entry.name,
+    hex: entry.hex
+  }));
+
+  describe('CSV Output', () => {
+    it('should correctly generate CSV files', () => {
+      const mainCsv = fs.readFileSync(path.resolve('./dist/colornames.csv'), 'utf8');
+      const bestofCsv = fs.readFileSync(path.resolve('./dist/colornames.bestof.csv'), 'utf8');
+      const shortCsv = fs.readFileSync(path.resolve('./dist/colornames.short.csv'), 'utf8');
+
+      // Check that the files are not empty
+      expect(mainCsv.length).toBeGreaterThan(0);
+      expect(bestofCsv.length).toBeGreaterThan(0);
+      expect(shortCsv.length).toBeGreaterThan(0);
+
+      // Verify headers
+      expect(mainCsv).toMatch(/^name,hex/);
+      expect(bestofCsv).toMatch(/^name,hex/);
+      expect(shortCsv).toMatch(/^name,hex/);
+
+      // Parse the CSV files
+      const mainData = parseCSVString(mainCsv);
+      const bestofData = parseCSVString(bestofCsv);
+      const shortData = parseCSVString(shortCsv);
+
+      // Verify data integrity
+      expect(mainData.entries.length).toBe(csvColors.length);
+      expect(bestofData.entries.length).toBeLessThan(csvColors.length);
+      expect(shortData.entries.length).toBeLessThan(bestofData.entries.length);
+
+      // Verify structure
+      expect(mainData.entries[0]).toHaveProperty('name');
+      expect(mainData.entries[0]).toHaveProperty('hex');
+    });
+  });
+});

package/tests/imports.test.js

@@ -0,0 +1,119 @@
+import { describe, it, expect } from 'vitest';
+
+import * as esmColors from '../dist/colornames.esm.js';
+import * as esmBestOfColors from '../dist/colornames.bestof.esm.js';
+import * as esmShortColors from '../dist/colornames.short.esm.js';
+
+// Import JSON files directly
+import jsonColors from '../dist/colornames.json' assert { type: 'json' };
+import jsonBestOfColors from '../dist/colornames.bestof.json' assert { type: 'json' };
+import jsonShortColors from '../dist/colornames.short.json' assert { type: 'json' };
+
+// Import minified JSON files
+import jsonMinColors from '../dist/colornames.min.json' assert { type: 'json' };
+import jsonMinBestOfColors from '../dist/colornames.bestof.min.json' assert { type: 'json' };
+import jsonMinShortColors from '../dist/colornames.short.min.json' assert { type: 'json' };
+
+// Also import the source CSV file for verification
+import fs from 'fs';
+import path from 'path';
+import { parseCSVString } from '../scripts/lib.js';
+
+describe('Color Names Import Tests', () => {
+  // Load CSV data for comparison
+  const csvSource = fs.readFileSync(path.resolve('./src/colornames.csv'), 'utf8').toString();
+  const csvData = parseCSVString(csvSource);
+  const csvColors = csvData.entries.map(entry => ({
+    name: entry.name,
+    hex: entry.hex
+  }));
+
+  describe('JSON Files', () => {
+    it('should import main JSON file correctly', () => {
+      expect(jsonColors).toBeDefined();
+      expect(Array.isArray(jsonColors)).toBe(true);
+      expect(jsonColors.length).toBeGreaterThan(0);
+      expect(jsonColors[0]).toHaveProperty('name');
+      expect(jsonColors[0]).toHaveProperty('hex');
+      expect(jsonColors.length).toBe(csvColors.length);
+    });
+
+    it('should import bestof JSON file correctly', () => {
+      expect(jsonBestOfColors).toBeDefined();
+      expect(Array.isArray(jsonBestOfColors)).toBe(true);
+      expect(jsonBestOfColors.length).toBeGreaterThan(0);
+      expect(jsonBestOfColors[0]).toHaveProperty('name');
+      expect(jsonBestOfColors[0]).toHaveProperty('hex');
+      expect(jsonBestOfColors.length).toBeLessThan(csvColors.length);
+    });
+
+    it('should import short JSON file correctly', () => {
+      expect(jsonShortColors).toBeDefined();
+      expect(Array.isArray(jsonShortColors)).toBe(true);
+      expect(jsonShortColors.length).toBeGreaterThan(0);
+      expect(jsonShortColors[0]).toHaveProperty('name');
+      expect(jsonShortColors[0]).toHaveProperty('hex');
+      expect(jsonShortColors.length).toBeLessThan(csvColors.length);
+    });
+
+    it('should import minified JSON files correctly', () => {
+      expect(jsonMinColors).toBeDefined();
+      expect(typeof jsonMinColors).toBe('object');
+      expect(Object.keys(jsonMinColors).length).toBeGreaterThan(0);
+      expect(Object.values(jsonMinColors).length).toBe(csvColors.length);
+
+      expect(jsonMinBestOfColors).toBeDefined();
+      expect(typeof jsonMinBestOfColors).toBe('object');
+      expect(Object.keys(jsonMinBestOfColors).length).toBeGreaterThan(0);
+
+      expect(jsonMinShortColors).toBeDefined();
+      expect(typeof jsonMinShortColors).toBe('object');
+      expect(Object.keys(jsonMinShortColors).length).toBeGreaterThan(0);
+    });
+  });
+
+  describe('ESM Files', () => {
+    it('should import main ESM file correctly', () => {
+      expect(esmColors).toBeDefined();
+      expect(esmColors.colornames).toBeDefined();
+      expect(Array.isArray(esmColors.colornames)).toBe(true);
+      expect(esmColors.colornames.length).toBeGreaterThan(0);
+      expect(esmColors.colornames[0]).toHaveProperty('name');
+      expect(esmColors.colornames[0]).toHaveProperty('hex');
+      expect(esmColors.colornames.length).toBe(csvColors.length);
+    });
+
+    it('should import bestof ESM file correctly', () => {
+      expect(esmBestOfColors).toBeDefined();
+      expect(esmBestOfColors.colornames).toBeDefined();
+      expect(Array.isArray(esmBestOfColors.colornames)).toBe(true);
+      expect(esmBestOfColors.colornames.length).toBeGreaterThan(0);
+      expect(esmBestOfColors.colornames[0]).toHaveProperty('name');
+      expect(esmBestOfColors.colornames[0]).toHaveProperty('hex');
+    });
+
+    it('should import short ESM file correctly', () => {
+      expect(esmShortColors).toBeDefined();
+      expect(esmShortColors.colornames).toBeDefined();
+      expect(Array.isArray(esmShortColors.colornames)).toBe(true);
+      expect(esmShortColors.colornames.length).toBeGreaterThan(0);
+      expect(esmShortColors.colornames[0]).toHaveProperty('name');
+      expect(esmShortColors.colornames[0]).toHaveProperty('hex');
+    });
+  });
+
+  describe('Content Verification', () => {
+    it('should contain expected color names', () => {
+      // Check for some common color names
+      const commonColors = ['black', 'white', 'red', 'blue', 'green', 'yellow', 'purple', 'pink'];
+
+      // Convert to lowercase for easier comparison
+      const allNames = jsonColors.map(color => color.name.toLowerCase());
+
+      commonColors.forEach(color => {
+        // Check if at least one entry contains this common color name
+        expect(allNames.some(name => name.includes(color))).toBe(true);
+      });
+    });
+  });
+});

package/vitest.config.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    include: ['tests/**/*.test.js'],
+    environment: 'node',
+  },
+});

package/.github/workflows/release.yml

@@ -1,26 +0,0 @@
-name: Semantic Release
-
-on:
-  push:
-    branches: [main]
-
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v1
-      - name: Setup Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 20
-      - name: Install dependencies
-        run: npm ci
-      - name: Test
-        run: npm test
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release