@quasar/icongenie 4.0.0 → 5.0.0

package/README.md

@@ -22,12 +22,16 @@ This means you need your logo in about 100+ different sizes with representative
 
 ## Installation of Icon Genie
 
-Node.js >=10.0.0 is required.
+Node.js >=22.22.0 is required.
 
 ```
 $ yarn global add @quasar/icongenie
 # or
 $ npm install -g @quasar/icongenie
+# or
+$ pnpm add -g @quasar/icongenie
+# or
+$ bun add -g @quasar/icongenie
 ```
 
 ## Usage
@@ -35,6 +39,7 @@ $ npm install -g @quasar/icongenie
 Please visit [https://quasar.dev/icongenie].
 
 ## Supporting Quasar
+
 Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md).
 
 **Please read our manifest on [Why donations are important](https://quasar.dev/why-donate)**. If you'd like to become a donator, check out [Quasar Framework's Donator campaign](https://donate.quasar.dev).
@@ -60,6 +65,7 @@ Ask questions at the official community forum: [https://forum.quasar.dev](https:
 I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature). Please read the [Contributing Guide](../CONTRIBUTING.md).
 
 ## Semver
+
 Quasar is following [Semantic Versioning 2.0](https://semver.org/).
 
 ## License

package/bin/icongenie.js

@@ -1,20 +1,22 @@
 #!/usr/bin/env node
 
-import '../lib/utils/node-version-check.js'
+if (
+  process.argv.includes('--no-color') ||
+  (await import('ci-info').then(({ isCI }) => isCI))
+) {
+  process.env.FORCE_COLOR = '0'
+}
+
+await import('../lib/utils/node-version-check.js')
 
-import updateNotifier from 'update-notifier'
-import { packageJson } from '../lib/utils/package-json.js'
+const { default: updateNotifier } = await import('update-notifier')
+const { packageJson } = await import('../lib/utils/package-json.js')
 
 updateNotifier({ pkg: packageJson }).notify()
 
-const commands = [
-  'generate',
-  'verify',
-  'profile',
-  'help'
-]
+const commands = ['generate', 'verify', 'profile', 'help']
 
-let cmd = process.argv[ 2 ]
+let cmd = process.argv[2]
 
 if (cmd && cmd.length === 1) {
   const mapToCmd = {
@@ -23,7 +25,7 @@ if (cmd && cmd.length === 1) {
     p: 'profile',
     h: 'help'
   }
-  cmd = mapToCmd[ cmd ]
+  cmd = mapToCmd[cmd]
 }
 
 import { warn } from '../lib/utils/logger.js'
@@ -31,8 +33,7 @@ import { warn } from '../lib/utils/logger.js'
 if (cmd) {
   if (commands.includes(cmd)) {
     process.argv.splice(2, 1)
-  }
-  else {
+  } else {
     if (cmd === '-v' || cmd === '--version') {
       console.log(packageJson.version)
       process.exit(0)
@@ -40,22 +41,21 @@ if (cmd) {
 
     if (cmd === '-h' || cmd === '--help') {
       cmd = 'help'
-    }
-    else if (cmd.indexOf('-') === 0) {
+    } else if (cmd.indexOf('-') === 0) {
       warn()
       warn(`Command must come before the options`)
       cmd = 'help'
-    }
-    else {
+    } else {
       warn()
-      warn(`Unknown command specified: "${ cmd }"`)
+      warn(`Unknown command specified: "${cmd}"`)
       cmd = 'help'
     }
   }
-}
-else {
+} else {
   cmd = 'help'
 }
 
-console.log()
-import(`../lib/cmd/${ cmd }.js`)
+const { showCliBanner } = await import('@quasar/art')
+showCliBanner()
+
+import(`../lib/cmd/${cmd}.js`)

package/lib/cmd/generate.js

@@ -1,34 +1,26 @@
-
-import parseArgs from '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'
-  ]
+import { getArgv } from '../utils/get-argv.js'
+
+const argv = getArgv({
+  profile: { type: 'string', short: 'p' },
+  icon: { type: 'string', short: 'i' },
+  background: { type: 'string', short: 'b' },
+  mode: { type: 'string', short: 'm' },
+  filter: { type: 'string', short: 'f' },
+  quality: { type: 'string' },
+  padding: { type: 'string' },
+  'theme-color': { type: 'string' },
+  'png-color': { type: 'string' },
+  'splashscreen-color': { type: 'string' },
+  'splashscreen-icon-ratio': { type: 'string' },
+  'skip-trim': { type: 'boolean' },
+  'no-color': { type: 'boolean' },
+  help: { type: 'boolean', short: 'h' }
 })
 
 // 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' ]
+if (!process.argv.includes('--skip-trim')) {
+  delete argv.skipTrim
 }
 
 import { green } from 'kolorist'
@@ -67,7 +59,7 @@ if (argv.help) {
     $ icongenie generate -p ./folder-containing-profile-files
 
   Options
-    --icon, -i            ${ green('Required') };
+    --icon, -i            ${green('Required')};
                           Path to source file for icon; must be:
                             - a .png file
                             - min resolution: 64x64 px (the higher the better!!)
@@ -91,15 +83,15 @@ if (argv.help) {
 
     --mode, -m            For which Quasar mode(s) to generate the assets;
                           Default: all
-                            [all|${ modesList }]
+                            [all|${modesList}]
                           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
-                            [${ generatorsList }]
+                            [${generatorsList}]
 
-    --quality             Quality of the files [1 - 12] (default: ${ defaultParams.quality })
+    --quality             Quality of the files [1 - 12] (default: ${defaultParams.quality})
                             - higher quality --> bigger filesize & slower to create
                             - lower quality  --> smaller filesize & faster to create
 
@@ -118,7 +110,7 @@ if (argv.help) {
                           Examples: 1976D2, eee
 
     --svg-color           Color to use for the generated monochrome svgs
-                          Default (if no theme-color is specified): ${ defaultParams.svgColor.slice(1) }
+                          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
@@ -126,13 +118,13 @@ if (argv.help) {
     --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) }
+                          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) }
+                          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
@@ -141,7 +133,7 @@ if (argv.help) {
                                (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 }
+                               Default: ${defaultParams.splashscreenIconRatio}
 
     --profile, -p         Use JSON profile file(s):
                             - path to folder (absolute or relative to current folder)
@@ -157,8 +149,11 @@ if (argv.help) {
                               "assets": [ /* list of custom assets */ ]
                             }
 
+    --no-color            Disable colored output
     --help, -h            Displays this message
   `)
+
+  argv.__warn?.()
   process.exit(0)
 }
 
@@ -168,13 +163,13 @@ import { getProfileFiles } from '../utils/get-profile-files.js'
 import { filterArgvParams } from '../utils/filter-argv-params.js'
 import { log } from '../utils/logger.js'
 
-async function runProfiles (params, profileFiles) {
+async function runProfiles(params, profileFiles) {
   for (let i = 0; i < profileFiles.length; i++) {
-    const profile = profileFiles[ i ]
+    const profile = profileFiles[i]
 
     console.log(`\n`)
     log(`---------------------`)
-    log(`Generating by profile: ${ profile }`)
+    log(`Generating by profile: ${profile}`)
     log(`---------------------`)
     console.log(`\n`)
 
@@ -185,9 +180,9 @@ async function runProfiles (params, profileFiles) {
 const params = filterArgvParams(argv)
 
 if (params.profile) {
-  parseArgv(params, [ 'profile' ])
+  parseArgv(params, ['profile'])
+  // oxlint-disable-next-line unicorn/prefer-top-level-await
   runProfiles(params, getProfileFiles(params.profile))
-}
-else {
+} else {
   generate(params)
 }

package/lib/cmd/help.js

@@ -1,4 +1,3 @@
-
 import { packageJson } from '../utils/package-json.js'
 
 console.log('  Running @quasar/icongenie v' + packageJson.version)
@@ -13,6 +12,7 @@ console.log(`
 
   Options
     --version, -v Print Quasar Icon Genie CLI version
+    --no-color    Disable colored output
 
   Commands
     generate, g   Generate App icons & splashscreens

package/lib/cmd/profile.js

@@ -1,28 +1,22 @@
-
-import parseArgs from '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'
-  ]
+import { getArgv } from '../utils/get-argv.js'
+
+const argv = getArgv({
+  output: { type: 'string', short: 'o' },
+  assets: { type: 'string', short: 'a' },
+  icon: { type: 'string', short: 'i' },
+  background: { type: 'string', short: 'b' },
+  include: { type: 'string' },
+  filter: { type: 'string', short: 'f' },
+  quality: { type: 'string' },
+  padding: { type: 'string' },
+  'theme-color': { type: 'string' },
+  'png-color': { type: 'string' },
+  'splashscreen-color': { type: 'string' },
+  'splashscreen-icon-ratio': { type: 'string' },
+  'skip-trim': { type: 'boolean' },
+
+  'no-color': { type: 'boolean' },
+  help: { type: 'boolean', short: 'h' }
 })
 
 if (argv.help) {
@@ -52,7 +46,7 @@ if (argv.help) {
 
     --assets, -a          Prefill the assets Array with Icon Genie's
                           internal list, based on the modes that you indicate;
-                            [all|${ modesList }]
+                            [all|${modesList}]
                           Multiple can be specified, separated by ",":
                             spa,cordova
 
@@ -78,15 +72,15 @@ if (argv.help) {
                           Recommended min size: 1024x1024 px
 
     --include             Prefill the params.include property;
-                            [all|${ modesList }]
+                            [all|${modesList}]
                           Multiple can be specified, separated by ",":
                             spa,cordova
 
     --filter, -f          Prefill the params.filter property;
-                            [${ generatorsList }]
+                            [${generatorsList}]
 
     --quality             Prefill in the params.quality property;
-                          Quality of the files [1 - 12] (default: ${ defaultParams.quality })
+                          Quality of the files [1 - 12] (default: ${defaultParams.quality})
                             - higher quality --> bigger filesize & slower to create
                             - lower quality  --> smaller filesize & faster to create
 
@@ -107,7 +101,7 @@ if (argv.help) {
 
     --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) }
+                          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
@@ -116,14 +110,14 @@ if (argv.help) {
                           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) }
+                          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) }
+                          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
@@ -133,8 +127,14 @@ if (argv.help) {
                                (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 }
+                               Default: ${defaultParams.splashscreenIconRatio}
+
+    --no-color            Disable colored output
+    --help, -h            Displays this message
+
   `)
+
+  argv.__warn?.()
   process.exit(0)
 }
 
@@ -142,11 +142,7 @@ import { profile } from '../runner/profile.js'
 import { filterArgvParams } from '../utils/filter-argv-params.js'
 import { parseArgv } from '../utils/parse-argv.js'
 
-parseArgv(argv, [
-  'output',
-  'assets',
-  'padding'
-])
+parseArgv(argv, ['output', 'assets', 'padding'])
 
 const params = filterArgvParams(argv)
 

package/lib/cmd/verify.js

@@ -1,14 +1,12 @@
+import { getArgv } from '../utils/get-argv.js'
 
-import parseArgs from 'minimist'
+const argv = getArgv({
+  mode: { type: 'string', short: 'm' },
+  profile: { type: 'string', short: 'p' },
+  filter: { type: 'string', short: 'f' },
 
-const argv = parseArgs(process.argv.slice(2), {
-  alias: {
-    m: 'mode',
-    p: 'profile',
-    f: 'filter',
-    h: 'help'
-  },
-  boolean: [ 'h' ]
+  'no-color': { type: 'boolean' },
+  help: { type: 'boolean', short: 'h' }
 })
 
 if (argv.help) {
@@ -44,13 +42,13 @@ if (argv.help) {
   Options
     --mode, -m      For which Quasar mode(s) to verify the assets;
                     Default: all
-                      [all|${ modesList }]
+                      [all|${modesList}]
                     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
-                      [${ generatorsList }]
+                      [${generatorsList}]
 
     --profile       Use JSON profile file(s) to extract the asset list to verify:
                       - path to folder (absolute or relative to current folder)
@@ -66,8 +64,11 @@ if (argv.help) {
                         "assets": [ /* list of custom assets */ ]
                       }
 
+    --no-color      Disable colored output
     --help, -h      Displays this message
   `)
+
+  argv.__warn?.()
   process.exit(0)
 }
 
@@ -77,13 +78,13 @@ import { getProfileFiles } from '../utils/get-profile-files.js'
 import { filterArgvParams } from '../utils/filter-argv-params.js'
 import { log } from '../utils/logger.js'
 
-async function runProfiles (params, profileFiles) {
+async function runProfiles(params, profileFiles) {
   for (let i = 0; i < profileFiles.length; i++) {
-    const profile = profileFiles[ i ]
+    const profile = profileFiles[i]
 
     console.log(`\n`)
     log(`--------------------`)
-    log(`Verifying by profile: ${ profile }`)
+    log(`Verifying by profile: ${profile}`)
     log(`--------------------`)
     console.log(`\n`)
 
@@ -94,9 +95,9 @@ async function runProfiles (params, profileFiles) {
 const params = filterArgvParams(argv)
 
 if (params.profile) {
-  parseArgv(params, [ 'profile' ])
+  parseArgv(params, ['profile'])
+  // oxlint-disable-next-line unicorn/prefer-top-level-await
   runProfiles(params, getProfileFiles(params.profile))
-}
-else {
+} else {
   verify(params)
 }

package/lib/generators/icns.js

@@ -1,10 +1,9 @@
-
 import { writeFile } from 'node:fs'
 import png2icons from 'png2icons'
 
 import { getSquareIcon } from '../utils/get-square-icon.js'
 
-export default async function (file, opts, done) {
+export default async function icns(file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,
@@ -13,7 +12,12 @@ export default async function (file, opts, done) {
   })
 
   const buffer = await img.toBuffer()
-  const output = await png2icons.createICNS(buffer, opts.compression.ico, 0, true)
+  const output = await png2icons.createICNS(
+    buffer,
+    opts.compression.ico,
+    0,
+    true
+  )
 
   writeFile(file.absoluteName, output, done)
 }

package/lib/generators/ico.js

@@ -1,10 +1,9 @@
-
 import { writeFile } from 'node:fs'
 import png2icons from 'png2icons'
 
 import { getSquareIcon } from '../utils/get-square-icon.js'
 
-export default async function (file, opts, done) {
+export default async function ico(file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,
@@ -13,7 +12,12 @@ export default async function (file, opts, done) {
   })
 
   const buffer = await img.toBuffer()
-  const output = await png2icons.createICO(buffer, opts.compression.ico, 0, true)
+  const output = await png2icons.createICO(
+    buffer,
+    opts.compression.ico,
+    0,
+    true
+  )
 
   writeFile(file.absoluteName, output, done)
 }

package/lib/generators/index.js

@@ -1,4 +1,3 @@
-
 import png from './png.js'
 import ico from './ico.js'
 import icns from './icns.js'

package/lib/generators/png.js

@@ -1,15 +1,15 @@
-
 import { getSquareIcon } from '../utils/get-square-icon.js'
 
-export default function (file, opts, done) {
+export default function png(file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,
     size: file.height,
     padding: opts.padding,
-    background: file.background === true
-      ? opts.pngColor
-      : { r: 255, g: 255, b: 255, alpha: 0 }
+    background:
+      file.background === true
+        ? opts.pngColor
+        : { r: 255, g: 255, b: 255, alpha: 0 }
   })
 
   if (file.background === true) {
@@ -18,7 +18,8 @@ export default function (file, opts, done) {
     })
   }
 
-  img.png()
+  img
+    .png()
     .toFile(file.absoluteName)
     .then(() => opts.compression.png(file.absoluteName))
     .then(done)

package/lib/generators/splashscreen.js

@@ -1,29 +1,23 @@
-
 import { getSquareIcon } from '../utils/get-square-icon.js'
 
-export default async function (file, opts, done) {
+export default async function splashscreen(file, opts, done) {
   const size = Math.min(file.width, file.height)
 
-  const img = opts.background
-    .clone()
-    .resize(file.width, file.height)
-    .flatten({
-      background: opts.splashscreenColor
-    })
+  const img = opts.background.clone().resize(file.width, file.height).flatten({
+    background: opts.splashscreenColor
+  })
 
   if (opts.splashscreenIconRatio > 0) {
     const icon = getSquareIcon({
       file,
       icon: opts.icon,
-      size: Math.round(size * opts.splashscreenIconRatio / 100),
+      size: Math.round((size * opts.splashscreenIconRatio) / 100),
       padding: opts.padding
     })
 
     const buffer = await icon.toBuffer()
 
-    img.composite([
-      { input: buffer }
-    ])
+    img.composite([{ input: buffer }])
   }
 
   img

package/lib/generators/svg.js

@@ -1,11 +1,10 @@
-
 import { optimize } from 'svgo'
 import { writeFile } from 'node:fs'
 import { posterize } from 'potrace'
 
 import { getSquareIcon } from '../utils/get-square-icon.js'
 
-export default async function (file, opts, done) {
+export default async function svg(file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,
@@ -21,8 +20,8 @@ export default async function (file, opts, done) {
 
   const buffer = await img.toBuffer()
 
-  posterize(buffer, params, (_, svg) => {
-    const res = optimize(svg)
+  posterize(buffer, params, (_, svgToOptimize) => {
+    const res = optimize(svgToOptimize)
     writeFile(file.absoluteName, res.data, done)
   })
 }

package/lib/modes/index.js

@@ -1,9 +1,2 @@
-
-import { existsSync } from 'node:fs'
-import { resolveDir } from '../utils/app-paths.js'
-
-const { modes } = existsSync(resolveDir('public'))
-  ? await import('./quasar-app-v2/index.js')
-  : await import('./quasar-app-v1/index.js')
-
+const { modes } = await import('./v2/index.js')
 export { modes }

package/lib/modes/{quasar-app-v2 → v2}/bex.js

@@ -1,9 +1,8 @@
-
 export default [
   {
     generator: 'png',
     name: 'icon-{size}x{size}.png',
     folder: 'src-bex/icons',
-    sizes: [ 16, 48, 128 ]
+    sizes: [16, 48, 128]
   }
 ]