@vitus-labs/tools-favicon 0.45.0 → 1.0.1-alpha.1

package/lib/{vitus-tools-favicon.module.js → baseConfig.js}

@@ -1,65 +1,37 @@
-import fs from 'fs';
-import favicons from 'favicons';
-import { loadVLToolsConfig } from '@vitus-labs/tools-core';
-
-const configuration = {
-    dir: 'auto',
-    lang: 'en-US',
-    background: '#fff',
-    theme_color: '#fff',
-    appleStatusBarStyle: 'black-translucent',
-    display: 'standalone',
-    orientation: 'any',
-    scope: '/',
-    start_url: '/?homescreen=1',
-    version: '1.0',
-    logging: false,
-    pixel_art: false,
-    loadManifestWithCredentials: false,
-    icons: {
-        // Platform Options:
-        // - offset - offset in percentage
-        // - background:
-        //   * false - use default
-        //   * true - force use default, e.g. set background for Android icons
-        //   * color - set background for the specified icons
-        //   * mask - apply mask in order to create circle icon (applied by default for firefox). `boolean`
-        //   * overlayGlow - apply glow effect after mask has been applied (applied by default for firefox). `boolean`
-        //   * overlayShadow - apply drop shadow after mask has been applied .`boolean`
-        //
-        android: true,
-        appleIcon: true,
-        appleStartup: true,
-        coast: true,
-        favicons: true,
-        firefox: true,
-        windows: true,
-        yandex: true, // Create Yandex browser icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
-    },
+const configuration = {
+    dir: 'auto',
+    lang: 'en-US',
+    background: '#fff',
+    theme_color: '#fff',
+    appleStatusBarStyle: 'black-translucent',
+    display: 'standalone',
+    orientation: 'any',
+    scope: '/',
+    start_url: '/?homescreen=1',
+    version: '1.0',
+    logging: false,
+    pixel_art: false,
+    loadManifestWithCredentials: false,
+    icons: {
+        // Platform Options:
+        // - offset - offset in percentage
+        // - background:
+        //   * false - use default
+        //   * true - force use default, e.g. set background for Android icons
+        //   * color - set background for the specified icons
+        //   * mask - apply mask in order to create circle icon (applied by default for firefox). `boolean`
+        //   * overlayGlow - apply glow effect after mask has been applied (applied by default for firefox). `boolean`
+        //   * overlayShadow - apply drop shadow after mask has been applied .`boolean`
+        //
+        android: true,
+        appleIcon: true,
+        appleStartup: true,
+        coast: true,
+        favicons: true,
+        firefox: true,
+        windows: true,
+        yandex: true, // Create Yandex browser icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    },
 };
-
-const VL_CONFIG = loadVLToolsConfig('favicon');
-const { icons, path, ...restConfig } = VL_CONFIG.merge(configuration).config;
-const callback = (outputPath) => (error, response) => {
-    if (error) {
-        console.log(error.message); // Error description e.g. "An unknown error has occurred"
-        return;
-    }
-    console.log('Creating images...');
-    response.images.forEach((item) => {
-        fs.writeFileSync(`${outputPath}${item.name}`, item.contents);
-    });
-    console.log('Creating manifests...');
-    response.files.forEach((item) => {
-        fs.writeFileSync(`${outputPath}${item.name}`, item.contents);
-    });
-};
-const generateFavicons = () => icons.forEach((item) => {
-    const inputPath = `${process.cwd()}/${item.input}`;
-    const outputPath = `${process.cwd()}/${item.output}/`;
-    // favicons(source, configuration, callback)
-    favicons(inputPath, { ...restConfig, path: `${path}/${item.path}` }, callback(outputPath));
-});
-
-export { configuration, generateFavicons };
-//# sourceMappingURL=vitus-tools-favicon.module.js.map
+export { configuration };
+//# sourceMappingURL=baseConfig.js.map

package/lib/baseConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseConfig.js","sourceRoot":"","sources":["../src/baseConfig.ts"],"names":[],"mappings":"AAAA,MAAM,aAAa,GAAG;IACpB,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,OAAO;IACb,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,MAAM;IACnB,mBAAmB,EAAE,mBAAmB;IACxC,OAAO,EAAE,YAAY;IACrB,WAAW,EAAE,KAAK;IAClB,KAAK,EAAE,GAAG;IACV,SAAS,EAAE,gBAAgB;IAC3B,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,SAAS,EAAE,KAAK;IAChB,2BAA2B,EAAE,KAAK;IAClC,KAAK,EAAE;QACL,oBAAoB;QACpB,kCAAkC;QAClC,gBAAgB;QAChB,0BAA0B;QAC1B,sEAAsE;QACtE,qDAAqD;QACrD,mGAAmG;QACnG,8GAA8G;QAC9G,+EAA+E;QAC/E,EAAE;QACF,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,IAAI;QAClB,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,IAAI,EAAE,6HAA6H;KAC5I;CACF,CAAA;AAID,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/lib/bin/run-favicon.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { generateFavicons } from '../generateFavicon.js';
+await generateFavicons();
+//# sourceMappingURL=run-favicon.js.map

package/lib/bin/run-favicon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-favicon.js","sourceRoot":"","sources":["../../src/bin/run-favicon.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,gBAAgB,EAAE,CAAA"}

package/lib/generateFavicon.js

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import favicons from 'favicons';
+import { loadVLToolsConfig } from '@vitus-labs/tools-core';
+import { configuration } from './baseConfig.js';
+const VL_CONFIG = await loadVLToolsConfig('favicon');
+const { icons, path, ...restConfig } = VL_CONFIG.merge(configuration).config;
+const handleSuccess = (outputPath, response) => {
+    console.log('Creating images...');
+    response.images.forEach((item) => {
+        fs.writeFileSync(`${outputPath}${item.name}`, item.contents);
+    });
+    console.log('Creating manifests...');
+    response.files.forEach((item) => {
+        fs.writeFileSync(`${outputPath}${item.name}`, item.contents);
+    });
+};
+const handleError = (error) => {
+    console.log(error.message); // Error description e.g. "An unknown error has occurred"
+};
+const generateFavicons = () => icons.forEach((item) => {
+    const inputPath = `${process.cwd()}/${item.input}`;
+    const outputPath = `${process.cwd()}/${item.output}/`;
+    // favicons(source, configuration, callback)
+    favicons(inputPath, { ...restConfig, path: `${path}/${item.path}` }).then((res) => handleSuccess(outputPath, res), (err) => handleError(err));
+});
+export { generateFavicons };
+//# sourceMappingURL=generateFavicon.js.map

package/lib/generateFavicon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFavicon.js","sourceRoot":"","sources":["../src/generateFavicon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,SAAS,CAAC,CAAA;AAEpD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;AAE5E,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE;IAC7C,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACjC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,EAAE,CAAC,aAAa,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC9D,CAAC,CAAC,CAAA;IAEF,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;IACpC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9B,EAAE,CAAC,aAAa,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC9D,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,EAAE;IAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA,CAAC,yDAAyD;AACtF,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;IACrB,MAAM,SAAS,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAA;IAClD,MAAM,UAAU,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAA;IAErD,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CACvE,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,EACvC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAC1B,CAAA;AACH,CAAC,CAAC,CAAA;AAEJ,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/lib/index.js

@@ -0,0 +1,4 @@
+import { generateFavicons } from './generateFavicon.js';
+import { configuration } from './baseConfig.js';
+export { generateFavicons, configuration };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAiB,MAAM,iBAAiB,CAAA;AAI9D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAA"}

package/lib/types/baseConfig.d.ts

@@ -1,28 +1,27 @@
-declare const configuration: {
-    dir: string;
-    lang: string;
-    background: string;
-    theme_color: string;
-    appleStatusBarStyle: string;
-    display: string;
-    orientation: string;
-    scope: string;
-    start_url: string;
-    version: string;
-    logging: boolean;
-    pixel_art: boolean;
-    loadManifestWithCredentials: boolean;
-    icons: {
-        android: boolean;
-        appleIcon: boolean;
-        appleStartup: boolean;
-        coast: boolean;
-        favicons: boolean;
-        firefox: boolean;
-        windows: boolean;
-        yandex: boolean;
-    };
-};
-export type Configuration = typeof configuration;
-export default configuration;
-//# sourceMappingURL=baseConfig.d.ts.map
+declare const configuration: {
+    dir: string;
+    lang: string;
+    background: string;
+    theme_color: string;
+    appleStatusBarStyle: string;
+    display: string;
+    orientation: string;
+    scope: string;
+    start_url: string;
+    version: string;
+    logging: boolean;
+    pixel_art: boolean;
+    loadManifestWithCredentials: boolean;
+    icons: {
+        android: boolean;
+        appleIcon: boolean;
+        appleStartup: boolean;
+        coast: boolean;
+        favicons: boolean;
+        firefox: boolean;
+        windows: boolean;
+        yandex: boolean;
+    };
+};
+export type Configuration = typeof configuration;
+export { configuration };

package/lib/types/bin/run-favicon.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/types/generateFavicon.d.ts

@@ -1,3 +1,2 @@
-declare const generateFavicons: () => any;
-export default generateFavicons;
-//# sourceMappingURL=generateFavicon.d.ts.map
+declare const generateFavicons: () => any;
+export { generateFavicons };

package/lib/types/index.d.ts

@@ -1,5 +1,4 @@
-import generateFavicons from "./generateFavicon";
-import configuration, { Configuration } from "./baseConfig";
-export type { Configuration };
-export { generateFavicons, configuration };
-//# sourceMappingURL=index.d.ts.map
+import { generateFavicons } from './generateFavicon.js';
+import { configuration, Configuration } from './baseConfig.js';
+export type { Configuration };
+export { generateFavicons, configuration };

package/package.json

@@ -1,41 +1,34 @@
 {
   "name": "@vitus-labs/tools-favicon",
-  "version": "0.45.0",
+  "version": "1.0.1-alpha.1",
   "license": "MIT",
   "author": "Vit Bokisch <vit@bokisch.com>",
   "maintainers": [
     "Vit Bokisch <vit@bokisch.com>"
   ],
-  "main": "lib/vitus-tools-favicon.js",
-  "module": "lib/vitus-tools-favicon.module.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/",
-    "bin/"
-  ],
+  "type": "module",
+  "exports": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "engines": {
-    "node": ">= 14"
+    "node": ">= 16"
   },
   "publishConfig": {
     "access": "public"
   },
   "bin": {
-    "vl_favicon": "bin/run-favicon.js"
+    "vl_favicon": "./lib/bin/run-favicon.js"
   },
   "scripts": {
     "prepublish": "yarn build",
-    "build": "yarn vl_build",
-    "build:watch": "yarn vl_build-watch",
-    "lint:css": "stylelint src/*.ts src/*.tsx",
-    "lint:ts": "eslint src/*",
-    "lint": "yarn lint:css && yarn lint:ts"
+    "build": "tsc"
   },
   "dependencies": {
-    "@vitus-labs/tools-babel": "0.45.0",
-    "@vitus-labs/tools-core": "0.45.0",
-    "@vitus-labs/tools-rollup": "0.45.0",
-    "@vitus-labs/tools-typescript": "0.45.0",
-    "favicons": "^6.2.2"
+    "@vitus-labs/tools-core": "1.0.1-alpha.1",
+    "favicons": "^7.1.3"
+  },
+  "devDependencies": {
+    "@vitus-labs/tools-typescript": "1.0.1-alpha.1",
+    "typescript": "^5.1.6"
   },
-  "gitHead": "260516cc2028ef150b5845bbb9480db1155e7e9c"
+  "gitHead": "52d479556ae2a3e6047e251526e80cb08d77ecdd"
 }

package/src/baseConfig.ts

@@ -0,0 +1,39 @@
+const configuration = {
+  dir: 'auto', // Primary text direction for name, short_name, and description
+  lang: 'en-US', // Primary language for name and short_name
+  background: '#fff', // Background colour for flattened icons. `string`
+  theme_color: '#fff', // Theme color user for example in Android's task switcher. `string`
+  appleStatusBarStyle: 'black-translucent', // Style for Apple status bar: "black-translucent", "default", "black". `string`
+  display: 'standalone', // Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". `string`
+  orientation: 'any', // Default orientation: "any", "natural", "portrait" or "landscape". `string`
+  scope: '/', // set of URLs that the browser considers within your app
+  start_url: '/?homescreen=1', // Start URL when launching the application from a device. `string`
+  version: '1.0', // Your application's version string. `string`
+  logging: false, // Print logs to console? `boolean`
+  pixel_art: false, // Keeps pixels "sharp" when scaling up, for pixel art.  Only supported in offline mode.
+  loadManifestWithCredentials: false, // Browsers don't send cookies when fetching a manifest, enable this to fix that. `boolean`
+  icons: {
+    // Platform Options:
+    // - offset - offset in percentage
+    // - background:
+    //   * false - use default
+    //   * true - force use default, e.g. set background for Android icons
+    //   * color - set background for the specified icons
+    //   * mask - apply mask in order to create circle icon (applied by default for firefox). `boolean`
+    //   * overlayGlow - apply glow effect after mask has been applied (applied by default for firefox). `boolean`
+    //   * overlayShadow - apply drop shadow after mask has been applied .`boolean`
+    //
+    android: true, // Create Android homescreen icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    appleIcon: true, // Create Apple touch icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    appleStartup: true, // Create Apple startup images. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    coast: true, // Create Opera Coast icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    favicons: true, // Create regular favicons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    firefox: true, // Create Firefox OS icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    windows: true, // Create Windows 8 tile icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+    yandex: true, // Create Yandex browser icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
+  },
+}
+
+export type Configuration = typeof configuration
+
+export { configuration }

package/src/bin/run-favicon.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { generateFavicons } from '../generateFavicon.js'
+
+await generateFavicons()

package/src/generateFavicon.ts

@@ -0,0 +1,38 @@
+import fs from 'node:fs'
+import favicons from 'favicons'
+import { loadVLToolsConfig } from '@vitus-labs/tools-core'
+import { configuration } from './baseConfig.js'
+
+const VL_CONFIG = await loadVLToolsConfig('favicon')
+
+const { icons, path, ...restConfig } = VL_CONFIG.merge(configuration).config
+
+const handleSuccess = (outputPath, response) => {
+  console.log('Creating images...')
+  response.images.forEach((item) => {
+    fs.writeFileSync(`${outputPath}${item.name}`, item.contents)
+  })
+
+  console.log('Creating manifests...')
+  response.files.forEach((item) => {
+    fs.writeFileSync(`${outputPath}${item.name}`, item.contents)
+  })
+}
+
+const handleError = (error) => {
+  console.log(error.message) // Error description e.g. "An unknown error has occurred"
+}
+
+const generateFavicons = () =>
+  icons.forEach((item) => {
+    const inputPath = `${process.cwd()}/${item.input}`
+    const outputPath = `${process.cwd()}/${item.output}/`
+
+    // favicons(source, configuration, callback)
+    favicons(inputPath, { ...restConfig, path: `${path}/${item.path}` }).then(
+      (res) => handleSuccess(outputPath, res),
+      (err) => handleError(err)
+    )
+  })
+
+export { generateFavicons }

package/src/index.ts

@@ -0,0 +1,6 @@
+import { generateFavicons } from './generateFavicon.js'
+import { configuration, Configuration } from './baseConfig.js'
+
+export type { Configuration }
+
+export { generateFavicons, configuration }

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "extends": "@vitus-labs/tools-typescript/lib",
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "outDir": "lib",
+    "rootDir": "src",
+    "baseUrl": ".",
+    "declarationDir": "./lib/types",
+    "paths": {
+      "~/*": [
+        "src/*"
+      ]
+    },
+    "plugins": []
+  },
+  "include": [
+    "typings",
+    "src",
+  ],
+  "exclude": [
+    "node_modules",
+    "__stories__",
+    "lib"
+  ]
+}