feat(color-names): add new short export

experimental
meodai · Aug 25, 2024 · 632973c · 632973c
1 parent de0c1b5
commit 632973c
Show file tree

Hide file tree

Showing 12 changed files with 10,051 additions and 1 deletion.
diff --git a/dist/colornames.short.csv b/dist/colornames.short.csv
diff --git a/dist/colornames.short.esm.js b/dist/colornames.short.esm.js
diff --git a/dist/colornames.short.esm.mjs b/dist/colornames.short.esm.mjs
diff --git a/dist/colornames.short.html b/dist/colornames.short.html
diff --git a/dist/colornames.short.json b/dist/colornames.short.json
diff --git a/dist/colornames.short.min.json b/dist/colornames.short.min.json
diff --git a/dist/colornames.short.scss b/dist/colornames.short.scss
diff --git a/dist/colornames.short.umd.js b/dist/colornames.short.umd.js
diff --git a/dist/colornames.short.xml b/dist/colornames.short.xml
diff --git a/dist/colornames.short.yaml b/dist/colornames.short.yaml
diff --git a/dist/history.json b/dist/history.json
diff --git a/scripts/build.js b/scripts/build.js
@@ -26,6 +26,9 @@ const fileNameSrc = 'colornames';
 const fileNameBestOfPostfix = '.bestof';
 const readmeFileName = 'README.md';
 
+const fileNameShortPostfix = '.short';
+const maxShortNameLength = 12;
+
 const sortBy = 'name';
 const csvKeys = ['name', 'hex'];
 const bestOfKey = 'good name';
@@ -118,6 +121,24 @@ const JSONExportStringBestOf = JSON.stringify(
   )
 );
 
+const JSONExportStringShort = JSON.stringify(
+  [...colorsSrc.entires]
+    .filter(
+      // make sure its only one word long
+      (val) =>
+        val[bestOfKey] &&
+        val.name.split(" ").length === 1 &&
+        val.name.length < maxShortNameLength
+    )
+    .map(
+      // removes good name attributes
+      (val) => ({
+        name: val.name,
+        hex: val.hex,
+      })
+    )
+);
+
 fs.writeFileSync(
   path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.json`),
   JSONExportString
@@ -128,6 +149,11 @@ fs.writeFileSync(
   JSONExportStringBestOf
 );
 
+fs.writeFileSync(
+  path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.json`),
+  JSONExportStringShort
+);
+
 // creates a more compact JSON file, where the HEX color serves as an id
 const miniJSONExportObj = colorsSrc.entires.reduce((obj, entry) => {
   obj[entry.hex.replace('#', '')] = entry.name;
@@ -141,6 +167,17 @@ const miniJSONExportObjBestOf = colorsSrc.entires.reduce((obj, entry) => {
   return obj;
 }, {});
 
+const miniJSONExportObjShort = colorsSrc.entires.reduce((obj, entry) => {
+  if (
+    entry[bestOfKey] &&
+    entry.name.split(" ").length === 1 &&
+    entry.name.length < maxShortNameLength
+  ) {
+    obj[entry.hex.replace("#", "")] = entry.name;
+  }
+  return obj;
+}, {});
+
 fs.writeFileSync(
   path.normalize(`${baseFolder}${folderDist}${fileNameSrc}.min.json`),
   JSON.stringify(miniJSONExportObj)
@@ -151,6 +188,11 @@ fs.writeFileSync(
   JSON.stringify(miniJSONExportObjBestOf)
 );
 
+fs.writeFileSync(
+  path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.min.json`),
+  JSON.stringify(miniJSONExportObjShort)
+);
+
 // gets UMD template
 const umdTpl = fs.readFileSync(
     path.normalize(__dirname + '/umd.js.tpl'),
@@ -168,6 +210,11 @@ fs.writeFileSync(
   umdTpl.replace('"{{COLORS}}"', JSONExportStringBestOf)
 );
 
+fs.writeFileSync(
+  path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.umd.js`),
+  umdTpl.replace('"{{COLORS}}"', JSONExportStringShort)
+);
+
 // gets ESM template
 const esmTpl = fs.readFileSync(
     path.normalize(__dirname + '/esm.js.tpl'),
@@ -193,6 +240,15 @@ fs.writeFileSync(
   esmTpl.replace('"{{COLORS}}"', JSONExportStringBestOf)
 );
 
+fs.writeFileSync(
+  path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.esm.js`),
+  esmTpl.replace('"{{COLORS}}"', JSONExportStringShort)
+);
+fs.writeFileSync(
+  path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.esm.mjs`),
+  esmTpl.replace('"{{COLORS}}"', JSONExportStringShort)
+);
+
 // create foreign formats
 // configuration for the file outputs
 const outputFormats = {
@@ -264,6 +320,29 @@ for (const outputFormat in outputFormats) {
   }
 }
 
+// short files
+for (const outputFormat in outputFormats) {
+  if (outputFormats[outputFormat]) {
+    let outputString = objArrToString(
+      colorsSrc.entires.filter(
+        (val) =>
+          val[bestOfKey] &&
+          val.name.split(" ").length === 1 &&
+          val.name.length < maxShortNameLength
+      ),
+      csvKeys,
+      outputFormats[outputFormat]
+    );
+    if (outputFormat === 'html' || outputFormat === 'xml') {
+      outputString = outputString.replace(/&/g, '&amp;');
+    }
+    fs.writeFileSync(
+      path.normalize(`${baseFolder}${folderDist}${fileNameSrc}${fileNameShortPostfix}.${outputFormat}`),
+      outputString
+    );
+  }
+}
+
 // updates the color count in readme file
 const readme = fs.readFileSync(
   path.normalize(`${baseFolder}${readmeFileName}`),