@iconify/json 2.0.0-beta.2 → 2.0.1

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@iconify/json",
 	"description": "Iconify icons collection in JSON format",
 	"license": "MIT",
-	"version": "2.0.0-beta.2",
+	"version": "2.0.1",
 	"publishConfig": {
 		"tag": "next"
 	},
@@ -13,6 +13,7 @@
 		"url": "git+ssh://git@github.com/iconify/collections-json.git"
 	},
 	"exports": {
+		"./*": "./*",
 		".": {
 			"require": "./dist/index.js",
 			"import": "./dist/index.mjs"
@@ -24,7 +25,7 @@
 		"lib",
 		"collections.json",
 		"collections.md",
-		"composer.md",
+		"composer.json",
 		"readme.md"
 	],
 	"main": "dist/index.js",
@@ -37,7 +38,8 @@
 		"test-locate-esm": "jest --clearCache && cross-env NODE_OPTIONS=--experimental-vm-modules npx jest --config=jest.esm.config.ts src/locate.esm.test.ts -i",
 		"test-locate-cjs": "npm run build && jest --clearCache && jest --config=jest.cjs.config.ts src/locate.cjs.test.ts -i",
 		"test": "npm run test-esm && npm run test-cjs && npm run test-locate-esm && npm run test-locate-cjs",
-		"prepublishOnly": "npm run build"
+		"version": "node sync-version",
+		"prepublishOnly": "npm run build && npm run version"
 	},
 	"dependencies": {
 		"@iconify/types": "^1.0.9",
@@ -57,4 +59,4 @@
 		"tsup": "^4.14.0",
 		"typescript": "^4.4.3"
 	}
-}
+}

package/readme.md

@@ -152,10 +152,79 @@ For PHP use [Iconify JSON Tools](https://docs.iconify.design/tools/json/).
 
 For JavaScript use [Iconify Utils](https://docs.iconify.design/tools/utils/), though Iconify JSON Tools are also available (but deprecated).
 
-Example using Iconify Utils:
+Example using Iconify Utils (TypeScript):
 
-```js
+```ts
+import { promises as fs } from 'fs';
+
+// Function to locate JSON file
+import { locate } from '@iconify/json';
+
+// Various functions from Iconify Utils
+import { parseIconSet } from '@iconify/utils/lib/icon-set/parse';
+import { iconToSVG } from '@iconify/utils/lib/svg/build';
+import { defaults } from '@iconify/utils/lib/customisations';
+
+(async () => {
+  // Locate icons
+  const filename = locate('mdi');
+
+  // Load icon set
+  const icons = JSON.parse(await fs.readFile(filename, 'utf8'));
+
+  // Parse all icons
+  const exportedSVG: Record<string, string> = Object.create(null);
+  parseIconSet(icons, (iconName, iconData) => {
+    if (!iconData) {
+      // Invalid icon
+      console.error(`Error parsing icon ${iconName}`);
+      return;
+    }
+
+    // Render icon
+    const renderData = iconToSVG(iconData, {
+      ...defaults,
+      height: 'auto',
+    });
+
+    // Generate attributes for SVG element
+    const svgAttributes: Record<string, string> = {
+      'xmlns': 'http://www.w3.org/2000/svg',
+      'xmlns:xlink': 'http://www.w3.org/1999/xlink',
+      ...renderData.attributes,
+    };
+    const svgAttributesStr = Object.keys(svgAttributes)
+      .map(
+        (attr) =>
+          // No need to check attributes for special characters, such as quotes,
+          // they cannot contain anything that needs escaping.
+          `${attr}="${svgAttributes[attr as keyof typeof svgAttributes]}"`
+      )
+      .join(' ');
+
+    // Generate SVG
+    const svg = `<svg ${svgAttributesStr}>${renderData.body}</svg>`;
+    exportedSVG[iconName] = svg;
+  });
+
+  // Output directory
+  const outputDir = 'mdi-export';
+  try {
+    await fs.mkdir(outputDir, {
+      recursive: true,
+    });
+  } catch (err) {
+    //
+  }
 
+  // Save all files
+  const filenames = Object.keys(exportedSVG);
+  for (let i = 0; i < filenames.length; i++) {
+    const filename = filenames[i];
+    const svg = exportedSVG[filename];
+    await fs.writeFile(outputDir + '/' + filename + '.svg', svg, 'utf8');
+  }
+})();
 ```
 
 Example using Iconify JSON Tools:
@@ -164,12 +233,21 @@ Example using Iconify JSON Tools:
 const fs = require('fs');
 const { SVG, Collection } = require('@iconify/json-tools');
 
-let collection = new Collection();
+const outputDir = 'mdi-export';
+try {
+  fs.mkdirSync(outputDir, {
+    recursive: true,
+  });
+} catch (err) {
+  //
+}
+
+const collection = new Collection();
 collection.loadIconifyCollection('mdi');
 collection.listIcons(true).forEach((icon) => {
   let svg = new SVG(collection.getIconData(icon));
   fs.writeFileSync(
-    'mdi-' + icon + '.svg',
+    outputDir + '/' + icon + '.svg',
     svg.getSVG({
       height: 'auto',
     })
@@ -181,11 +259,14 @@ collection.listIcons(true).forEach((icon) => {
 use \Iconify\JSONTools\Collection;
 use \Iconify\JSONTools\SVG;
 
+$outputDir = 'mdi-export';
+@mkdir($outputDir, 0777, true);
+
 $collection = new Collection();
 $collection->loadIconifyCollection('mdi');
 foreach ($collection->listIcons(true) as $icon) {
     $svg = new SVG($collection->getIconData($icon));
-    file_put_contents('mdi-' . $icon . '.svg', $svg->getSVG([
+    file_put_contents($outputDir . '/' . $icon . '.svg', $svg->getSVG([
         'height'    => 'auto'
     ]));
 }