feat: add Nimiq icons package with initial structure and metadata

Author: onmax

packages/nimiq-icons/.gitignore

@@ -0,0 +1 @@
+.figma-cache/

packages/nimiq-icons/package.json

@@ -1,7 +1,8 @@
 {
   "name": "nimiq-icons-builder",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.0-beta.5",
+  "private": true,
   "packageManager": "pnpm@10.4.1",
   "description": "",
   "exports": {
@@ -20,6 +21,7 @@
   },
   "devDependencies": {
     "@types/jsdom": "^21.1.7",
+    "pathe": "catalog:",
     "dotenv": "^16.4.7",
     "esno": "^4.8.0"
   }

packages/nimiq-icons/scripts/client.ts

@@ -2,6 +2,9 @@ import type { IconSet } from '@iconify/tools'
 import { env, exit } from 'node:process'
 import { exportJSONPackage, importFromFigma } from '@iconify/tools'
 import { IconVariant } from './consts'
+import { version } from '../package.json'
+import { resolve, dirname } from 'pathe'
+import { existsSync, writeFile } from 'node:fs'
 
 export const sanitizeName = (name: string) => name.toLocaleLowerCase().trim().replace(/ /g, '-')
 
@@ -49,46 +52,71 @@ export async function checkFigmaVariants() {
 
 export async function getFigma(frameName: string) {
   const { file, token } = getFigmaSecrets()
-  const figma = await importFromFigma({
-    file,
-    pages: ['Main'],
-    token,
-    prefix: 'nimiq',
-    depth: 3,
-    ifModifiedSince: '2021-01-01T00:00:00Z',
-    simplifyStroke: true,
-    iconNameForNode: (node) => {
-      if (
-        // Icons are stored after 2 parents: page -> container frame -> icon
-        node.parents.length !== 2
-        // Icons use frames
-        || node.type !== 'FRAME'
-        // !node.parents.find(parent => parent.name === frameName)
-        // It is direct child of the frameName
-        || sanitizeName(node.parents.at(-1)?.name || '') !== frameName
-      ) {
-        return null
-      }
-      return sanitizeName(node.name)
-    },
-  })
+  try {
+    const figma = await importFromFigma({
+      file,
+      pages: ['Main'],
+      token,
+      cacheDir: resolve(dirname('..'), '.figma-cache'),
+      prefix: 'nimiq',
+      depth: 3,
+      ifModifiedSince: true,
+      simplifyStroke: true,
+      iconNameForNode: (node) => {
+        if (
+          node.parents.length !== 2
+          || node.type !== 'FRAME'
+          || sanitizeName(node.parents.at(-1)?.name || '') !== frameName
+        ) {
+          return null
+        }
+        return sanitizeName(node.name)
+      },
+    })
 
-  if (figma === 'not_modified') {
-    console.log('Figma file has not been modified since last import.')
+    if (figma === 'not_modified' && existsSync(resolve('../src'))) {
+      console.log('Figma file has not been modified since last build.')
+      exit(0)
+    }
+
+    return figma
+  } catch (error) {
+    console.error('Error fetching from Figma:', error)
     exit(1)
   }
-
-  return figma
 }
 
 export async function prepareNpmPackage(iconSet: IconSet) {
   await exportJSONPackage(iconSet, {
-    target: 'dist',
+    target: 'src',
     package: {
       name: 'nimiq-icons',
-      version: '0.0.1',
-      description: 'Nimiq icons',
+      version,
+      description: 'The Nimiq Icons as a iconify icon set.',
+      homepage: "https://github.com/onmax/nimiq-ui#readme",
+      repository: {
+        type: "git",
+        url: "git+https://github.com/onmax/nimiq-ui.git"
+      },
+      bugs: "https://github.com/onmax/nimiq-ui/issues",
+      keywords: [
+        "nimiq",
+        "nimiq-ui",
+        "nimiq-icons",
+        "vitepress-theme"
+      ],
       license: 'MIT',
     },
   })
+  const content = `# auto-generated folder
+This folder is auto-generated by the nimiq-icons package.
+Do not modify it directly.
+If you want to make changes, please refer to the Figma file.
+`
+  writeFile(resolve('../src/README.md'), content, (err) => {
+    if (err) {
+      console.error('Error writing README.md:', err)
+      exit(1)
+    }
+  })
 }

packages/nimiq-icons/scripts/index.ts

@@ -11,13 +11,22 @@ const iconsSets: IconSet[] = []
 
 for (const variant of Object.values(IconVariant)) {
   const figma = await getFigma(variant)
+  if (figma === 'not_modified') 
+    continue 
+    
   const variantName = sanitizeName(variant)
+
   console.log(`Icons: ${figma.iconSet.list().join(', ')}`)
   const iconSet = optimizeIconSet(figma.iconSet, variantName as IconVariant)
   iconsSets.push(iconSet)
   console.log(`Generated icon set for ${variantName}: ${iconSet.list().join(', ')}`)
 }
 
+if (iconsSets.length === 0) {
+  console.log('No new icons found.')
+  process.exit(0)
+}
+
 const combinedIconSet = iconsSets.reduce((prev, curr) => mergeIconSets(prev, curr))
 
 console.log('Preparing npm package...')