@quasar/icongenie 2.5.0 → 2.5.3

package/lib/utils/parse-argv.js

@@ -1,5 +1,5 @@
 const { existsSync, lstatSync } = require('fs')
-const { resolve, normalize, join } = require('path')
+const { resolve, normalize, join, isAbsolute } = require('path')
 const untildify = require('untildify')
 
 const getPngSize = require('./get-png-size')
@@ -124,6 +124,27 @@ function padding (value, argv) {
     : sizes
 }
 
+function parseIconPath (value) {
+  const __path = untildify(value)
+
+  if (isAbsolute(__path)) {
+    return existsSync(__path) === true
+      ? __path
+      : null
+  }
+
+  let icon = resolve(process.cwd(), __path)
+
+  if (existsSync(icon)) {
+    return icon
+  }
+
+  const { appDir } = require('./app-paths')
+  icon = resolve(appDir, __path)
+
+  return existsSync(icon) ? icon : null
+}
+
 function icon (value, argv) {
   if (!value) {
     warn(`No source icon file specified, so using the sample one`)
@@ -131,12 +152,9 @@ function icon (value, argv) {
     return
   }
 
+  argv.icon = parseIconPath(value)
 
-  const { appDir } = require('./app-paths')
-
-  argv.icon = resolve(appDir, untildify(value))
-
-  if (!existsSync(argv.icon)) {
+  if (!argv.icon) {
     die(`Path to source icon file does not exists: "${value}"`)
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quasar/icongenie",
-  "version": "2.5.0",
+  "version": "2.5.3",
   "description": "A Quasar tool for generating all your Quasar App's icons and splashscreens",
   "bin": {
     "icongenie": "./bin/icongenie"
@@ -37,23 +37,25 @@
   "homepage": "https://quasar.dev/icongenie/introduction",
   "dependencies": {
     "@hapi/joi": "^17.1.1",
-    "kolorist": "^1.5.1",
     "cross-spawn": "^7.0.2",
     "elementtree": "^0.1.7",
-    "fast-glob": "^3.2.2",
-    "fs-extra": "^9.0.0",
+    "fast-glob": "^3.2.11",
+    "fs-extra": "^10.0.1",
     "imagemin": "^7.0.1",
-    "imagemin-pngquant": "^8.0.0",
+    "imagemin-pngquant": "^9.0.2",
     "is-png": "^2.0.0",
-    "is-svg": "^4.2.1",
-    "minimist": "^1.2.5",
+    "kolorist": "^1.5.1",
+    "minimist": "^1.2.6",
     "png2icons": "^2.0.1",
     "potrace": "^2.1.5",
     "read-chunk": "^3.2.0",
-    "sharp": "^0.28.3",
-    "svgo": "^1.3.2",
+    "sharp": "^0.30.3",
+    "svgo": "^2.8.0",
     "untildify": "^4.0.0",
-    "update-notifier": "^4.1.0"
+    "update-notifier": "^5.1.0"
+  },
+  "resolutions": {
+    "minimist": "^1.2.6"
   },
   "publishConfig": {
     "access": "public"

package/bin/icongenie-generate

@@ -1,189 +0,0 @@
-#!/usr/bin/env node
-
-const parseArgs = require('minimist')
-const processArgv = process.argv.slice(2)
-
-const argv = parseArgs(processArgv, {
-  alias: {
-    p: 'profile', // config file
-    i: 'icon',
-    b: 'background',
-    m: 'mode',
-    f: 'filter',
-    q: 'quality',
-    h: 'help'
-  },
-  boolean: [ 'h', 'skip-trim' ],
-  string: [
-    'p', 'i', 'b', 'm', 'f', 'q',
-    'padding',
-    'theme-color',
-    'png-color',
-    'splashscreen-color',
-    'svg-color',
-    'splashscreen-icon-ratio'
-  ]
-})
-
-// if user hasn't explicitly specified this, then
-// we shouldn't take it into account
-if (processArgv.includes('--skip-trim') === false) {
-  delete argv['skip-trim']
-}
-
-const { green } = require('kolorist')
-
-if (argv.help) {
-  const modes = Object.keys(require('../lib/modes')).join('|')
-  const generators = Object.keys(require('../lib/generators')).join('|')
-  const defaultParams = require('../lib/utils/default-params')
-
-  console.log(`
-  Description
-    Generate App icons & splashscreens
-
-  Usage
-    $ icongenie generate [options]
-
-    # generate icons for all installed Quasar modes
-    $ icongenie generate -i /path/to/icon.png
-    $ icongenie g -i /path/to/icon.png
-
-    # generate for (as example) PWA mode only
-    $ icongenie generate -m pwa --icon /path/to/icon.png
-
-    # generate for (as example) Cordova & Capacitor mode only
-    $ icongenie g -m cordova,capacitor -i
-         /path/to/icon.png -b /path/to/background.png
-
-    # generate by using a profile file
-    $ icongenie generate -p ./icongenie-profile.json
-
-    # generate by using batch of profile files
-    $ icongenie generate -p ./folder-containing-profile-files
-
-  Options
-    --icon, -i            ${green('Required')};
-                          Path to source file for icon; must be:
-                            - a .png file
-                            - min resolution: 64x64 px (the higher the better!!)
-                            - with transparency
-                          Best results are with a square image (height = width)
-                          Image will be trimmed automatically
-                            (also see "skip-trim" and "padding" param)
-                          Path can be absolute, or relative to the root of the
-                            Quasar project folder
-                          Recommended min size: 1024x1024 px
-
-    --background, -b      Path to optional background source file (for splashscreens);
-                          must be:
-                            - a .png file
-                            - min resolution: 128x128 px (the higher the better!!)
-                            - transparency is optional (but recommended if you
-                              combine with the splashscreen-color param)
-                          Path can be absolute, or relative to the root of the
-                            Quasar project folder
-                          Recommended min size: 1024x1024 px
-
-    --mode, -m            For which Quasar mode(s) to generate the assets;
-                          Default: all
-                            [all|${modes}]
-                          Multiple can be specified, separated by ",":
-                            spa,cordova
-
-    --filter, -f          Filter the available generators; when used, it can
-                          generate only one type of asset instead of all
-                            [${generators}]
-
-    --quality             Quality of the files [1 - 12] (default: ${defaultParams.quality})
-                            - higher quality --> bigger filesize & slower to create
-                            - lower quality  --> smaller filesize & faster to create
-
-    --skip-trim           Do not trim the icon source file
-
-    --padding             Apply fixed padding to the icon after trimming it;
-                          Syntax: <horiz: number>,<vert: number>
-                          Default: 0,0
-                          Example: "--padding 10,5" means apply 10px padding to top
-                            10px to bottom, 5px to left side and 5px to rightside
-
-    --theme-color         Theme color to use for all generators requiring a color;
-                          It gets overridden if any generator color is also specified;
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --svg-color           Color to use for the generated monochrome svgs
-                          Default (if no theme-color is specified): ${defaultParams.svgColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --png-color           Background color to use for the png generator, when
-                          "background: true" in the asset definition (like for
-                          the cordova/capacitor iOS icons);
-                          Default (if no theme-color is specified): ${defaultParams.pngColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --splashscreen-color  Background color to use for the splashscreen generator;
-                          Default (if no theme-color is specified): ${defaultParams.splashscreenColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --splashscreen-icon-ratio  Ratio of icon size in respect to the width or height
-                               (whichever is smaller) of the resulting splashscreen;
-                               Represents percentages; Valid values: 0 - 100
-                               If 0 then it doesn't add the icon of top of background
-                               Default: ${defaultParams.splashscreenIconRatio}
-
-    --profile, -p         Use JSON profile file(s):
-                            - path to folder (absolute or relative to current folder)
-                              that contains JSON profile files (icongenie-*.json)
-                            - path to a single *.json profile file (absolute or relative
-                              to current folder)
-                          Structure of a JSON profile file:
-                            {
-                              "params": {
-                                "include": [ ... ], /* optional */
-                                ...
-                              },
-                              "assets": [ /* list of custom assets */ ]
-                            }
-
-    --help, -h            Displays this message
-  `)
-  process.exit(0)
-}
-
-const parseArgv = require('../lib/utils/parse-argv')
-const generate = require('../lib/cmd/generate')
-const getProfileFiles = require('../lib/utils/get-profile-files')
-const filterArgvParams = require('../lib/utils/filter-argv-params')
-const { log } = require('../lib/utils/logger')
-
-async function runProfiles (params, profileFiles) {
-  for (let i = 0; i < profileFiles.length; i++) {
-    const profile = profileFiles[i]
-
-    console.log(`\n`)
-    log(`---------------------`)
-    log(`Generating by profile: ${profile}`)
-    log(`---------------------`)
-    console.log(`\n`)
-
-    await generate({ ...params, profile })
-  }
-}
-
-const params = filterArgvParams(argv)
-
-if (params.profile) {
-  parseArgv(params, [ 'profile' ])
-  runProfiles(params, getProfileFiles(params.profile))
-}
-else {
-  generate(params)
-}

package/bin/icongenie-profile

@@ -1,150 +0,0 @@
-#!/usr/bin/env node
-
-const parseArgs = require('minimist')
-
-const argv = parseArgs(process.argv.slice(2), {
-  alias: {
-    o: 'output',
-    a: 'assets',
-
-    i: 'icon',
-    b: 'background',
-    f: 'filter',
-    q: 'quality',
-    h: 'help'
-  },
-  boolean: [ 'h', 'skip-trim' ],
-  string: [
-    'o', 'a',
-    'i', 'b', 'include', 'f', 'q',
-    'padding',
-    'theme-color',
-    'png-color',
-    'splashscreen-color',
-    'svg-color',
-    'splashscreen-icon-ratio'
-  ]
-})
-
-if (argv.help) {
-  const modes = Object.keys(require('../lib/modes')).join('|')
-  const generators = Object.keys(require('../lib/generators')).join('|')
-  const defaultParams = require('../lib/utils/default-params')
-
-  console.log(`
-  Description
-    Helper command to easily bootstrap Icon Genie profile files.
-
-  Usage
-    $ icongenie profile -o <filename> [options]
-
-    # supplying params list
-    $ icongenie profile -o <filename> --include pwa,spa --quality 7
-
-    # supplying assets based on Icon Genie's internal list
-    $ icongenie profile -o <filename> --assets spa,bex
-
-  Options
-    --output, -o          Name of the new Icon Genie profile file
-
-    --assets, -a          Prefill the assets Array with Icon Genie's
-                          internal list, based on the modes that you indicate;
-                            [all|${modes}]
-                          Multiple can be specified, separated by ",":
-                            spa,cordova
-
-    --icon, -i            Path to source file for icons; must be:
-                            - a .png file
-                            - min resolution: 64x64 px (the higher the better!!)
-                            - with transparency
-                          Best results are with a square image (height = width)
-                          Image will be trimmed automatically
-                            (also see "skip-trim" and "padding" param)
-                          Path can be absolute, or relative to the root of the
-                            Quasar project folder
-                          Recommended min size: 1024x1024 px
-
-    --background, -b      Path to optional background source file (for splashscreens);
-                          must be:
-                            - a .png file
-                            - min resolution: 128x128 px (the higher the better!!)
-                            - transparency is optional (but recommended if you
-                              combine with the splashscreen-color param)
-                          Path can be absolute, or relative to the root of the
-                            Quasar project folder
-                          Recommended min size: 1024x1024 px
-
-    --include             Prefill the params.include property;
-                            [all|${modes}]
-                          Multiple can be specified, separated by ",":
-                            spa,cordova
-
-    --filter, -f          Prefill the params.filter property;
-                            [${generators}]
-
-    --quality             Prefill in the params.quality property;
-                          Quality of the files [1 - 12] (default: ${defaultParams.quality})
-                            - higher quality --> bigger filesize & slower to create
-                            - lower quality  --> smaller filesize & faster to create
-
-    --skip-trim           Do not trim the icon source file
-
-    --padding             Apply fixed padding to the icon after trimming it;
-                          Syntax: <horiz: number>,<vert: number>
-                          Default: 0,0
-                          Example: "--padding 10,5" means apply 10px padding to top
-                            10px to bottom, 5px to left side and 5px to rightside
-
-    --theme-color         Prefill the params.themeColor property;
-                          Theme color to use for all generators requiring a color;
-                          It gets overridden if any generator color is also specified;
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --svg-color           Prefill the params.svgColor property;
-                          Color to use for the generated monochrome svgs
-                          Default (if no theme-color is specified): ${defaultParams.svgColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --png-color           Prefill the params.pngColor property;
-                          Background color to use for the png generator, when
-                          "background: true" in the asset definition (like for
-                          the Cordova/Capacitor iOS icons);
-                          Default (if no theme-color is specified): ${defaultParams.pngColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --splashscreen-color  Prefill the params.splashscreenColor property;
-                          Background color to use for the splashscreen generator;
-                          Default (if no theme-color is specified): ${defaultParams.splashscreenColor.slice(1)}
-                          The color must be in hex format (NOT hexa) without the leading
-                          '#' character. Transparency not allowed.
-                          Examples: 1976D2, eee
-
-    --splashscreen-icon-ratio  Prefill the params.splashscreenIconRatio property;
-                               Ratio of icon size in respect to the width or height
-                               (whichever is smaller) of the resulting splashscreen;
-                               Represents percentages; Valid values: 0 - 100
-                               If 0 then it doesn't add the icon of top of background
-                               Default: ${defaultParams.splashscreenIconRatio}
-  `)
-  process.exit(0)
-}
-
-const profile = require('../lib/cmd/profile')
-const filterArgvParams = require('../lib/utils/filter-argv-params')
-const parseArgv = require('../lib/utils/parse-argv')
-
-parseArgv(argv, [
-  'output',
-  'assets',
-  'padding'
-])
-
-const params = filterArgvParams(argv)
-
-profile(params)

package/bin/icongenie-verify

@@ -1,100 +0,0 @@
-#!/usr/bin/env node
-
-const parseArgs = require('minimist')
-
-const argv = parseArgs(process.argv.slice(2), {
-  alias: {
-    m: 'mode',
-    p: 'profile',
-    f: 'filter',
-    h: 'help'
-  },
-  boolean: ['h']
-})
-
-if (argv.help) {
-  const modes = Object.keys(require('../lib/modes')).join('|')
-  const generators = Object.keys(require('../lib/generators')).join('|')
-
-  console.log(`
-  Description
-    Verifies your Quasar App's icons and splashscreens
-    for all installed modes.
-
-  Usage
-    $ icongenie verify [options]
-
-    # verify all Quasar modes
-    $ icongenie verify
-
-    # verify specific mode
-    $ icongenie verify -m spa
-
-    # verify with specific filter
-    $ icongenie verify -f ico
-
-    # verify by using a profile file
-    $ icongenie verify -p ./icongenie-profile.json
-
-    # verify by using batch of profile files
-    $ icongenie verify -p ./folder-containing-profile-files
-
-  Options
-    --mode, -m      For which Quasar mode(s) to verify the assets;
-                    Default: all
-                      [all|${modes}]
-                    Multiple can be specified, separated by ",":
-                      spa,cordova,capacitor
-
-    --filter, -f    Filter the available generators; when used, it verifies
-                    only one type of asset instead of all
-                      [${generators}]
-
-    --profile       Use JSON profile file(s) to extract the asset list to verify:
-                      - path to folder (absolute or relative to current folder)
-                        that contains JSON profile files (icongenie-*.json)
-                      - path to a single *.json profile file (absolute or relative
-                        to current folder)
-                    Structure of a JSON profile file:
-                      {
-                        "params": {
-                          "include": [ ... ], /* optional */
-                          ...
-                        },
-                        "assets": [ /* list of custom assets */ ]
-                      }
-
-    --help, -h      Displays this message
-  `)
-  process.exit(0)
-}
-
-const parseArgv = require('../lib/utils/parse-argv')
-const verify = require('../lib/cmd/verify')
-const getProfileFiles = require('../lib/utils/get-profile-files')
-const filterArgvParams = require('../lib/utils/filter-argv-params')
-const { log } = require('../lib/utils/logger')
-
-async function runProfiles (params, profileFiles) {
-  for (let i = 0; i < profileFiles.length; i++) {
-    const profile = profileFiles[i]
-
-    console.log(`\n`)
-    log(`--------------------`)
-    log(`Verifying by profile: ${profile}`)
-    log(`--------------------`)
-    console.log(`\n`)
-
-    await verify({ ...params, profile })
-  }
-}
-
-const params = filterArgvParams(argv)
-
-if (params.profile) {
-  parseArgv(params, [ 'profile' ])
-  runProfiles(params, getProfileFiles(params.profile))
-}
-else {
-  verify(params)
-}