@fastkit/icon-font-gen 0.8.18 → 0.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-present, Ayumu Fujii (dadajam4) and Fastkit contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,4 @@
 # @fastkit/icon-font-gen
+
+## Documentation
+https://dadajam4.github.io/fastkit/icon-font-gen/

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

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var path = require('path');
 var nodeUtil = require('@fastkit/node-util');
 var fs = require('fs-extra');
@@ -10,24 +8,6 @@ var ev = require('@fastkit/ev');
 var tinyLogger = require('@fastkit/tiny-logger');
 var cac = require('cac');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    for (var k in e) {
-      n[k] = e[k];
-    }
-  }
-  n["default"] = e;
-  return Object.freeze(n);
-}
-
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var chokidar__default = /*#__PURE__*/_interopDefaultLegacy(chokidar);
-
 const ICON_FONT_FORMATS = [
     'eot',
     'woff',
@@ -49,7 +29,7 @@ async function resolveRawIconFontEntry(rootDir, rawEntry) {
     // mdi support
     if (entry.src === '@mdi') {
         const installedDir = await findOrInstallMDI();
-        entry.src = path__default.join(installedDir, 'svg');
+        entry.src = path.join(installedDir, 'svg');
         if (entry.fontHeight == null) {
             entry.fontHeight = 512;
         }
@@ -60,9 +40,9 @@ async function resolveRawIconFontEntry(rootDir, rawEntry) {
             entry.name = 'mdi';
         }
     }
-    const name = entry.name || path__default.basename(entry.src);
+    const name = entry.name || path.basename(entry.src);
     const fontName = entry.fontName || `${name}-icon`;
-    const dest = path__default.join(rootDir, name);
+    const dest = path.join(rootDir, name);
     const prefix = entry.disablePrefix ? '' : `${name}-`;
     return {
         ...entry,
@@ -122,8 +102,8 @@ export const ICON_NAMES = registerIconNames([
 export type { IconName, IconNameMap } from '@fastkit/icon-font';
   `.trim();
     const fileName = `${entry.name || 'icons'}.ts`;
-    const dest = path__default.resolve(entry.dest, fileName);
-    await fs__default.writeFile(dest, code);
+    const dest = path.resolve(entry.dest, fileName);
+    await fs.writeFile(dest, code);
     return {
         fileName,
         dest,
@@ -141,8 +121,8 @@ async function generateEntry(entry) {
         logger.info(`Has not chaged files. Skip process. >>> ${options.src}`);
         return { entry };
     }
-    await fs__default.ensureDir(options.dest);
-    const webfont = await (await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('webfont')); })).default;
+    await fs.ensureDir(options.dest);
+    const { webfont } = await import('webfont');
     // const { startUnicode = 0xea01 } = options;
     const { startUnicode = 0xba01 } = options;
     let i = startUnicode;
@@ -172,7 +152,7 @@ async function generateEntry(entry) {
         }
     });
     await Promise.all(buildedFormats.map(({ format, code }) => {
-        return fs__default.writeFile(path__default.join(options.dest, `${options.name}.${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
@@ -221,7 +201,7 @@ ${glyphs
     })
         .join('\n')}
   `;
-    await fs__default.writeFile(path__default.join(options.dest, `${options.name}.css`), cssCode);
+    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);
@@ -246,18 +226,18 @@ ${names
 export type { IconName } from '@fastkit/icon-font';
 export { ICON_NAMES } from '@fastkit/icon-font';
   `.trim();
-    const tsDest = path__default.join(dest, 'index.ts');
-    await fs__default.writeFile(tsDest, tsCode);
+    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__default.join(dest, 'index.css');
-    await fs__default.writeFile(cssDest, cssCode);
+    const cssDest = path.join(dest, 'index.css');
+    await fs.writeFile(cssDest, cssCode);
 }
 async function generate(opts) {
-    await fs__default.emptyDir(opts.dest);
+    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);
@@ -281,8 +261,8 @@ class IconFontRunnerItem extends ev.EV {
     async run() {
         const result = await this.build();
         if (this.watchMode && !this._watcher) {
-            const watchDir = path__default.resolve(this.entry.src);
-            this._watcher = chokidar__default.watch(watchDir, { ignoreInitial: true });
+            const watchDir = path.resolve(this.entry.src);
+            this._watcher = chokidar.watch(watchDir, { ignoreInitial: true });
             this._watcher.on('all', this.build);
         }
         return result;
@@ -335,7 +315,7 @@ class IconFontRunner extends ev.EV {
         return generateIndex(this.dest, entries);
     }
     async run() {
-        await fs__default.ensureDir(this.dest);
+        await fs.ensureDir(this.dest);
         await Promise.all([
             this.buildIndex(),
             Promise.all(this.items.map((item) => item.run())),
@@ -354,10 +334,10 @@ function cli() {
     const cli = cac.cac('icon-font');
     cli
         .option('-d, --dest <string>', 'Destination for generated fonts.', {
-        default: path__default.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
+        default: path.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
     })
         .command('[config file path]', `
-Path of the configuration file. (default: [your package directory]${path__default.sep}${DEFAULT_CONFIG_FILENAME})
+Path of the configuration file. (default: [your package directory]${path.sep}${DEFAULT_CONFIG_FILENAME})
     You must export default <IconFontConfig>.
 
     e.g.
@@ -373,9 +353,9 @@ Path of the configuration file. (default: [your package directory]${path__defaul
             if (!pkgDir) {
                 throw new IconFontGenError('missing package directory.');
             }
-            configPath = path__default.join(pkgDir, DEFAULT_CONFIG_FILENAME);
+            configPath = path.join(pkgDir, DEFAULT_CONFIG_FILENAME);
         }
-        const dest = path__default.resolve(options.dest);
+        const dest = path.resolve(options.dest);
         const mod = await nodeUtil.esbuildRequire(configPath);
         const config = mod.exports.default;
         await generate({

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

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var path = require('path');
 var nodeUtil = require('@fastkit/node-util');
 var fs = require('fs-extra');
@@ -10,24 +8,6 @@ var ev = require('@fastkit/ev');
 var tinyLogger = require('@fastkit/tiny-logger');
 var cac = require('cac');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    for (var k in e) {
-      n[k] = e[k];
-    }
-  }
-  n["default"] = e;
-  return Object.freeze(n);
-}
-
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var chokidar__default = /*#__PURE__*/_interopDefaultLegacy(chokidar);
-
 const ICON_FONT_FORMATS = [
     'eot',
     'woff',
@@ -49,7 +29,7 @@ async function resolveRawIconFontEntry(rootDir, rawEntry) {
     // mdi support
     if (entry.src === '@mdi') {
         const installedDir = await findOrInstallMDI();
-        entry.src = path__default.join(installedDir, 'svg');
+        entry.src = path.join(installedDir, 'svg');
         if (entry.fontHeight == null) {
             entry.fontHeight = 512;
         }
@@ -60,9 +40,9 @@ async function resolveRawIconFontEntry(rootDir, rawEntry) {
             entry.name = 'mdi';
         }
     }
-    const name = entry.name || path__default.basename(entry.src);
+    const name = entry.name || path.basename(entry.src);
     const fontName = entry.fontName || `${name}-icon`;
-    const dest = path__default.join(rootDir, name);
+    const dest = path.join(rootDir, name);
     const prefix = entry.disablePrefix ? '' : `${name}-`;
     return {
         ...entry,
@@ -122,8 +102,8 @@ export const ICON_NAMES = registerIconNames([
 export type { IconName, IconNameMap } from '@fastkit/icon-font';
   `.trim();
     const fileName = `${entry.name || 'icons'}.ts`;
-    const dest = path__default.resolve(entry.dest, fileName);
-    await fs__default.writeFile(dest, code);
+    const dest = path.resolve(entry.dest, fileName);
+    await fs.writeFile(dest, code);
     return {
         fileName,
         dest,
@@ -141,8 +121,8 @@ async function generateEntry(entry) {
         logger.info(`Has not chaged files. Skip process. >>> ${options.src}`);
         return { entry };
     }
-    await fs__default.ensureDir(options.dest);
-    const webfont = await (await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('webfont')); })).default;
+    await fs.ensureDir(options.dest);
+    const { webfont } = await import('webfont');
     // const { startUnicode = 0xea01 } = options;
     const { startUnicode = 0xba01 } = options;
     let i = startUnicode;
@@ -172,7 +152,7 @@ async function generateEntry(entry) {
         }
     });
     await Promise.all(buildedFormats.map(({ format, code }) => {
-        return fs__default.writeFile(path__default.join(options.dest, `${options.name}.${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
@@ -221,7 +201,7 @@ ${glyphs
     })
         .join('\n')}
   `;
-    await fs__default.writeFile(path__default.join(options.dest, `${options.name}.css`), cssCode);
+    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);
@@ -246,18 +226,18 @@ ${names
 export type { IconName } from '@fastkit/icon-font';
 export { ICON_NAMES } from '@fastkit/icon-font';
   `.trim();
-    const tsDest = path__default.join(dest, 'index.ts');
-    await fs__default.writeFile(tsDest, tsCode);
+    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__default.join(dest, 'index.css');
-    await fs__default.writeFile(cssDest, cssCode);
+    const cssDest = path.join(dest, 'index.css');
+    await fs.writeFile(cssDest, cssCode);
 }
 async function generate(opts) {
-    await fs__default.emptyDir(opts.dest);
+    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);
@@ -281,8 +261,8 @@ class IconFontRunnerItem extends ev.EV {
     async run() {
         const result = await this.build();
         if (this.watchMode && !this._watcher) {
-            const watchDir = path__default.resolve(this.entry.src);
-            this._watcher = chokidar__default.watch(watchDir, { ignoreInitial: true });
+            const watchDir = path.resolve(this.entry.src);
+            this._watcher = chokidar.watch(watchDir, { ignoreInitial: true });
             this._watcher.on('all', this.build);
         }
         return result;
@@ -335,7 +315,7 @@ class IconFontRunner extends ev.EV {
         return generateIndex(this.dest, entries);
     }
     async run() {
-        await fs__default.ensureDir(this.dest);
+        await fs.ensureDir(this.dest);
         await Promise.all([
             this.buildIndex(),
             Promise.all(this.items.map((item) => item.run())),
@@ -354,10 +334,10 @@ function cli() {
     const cli = cac.cac('icon-font');
     cli
         .option('-d, --dest <string>', 'Destination for generated fonts.', {
-        default: path__default.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
+        default: path.join(process.cwd(), `${DEFAULT_DEST_DIRNAME}`),
     })
         .command('[config file path]', `
-Path of the configuration file. (default: [your package directory]${path__default.sep}${DEFAULT_CONFIG_FILENAME})
+Path of the configuration file. (default: [your package directory]${path.sep}${DEFAULT_CONFIG_FILENAME})
     You must export default <IconFontConfig>.
 
     e.g.
@@ -373,9 +353,9 @@ Path of the configuration file. (default: [your package directory]${path__defaul
             if (!pkgDir) {
                 throw new IconFontGenError('missing package directory.');
             }
-            configPath = path__default.join(pkgDir, DEFAULT_CONFIG_FILENAME);
+            configPath = path.join(pkgDir, DEFAULT_CONFIG_FILENAME);
         }
-        const dest = path__default.resolve(options.dest);
+        const dest = path.resolve(options.dest);
         const mod = await nodeUtil.esbuildRequire(configPath);
         const config = mod.exports.default;
         await generate({

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "@fastkit/icon-font-gen",
-  "version": "0.8.18",
-  "description": "@fastkit/icon-font-gen",
+  "version": "0.10.0",
+  "description": "A tool to generate icon web fonts and their definitions Type-safe for your application.",
   "buildOptions": {
     "name": "IconFont",
     "formats": [
       "cjs"
     ]
   },
+  "_docs": {
+    "scope": "",
+    "feature": "icon",
+    "description": {
+      "en": "A tool to generate icon web fonts and their definitions Type-safe for your application.",
+      "ja": "アプリケーションのためにアイコンWebフォントとその定義をTypeセーフに生成するツール。"
+    }
+  },
   "main": "index.js",
   "bin": {
     "icon-font": "lib/cli.js"
@@ -24,7 +32,8 @@
     "url": "git+https://github.com/dadajam4/fastkit.git"
   },
   "keywords": [
-    "fastkit"
+    "fastkit",
+    "icon"
   ],
   "author": "dadajam4",
   "license": "MIT",
@@ -33,13 +42,13 @@
   },
   "homepage": "https://github.com/dadajam4/fastkit/tree/main/packages/icon-font-gen#readme",
   "dependencies": {
-    "@fastkit/ev": "0.8.18",
-    "@fastkit/icon-font": "0.8.18",
-    "@fastkit/node-util": "0.8.18",
-    "@fastkit/tiny-logger": "0.8.18",
+    "@fastkit/ev": "0.10.0",
+    "@fastkit/icon-font": "0.10.0",
+    "@fastkit/node-util": "0.10.0",
+    "@fastkit/tiny-logger": "0.10.0",
     "cac": "^6.7.11",
     "chokidar": "^3.5.0",
-    "fs-extra": "^9.1.0",
+    "fs-extra": "^11.1.0",
     "webfont": "^11.2.26"
   }
 }