@fastkit/icon-font-gen 0.10.0 → 0.10.1

package/dist/icon-font-gen.d.ts

@@ -5,7 +5,7 @@ import type webfont from 'webfont';
 
 export declare function ceateIconFontConfig(options: IconFontConfig): IconFontConfig;
 
-export declare function cli(): void;
+export declare function cli(): Promise<void>;
 
 export declare const DEFAULT_CONFIG_FILENAME = "icon-font.config";
 

package/dist/{icon-font-gen.cjs.js → icon-font-gen.mjs}

@@ -1,12 +1,10 @@
-'use strict';
-
-var path = require('path');
-var nodeUtil = require('@fastkit/node-util');
-var fs = require('fs-extra');
-var chokidar = require('chokidar');
-var ev = require('@fastkit/ev');
-var tinyLogger = require('@fastkit/tiny-logger');
-var cac = require('cac');
+import path from 'path';
+import { installPackage, HashComparator, findPackageDir, esbuildRequire } from '@fastkit/node-util';
+import fs from 'fs-extra';
+import chokidar from 'chokidar';
+import { EV } from '@fastkit/ev';
+import { TinyLogger, createTinyError } from '@fastkit/tiny-logger';
+import { cac } from 'cac';
 
 const ICON_FONT_FORMATS = [
     'eot',
@@ -53,7 +51,7 @@ async function resolveRawIconFontEntry(rootDir, rawEntry) {
     };
 }
 function findOrInstallMDI() {
-    return nodeUtil.installPackage('@mdi/svg', { dev: true });
+    return installPackage('@mdi/svg', { dev: true });
 }
 const DEFAULT_CONFIG_FILENAME = 'icon-font.config';
 const DEFAULT_DEST_DIRNAME = '.icon-font';
@@ -62,8 +60,8 @@ function ceateIconFontConfig(options) {
 }
 
 const name = 'icon-font-gen';
-const logger = new tinyLogger.TinyLogger(name);
-const IconFontGenError = tinyLogger.createTinyError(name);
+const logger = new TinyLogger(name);
+const IconFontGenError = createTinyError(name);
 
 const DEFAULT_OPTIONS = {
     formats: ['woff2'],
@@ -115,7 +113,7 @@ async function generateEntry(entry) {
     // @TODO support empty prefix
     // const namePrefix = options.name;
     const cssPrefix = `icon-${options.prefix}`;
-    const hash = new nodeUtil.HashComparator(options.src, options.dest);
+    const hash = new HashComparator(options.src, options.dest);
     const srcHash = await hash.hasChanged();
     if (!srcHash) {
         logger.info(`Has not chaged files. Skip process. >>> ${options.src}`);
@@ -242,7 +240,7 @@ async function generate(opts) {
     const entries = results.map(({ entry }) => entry);
     await generateIndex(opts.dest, entries);
 }
-class IconFontRunnerItem extends ev.EV {
+class IconFontRunnerItem extends EV {
     entry;
     ctx;
     _resolveEntryPromise;
@@ -290,7 +288,7 @@ class IconFontRunnerItem extends ev.EV {
         }
     }
 }
-class IconFontRunner extends ev.EV {
+class IconFontRunner extends EV {
     items = [];
     dest;
     // private _opts: IconFontOptions;
@@ -329,9 +327,8 @@ class IconFontRunner extends ev.EV {
     }
 }
 
-const { version } = require('../package.json');
-function cli() {
-    const cli = cac.cac('icon-font');
+async function cli() {
+    const cli = cac('icon-font');
     cli
         .option('-d, --dest <string>', 'Destination for generated fonts.', {
         default: path.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
@@ -349,14 +346,14 @@ Path of the configuration file. (default: [your package directory]${path.sep}${D
       `.trim())
         .action(async (configPath, options) => {
         if (!configPath) {
-            const pkgDir = await nodeUtil.findPackageDir();
+            const pkgDir = await findPackageDir();
             if (!pkgDir) {
                 throw new IconFontGenError('missing package directory.');
             }
             configPath = path.join(pkgDir, DEFAULT_CONFIG_FILENAME);
         }
         const dest = path.resolve(options.dest);
-        const mod = await nodeUtil.esbuildRequire(configPath);
+        const mod = await esbuildRequire(configPath);
         const config = mod.exports.default;
         await generate({
             ...config,
@@ -364,21 +361,8 @@ Path of the configuration file. (default: [your package directory]${path.sep}${D
         });
     });
     cli.help();
-    cli.version(version);
+    cli.version("0.10.1");
     cli.parse();
 }
 
-exports.DEFAULT_CONFIG_FILENAME = DEFAULT_CONFIG_FILENAME;
-exports.DEFAULT_DEST_DIRNAME = DEFAULT_DEST_DIRNAME;
-exports.DEFAULT_OPTIONS = DEFAULT_OPTIONS;
-exports.ICON_FONT_FORMATS = ICON_FONT_FORMATS;
-exports.ICON_FONT_FORMAT_MAP = ICON_FONT_FORMAT_MAP;
-exports.IconFontRunner = IconFontRunner;
-exports.IconFontRunnerItem = IconFontRunnerItem;
-exports.ceateIconFontConfig = ceateIconFontConfig;
-exports.cli = cli;
-exports.generate = generate;
-exports.generateEntry = generateEntry;
-exports.generateIndex = generateIndex;
-exports.mergeDefaults = mergeDefaults;
-exports.resolveRawIconFontEntry = resolveRawIconFontEntry;
+export { DEFAULT_CONFIG_FILENAME, DEFAULT_DEST_DIRNAME, DEFAULT_OPTIONS, ICON_FONT_FORMATS, ICON_FONT_FORMAT_MAP, IconFontRunner, IconFontRunnerItem, ceateIconFontConfig, cli, generate, generateEntry, generateIndex, mergeDefaults, resolveRawIconFontEntry };

package/lib/cli.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { cli } from '@fastkit/icon-font-gen';
+
+cli();

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@fastkit/icon-font-gen",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "A tool to generate icon web fonts and their definitions Type-safe for your application.",
   "buildOptions": {
-    "name": "IconFont",
-    "formats": [
-      "cjs"
-    ]
+    "name": "IconFont"
   },
   "_docs": {
     "scope": "",
@@ -16,13 +13,14 @@
       "ja": "アプリケーションのためにアイコンWebフォントとその定義をTypeセーフに生成するツール。"
     }
   },
-  "main": "index.js",
   "bin": {
-    "icon-font": "lib/cli.js"
+    "icon-font": "lib/cli.mjs"
+  },
+  "main": "./dist/icon-font-gen.mjs",
+  "exports": {
+    ".": "./dist/icon-font-gen.mjs"
   },
-  "module": "dist/icon-font-gen.mjs",
   "files": [
-    "index.js",
     "lib",
     "dist"
   ],
@@ -42,10 +40,10 @@
   },
   "homepage": "https://github.com/dadajam4/fastkit/tree/main/packages/icon-font-gen#readme",
   "dependencies": {
-    "@fastkit/ev": "0.10.0",
-    "@fastkit/icon-font": "0.10.0",
-    "@fastkit/node-util": "0.10.0",
-    "@fastkit/tiny-logger": "0.10.0",
+    "@fastkit/ev": "0.10.1",
+    "@fastkit/icon-font": "0.10.1",
+    "@fastkit/node-util": "0.10.1",
+    "@fastkit/tiny-logger": "0.10.1",
     "cac": "^6.7.11",
     "chokidar": "^3.5.0",
     "fs-extra": "^11.1.0",

package/dist/icon-font-gen.cjs.prod.js

@@ -1,384 +0,0 @@
-'use strict';
-
-var path = require('path');
-var nodeUtil = require('@fastkit/node-util');
-var fs = require('fs-extra');
-var chokidar = require('chokidar');
-var ev = require('@fastkit/ev');
-var tinyLogger = require('@fastkit/tiny-logger');
-var cac = require('cac');
-
-const ICON_FONT_FORMATS = [
-    'eot',
-    'woff',
-    'woff2',
-    'svg',
-    'ttf',
-];
-const ICON_FONT_FORMAT_MAP = {
-    eot: 'embedded-opentype',
-    woff2: 'woff2',
-    woff: 'woff',
-    ttf: 'truetype',
-    svg: 'svg',
-};
-async function resolveRawIconFontEntry(rootDir, rawEntry) {
-    const entry = {
-        ...rawEntry,
-    };
-    // mdi support
-    if (entry.src === '@mdi') {
-        const installedDir = await findOrInstallMDI();
-        entry.src = path.join(installedDir, 'svg');
-        if (entry.fontHeight == null) {
-            entry.fontHeight = 512;
-        }
-        if (entry.descent == null) {
-            entry.descent = 64;
-        }
-        if (entry.name == null) {
-            entry.name = 'mdi';
-        }
-    }
-    const name = entry.name || path.basename(entry.src);
-    const fontName = entry.fontName || `${name}-icon`;
-    const dest = path.join(rootDir, name);
-    const prefix = entry.disablePrefix ? '' : `${name}-`;
-    return {
-        ...entry,
-        name,
-        fontName,
-        prefix,
-        dest,
-    };
-}
-function findOrInstallMDI() {
-    return nodeUtil.installPackage('@mdi/svg', { dev: true });
-}
-const DEFAULT_CONFIG_FILENAME = 'icon-font.config';
-const DEFAULT_DEST_DIRNAME = '.icon-font';
-function ceateIconFontConfig(options) {
-    return options;
-}
-
-const name = 'icon-font-gen';
-const logger = new tinyLogger.TinyLogger(name);
-const IconFontGenError = tinyLogger.createTinyError(name);
-
-const DEFAULT_OPTIONS = {
-    formats: ['woff2'],
-    fixedWidth: true,
-    normalize: true,
-};
-const BANNER = `
-/**
- * This is auto generated file.
- * Do not edit !!!
- *
- * @see: https://github.com/dadajam4/fastkit/tree/main/packages/icon-font-gen
- */
-`.trim();
-function mergeDefaults(entry) {
-    return {
-        ...DEFAULT_OPTIONS,
-        ...entry,
-    };
-}
-async function generateTS(entry, ids) {
-    const code = `
-/* eslint-disable */
-// @ts-nocheck
-${BANNER}
-import type { IconName, IconNameMap } from '@fastkit/icon-font';
-import { registerIconNames } from '@fastkit/icon-font';
-declare module "@fastkit/icon-font" {
-  export interface IconNameMap {
-${ids.map((id) => `    '${id}': true,`).join('\n')}
-  }
-}
-export const ICON_NAMES = registerIconNames([
-  ${ids.map((id) => `'${id}'`).join(',\n  ')}
-]);
-export type { IconName, IconNameMap } from '@fastkit/icon-font';
-  `.trim();
-    const fileName = `${entry.name || 'icons'}.ts`;
-    const dest = path.resolve(entry.dest, fileName);
-    await fs.writeFile(dest, code);
-    return {
-        fileName,
-        dest,
-        code,
-    };
-}
-async function generateEntry(entry) {
-    const options = mergeDefaults(entry);
-    // @TODO support empty prefix
-    // const namePrefix = options.name;
-    const cssPrefix = `icon-${options.prefix}`;
-    const hash = new nodeUtil.HashComparator(options.src, options.dest);
-    const srcHash = await hash.hasChanged();
-    if (!srcHash) {
-        logger.info(`Has not chaged files. Skip process. >>> ${options.src}`);
-        return { entry };
-    }
-    await fs.ensureDir(options.dest);
-    const { webfont } = await import('webfont');
-    // const { startUnicode = 0xea01 } = options;
-    const { startUnicode = 0xba01 } = options;
-    let i = startUnicode;
-    const result = await webfont({
-        files: options.src,
-        fontName: options.fontName,
-        formats: options.formats,
-        fixedWidth: options.fixedWidth,
-        centerHorizontally: options.centerHorizontally,
-        normalize: options.normalize,
-        fontHeight: options.fontHeight,
-        round: options.round,
-        descent: options.descent,
-        addHashInFontUrl: options.addHashInFontUrl,
-        glyphTransformFn: (obj) => {
-            const char = String.fromCodePoint(i);
-            obj.unicode = [char];
-            i++;
-            return obj;
-        },
-    });
-    const buildedFormats = [];
-    ICON_FONT_FORMATS.forEach((format) => {
-        const code = result[format];
-        if (code) {
-            buildedFormats.push({ format, code });
-        }
-    });
-    await Promise.all(buildedFormats.map(({ format, code }) => {
-        return fs.writeFile(path.join(options.dest, `${options.name}.${format}`), code);
-    }));
-    const glyphs = [];
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    result.glyphsData.forEach(({ metadata }) => {
-        if (!metadata)
-            return;
-        const { name, unicode } = metadata;
-        if (!unicode) {
-            return;
-        }
-        const code = unicode[0].charCodeAt(0).toString(16);
-        glyphs.push({ name, code });
-    });
-    const urlPath = options.absolutePath ? options.dest : '.';
-    const hashSuffix = options.addHashInFontUrl ? `?${Date.now()}` : '';
-    const src = buildedFormats
-        .map(({ format }) => {
-        return `url("${urlPath}/${options.name}.${format}${hashSuffix}") format("${ICON_FONT_FORMAT_MAP[format]}")`;
-    })
-        .join(',');
-    const cssCode = `/* stylelint-disable */
-@font-face {
-  font-family: "${options.fontName}";
-  font-display: block;
-  font-style: normal;
-  font-weight: 400;
-  src: ${src};
-}
-
-i[class^="${cssPrefix}"]:before, i[class*=" ${cssPrefix}"]:before {
-  font-family: ${options.fontName} !important;
-  font-style: normal;
-  font-weight: normal !important;
-  font-variant: normal;
-  text-transform: none;
-  text-rendering: auto;
-  line-height: 1;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-${glyphs
-        .map(({ name, code }) => {
-        return `
-.${cssPrefix}${name}:before { content: "\\${code}"; }
-  `;
-    })
-        .join('\n')}
-  `;
-    await fs.writeFile(path.join(options.dest, `${options.name}.css`), cssCode);
-    // const prefix = options.prefix ? `${options.prefix}-` : '';
-    const ids = glyphs.map(({ name }) => `${options.prefix}${name}`);
-    await generateTS(options, ids);
-    await hash.commit(srcHash);
-    return {
-        entry,
-        result,
-    };
-}
-async function generateIndex(dest, entries) {
-    const names = entries.map(({ name }) => name);
-    const tsCode = `
-/* eslint-disable */
-// @ts-nocheck
-import './index.css';
-${BANNER}
-${names
-        .map((name, index) => 
-    // `import { IconName as IconName_${index}, IconNameMap as IconNameMap_${index} } from './${name}/${name}';`,
-    `import './${name}/${name}';`)
-        .join('\n')}
-export type { IconName } from '@fastkit/icon-font';
-export { ICON_NAMES } from '@fastkit/icon-font';
-  `.trim();
-    const tsDest = path.join(dest, 'index.ts');
-    await fs.writeFile(tsDest, tsCode);
-    const cssCode = `
-/* stylelint-disable */
-${BANNER}
-${names.map((name) => `@import './${name}/${name}.css';`).join('\n')}
-  `.trim();
-    const cssDest = path.join(dest, 'index.css');
-    await fs.writeFile(cssDest, cssCode);
-}
-async function generate(opts) {
-    await fs.emptyDir(opts.dest);
-    const results = await Promise.all(opts.entries.map((entry) => resolveRawIconFontEntry(opts.dest, entry).then((entry) => generateEntry(entry))));
-    const entries = results.map(({ entry }) => entry);
-    await generateIndex(opts.dest, entries);
-}
-class IconFontRunnerItem extends ev.EV {
-    entry;
-    ctx;
-    _resolveEntryPromise;
-    _watcher = null;
-    watchMode;
-    // get name() {
-    //   return this.entry.name;
-    // }
-    constructor(ctx, entry, watch = false) {
-        super();
-        this.ctx = ctx;
-        this.entry = entry;
-        this.watchMode = watch;
-        this.build = this.build.bind(this);
-    }
-    async run() {
-        const result = await this.build();
-        if (this.watchMode && !this._watcher) {
-            const watchDir = path.resolve(this.entry.src);
-            this._watcher = chokidar.watch(watchDir, { ignoreInitial: true });
-            this._watcher.on('all', this.build);
-        }
-        return result;
-    }
-    resolveEntry() {
-        if (!this._resolveEntryPromise) {
-            this._resolveEntryPromise = resolveRawIconFontEntry(this.ctx.dest, this.entry);
-        }
-        return this._resolveEntryPromise;
-    }
-    async build() {
-        const entry = await this.resolveEntry();
-        const result = await generateEntry(entry);
-        this.emit('build', result);
-        return { entry };
-    }
-    destroy() {
-        if (this._watcher) {
-            this._watcher.close();
-            this._watcher = null;
-        }
-        this.offAll();
-        if (this.ctx) {
-            delete this.ctx;
-        }
-    }
-}
-class IconFontRunner extends ev.EV {
-    items = [];
-    dest;
-    // private _opts: IconFontOptions;
-    // private entries: IconFontEntry[] = [];
-    constructor(opts, watch) {
-        super();
-        // this._opts = opts;
-        this.dest = opts.dest;
-        // this.entries = opts.entries.map((entry) =>
-        //   resolveRawIconFontEntry(this.outputDir, entry),
-        // );
-        opts.entries.forEach((entry) => {
-            const item = new IconFontRunnerItem(this, entry, watch);
-            item.on('build', (result) => {
-                this.emit('build', { item, result });
-            });
-            this.items.push(item);
-        });
-    }
-    async buildIndex() {
-        const entries = await Promise.all(this.items.map((item) => item.resolveEntry()));
-        return generateIndex(this.dest, entries);
-    }
-    async run() {
-        await fs.ensureDir(this.dest);
-        await Promise.all([
-            this.buildIndex(),
-            Promise.all(this.items.map((item) => item.run())),
-        ]);
-    }
-    destroy() {
-        this.items.forEach((item) => item.destroy());
-        this.items.length = 0;
-        this.offAll();
-        delete this._opts;
-    }
-}
-
-const { version } = require('../package.json');
-function cli() {
-    const cli = cac.cac('icon-font');
-    cli
-        .option('-d, --dest <string>', 'Destination for generated fonts.', {
-        default: path.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
-    })
-        .command('[config file path]', `
-Path of the configuration file. (default: [your package directory]${path.sep}${DEFAULT_CONFIG_FILENAME})
-    You must export default <IconFontConfig>.
-
-    e.g.
-    \`\`\`
-    import { ceateIconFontConfig } from '@fastkit/icon-font-gen';
-
-    export default ceateIconFontConfig({ ... });
-    \`\`\`
-      `.trim())
-        .action(async (configPath, options) => {
-        if (!configPath) {
-            const pkgDir = await nodeUtil.findPackageDir();
-            if (!pkgDir) {
-                throw new IconFontGenError('missing package directory.');
-            }
-            configPath = path.join(pkgDir, DEFAULT_CONFIG_FILENAME);
-        }
-        const dest = path.resolve(options.dest);
-        const mod = await nodeUtil.esbuildRequire(configPath);
-        const config = mod.exports.default;
-        await generate({
-            ...config,
-            dest,
-        });
-    });
-    cli.help();
-    cli.version(version);
-    cli.parse();
-}
-
-exports.DEFAULT_CONFIG_FILENAME = DEFAULT_CONFIG_FILENAME;
-exports.DEFAULT_DEST_DIRNAME = DEFAULT_DEST_DIRNAME;
-exports.DEFAULT_OPTIONS = DEFAULT_OPTIONS;
-exports.ICON_FONT_FORMATS = ICON_FONT_FORMATS;
-exports.ICON_FONT_FORMAT_MAP = ICON_FONT_FORMAT_MAP;
-exports.IconFontRunner = IconFontRunner;
-exports.IconFontRunnerItem = IconFontRunnerItem;
-exports.ceateIconFontConfig = ceateIconFontConfig;
-exports.cli = cli;
-exports.generate = generate;
-exports.generateEntry = generateEntry;
-exports.generateIndex = generateIndex;
-exports.mergeDefaults = mergeDefaults;
-exports.resolveRawIconFontEntry = resolveRawIconFontEntry;

package/index.js

@@ -1,6 +0,0 @@
-'use strict';
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./dist/icon-font-gen.cjs.prod.js');
-} else {
-  module.exports = require('./dist/icon-font-gen.cjs.js');
-}

package/lib/cli.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-const path = require('path');
-const { cli } = require(path.resolve(__dirname, '../dist/icon-font-gen.cjs'));
-cli();