@quasar/icongenie 2.5.4 → 3.0.0

package/.eslintignore

@@ -0,0 +1 @@
+samples/

package/.eslintrc.cjs

@@ -0,0 +1,50 @@
+
+module.exports = {
+  root: true,
+
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module'
+  },
+
+  env: {
+    node: true,
+  },
+
+  extends: [
+    'eslint:recommended',
+    'plugin:n/recommended'
+  ],
+
+  rules: {
+    'no-empty': 'off',
+    'no-useless-escape': 'off',
+    'no-unused-vars': [ 'error', { ignoreRestSiblings: true, argsIgnorePattern: '^_' } ],
+
+    'n/no-process-exit': 'off',
+
+    'brace-style': [ 2, 'stroustrup', { allowSingleLine: true } ],
+    'prefer-const': 2,
+    'prefer-promise-reject-errors': 'off',
+    'multiline-ternary': 'off',
+    'no-prototype-builtins': 'off',
+    'no-case-declarations': 'off',
+    'generator-star-spacing': 'off',
+    'arrow-parens': 'off',
+    'object-property-newline': 'off',
+    'one-var': 'off',
+    'no-void': 'off',
+    'no-lone-blocks': 'error',
+    'no-unused-expressions': [ 'error', { allowShortCircuit: true } ],
+    'no-useless-concat': 'error',
+    'no-useless-return': 'error',
+    'no-unneeded-ternary': 'error',
+    'no-confusing-arrow': [ 'error', { allowParens: true } ],
+    'operator-linebreak': [ 'error', 'before' ],
+
+    'array-bracket-spacing': [ 'error', 'always' ],
+    'object-curly-spacing': [ 'error', 'always' ],
+    'computed-property-spacing': [ 'error', 'always' ],
+    'template-curly-spacing': [ 'error', 'always' ]
+  }
+}

package/bin/{icongenie → icongenie.js}

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
-require('../lib/utils/node-version-check')
+import '../lib/utils/node-version-check.js'
 
-const updateNotifier = require('update-notifier')
-const pkg = require('../package.json')
+import updateNotifier from 'update-notifier'
+import { packageJson } from '../lib/utils/package-json.js'
 
-updateNotifier({ pkg }).notify()
+updateNotifier({ pkg: packageJson }).notify()
 
 const commands = [
   'generate',
@@ -14,7 +14,7 @@ const commands = [
   'help'
 ]
 
-let cmd = process.argv[2]
+let cmd = process.argv[ 2 ]
 
 if (cmd && cmd.length === 1) {
   const mapToCmd = {
@@ -23,21 +23,21 @@ if (cmd && cmd.length === 1) {
     p: 'profile',
     h: 'help'
   }
-  cmd = mapToCmd[cmd]
+  cmd = mapToCmd[ cmd ]
 }
 
+import { warn } from '../lib/utils/logger.js'
+
 if (cmd) {
   if (commands.includes(cmd)) {
     process.argv.splice(2, 1)
   }
   else {
     if (cmd === '-v' || cmd === '--version') {
-      console.log(require('../package.json').version)
+      console.log(packageJson.version)
       process.exit(0)
     }
 
-    const { warn } = require('../lib/utils/logger')
-
     if (cmd === '-h' || cmd === '--help') {
       cmd = 'help'
     }
@@ -48,7 +48,7 @@ if (cmd) {
     }
     else {
       warn()
-      warn(`Unknown command specified: "${cmd}"`)
+      warn(`Unknown command specified: "${ cmd }"`)
       cmd = 'help'
     }
   }
@@ -58,4 +58,4 @@ else {
 }
 
 console.log()
-require(`../lib/cmd/${cmd}`)
+import(`../lib/cmd/${ cmd }.js`)

package/lib/cmd/generate.js

@@ -1,5 +1,6 @@
 
-const parseArgs = require('minimist')
+import parseArgs from 'minimist'
+
 const processArgv = process.argv.slice(2)
 
 const argv = parseArgs(processArgv, {
@@ -27,15 +28,19 @@ const argv = parseArgs(processArgv, {
 // 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']
+  delete argv[ 'skip-trim' ]
 }
 
-const { green } = require('kolorist')
+import { green } from 'kolorist'
 
 if (argv.help) {
-  const modes = Object.keys(require('../modes')).join('|')
-  const generators = Object.keys(require('../generators')).join('|')
-  const defaultParams = require('../utils/default-params')
+  const { defaultParams } = await import('../utils/default-params.js')
+
+  const { modes } = await import('../modes/index.js')
+  const modesList = Object.keys(modes).join('|')
+
+  const { generators } = await import('../generators/index.js')
+  const generatorsList = Object.keys(generators).join('|')
 
   console.log(`
   Description
@@ -62,7 +67,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!!)
@@ -86,15 +91,15 @@ if (argv.help) {
 
     --mode, -m            For which Quasar mode(s) to generate the assets;
                           Default: all
-                            [all|${modes}]
+                            [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
-                            [${generators}]
+                            [${ 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
 
@@ -113,7 +118,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
@@ -121,13 +126,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
@@ -136,7 +141,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,19 +162,19 @@ if (argv.help) {
   process.exit(0)
 }
 
-const parseArgv = require('../utils/parse-argv')
-const generate = require('../runner/generate')
-const getProfileFiles = require('../utils/get-profile-files')
-const filterArgvParams = require('../utils/filter-argv-params')
-const { log } = require('../utils/logger')
+import { generate } from '../runner/generate.js'
+import { parseArgv } from '../utils/parse-argv.js'
+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) {
   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`)
 

package/lib/cmd/help.js

@@ -1,5 +1,7 @@
 
-console.log('  Running @quasar/icongenie v' + require('../../package.json').version)
+import { packageJson } from '../utils/package-json.js'
+
+console.log('  Running @quasar/icongenie v' + packageJson.version)
 
 console.log(`
   Example usage

package/lib/cmd/profile.js

@@ -1,5 +1,5 @@
 
-const parseArgs = require('minimist')
+import parseArgs from 'minimist'
 
 const argv = parseArgs(process.argv.slice(2), {
   alias: {
@@ -26,9 +26,13 @@ const argv = parseArgs(process.argv.slice(2), {
 })
 
 if (argv.help) {
-  const modes = Object.keys(require('../modes')).join('|')
-  const generators = Object.keys(require('../generators')).join('|')
-  const defaultParams = require('../utils/default-params')
+  const { defaultParams } = await import('../utils/default-params.js')
+
+  const { modes } = await import('../modes/index.js')
+  const modesList = Object.keys(modes).join('|')
+
+  const { generators } = await import('../generators/index.js')
+  const generatorsList = Object.keys(generators).join('|')
 
   console.log(`
   Description
@@ -48,7 +52,7 @@ if (argv.help) {
 
     --assets, -a          Prefill the assets Array with Icon Genie's
                           internal list, based on the modes that you indicate;
-                            [all|${modes}]
+                            [all|${ modesList }]
                           Multiple can be specified, separated by ",":
                             spa,cordova
 
@@ -74,15 +78,15 @@ if (argv.help) {
                           Recommended min size: 1024x1024 px
 
     --include             Prefill the params.include property;
-                            [all|${modes}]
+                            [all|${ modesList }]
                           Multiple can be specified, separated by ",":
                             spa,cordova
 
     --filter, -f          Prefill the params.filter property;
-                            [${generators}]
+                            [${ 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
 
@@ -103,7 +107,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
@@ -112,14 +116,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
@@ -129,14 +133,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 }
   `)
   process.exit(0)
 }
 
-const profile = require('../runner/profile')
-const filterArgvParams = require('../utils/filter-argv-params')
-const parseArgv = require('../utils/parse-argv')
+import { profile } from '../runner/profile.js'
+import { filterArgvParams } from '../utils/filter-argv-params.js'
+import { parseArgv } from '../utils/parse-argv.js'
 
 parseArgv(argv, [
   'output',

package/lib/cmd/verify.js

@@ -1,5 +1,5 @@
 
-const parseArgs = require('minimist')
+import parseArgs from 'minimist'
 
 const argv = parseArgs(process.argv.slice(2), {
   alias: {
@@ -8,12 +8,15 @@ const argv = parseArgs(process.argv.slice(2), {
     f: 'filter',
     h: 'help'
   },
-  boolean: ['h']
+  boolean: [ 'h' ]
 })
 
 if (argv.help) {
-  const modes = Object.keys(require('../modes')).join('|')
-  const generators = Object.keys(require('../generators')).join('|')
+  const { modes } = await import('../modes/index.js')
+  const modesList = Object.keys(modes).join('|')
+
+  const { generators } = await import('../generators/index.js')
+  const generatorsList = Object.keys(generators).join('|')
 
   console.log(`
   Description
@@ -41,13 +44,13 @@ if (argv.help) {
   Options
     --mode, -m      For which Quasar mode(s) to verify the assets;
                     Default: all
-                      [all|${modes}]
+                      [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
-                      [${generators}]
+                      [${ generatorsList }]
 
     --profile       Use JSON profile file(s) to extract the asset list to verify:
                       - path to folder (absolute or relative to current folder)
@@ -68,19 +71,19 @@ if (argv.help) {
   process.exit(0)
 }
 
-const parseArgv = require('../utils/parse-argv')
-const verify = require('../runner/verify')
-const getProfileFiles = require('../utils/get-profile-files')
-const filterArgvParams = require('../utils/filter-argv-params')
-const { log } = require('../utils/logger')
+import { parseArgv } from '../utils/parse-argv.js'
+import { verify } from '../runner/verify.js'
+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) {
   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`)
 

package/lib/generators/icns.js

@@ -1,9 +1,10 @@
-const { writeFile } = require('fs')
-const png2icons = require('png2icons')
 
-const getSquareIcon = require('../utils/get-square-icon')
+import { writeFile } from 'node:fs'
+import png2icons from 'png2icons'
 
-module.exports = async function (file, opts, done) {
+import { getSquareIcon } from '../utils/get-square-icon.js'
+
+export default async function (file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,

package/lib/generators/ico.js

@@ -1,9 +1,10 @@
-const { writeFile } = require('fs')
-const png2icons = require('png2icons')
 
-const getSquareIcon = require('../utils/get-square-icon')
+import { writeFile } from 'node:fs'
+import png2icons from 'png2icons'
 
-module.exports = async function (file, opts, done) {
+import { getSquareIcon } from '../utils/get-square-icon.js'
+
+export default async function (file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,

package/lib/generators/index.js

@@ -1,7 +1,14 @@
-module.exports = {
-  png: require('./png'),
-  ico: require('./ico'),
-  icns: require('./icns'),
-  splashscreen: require('./splashscreen'),
-  svg: require('./svg')
+
+import png from './png.js'
+import ico from './ico.js'
+import icns from './icns.js'
+import splashscreen from './splashscreen.js'
+import svg from './svg.js'
+
+export const generators = {
+  png,
+  ico,
+  icns,
+  splashscreen,
+  svg
 }

package/lib/generators/png.js

@@ -1,6 +1,7 @@
-const getSquareIcon = require('../utils/get-square-icon')
 
-module.exports = function (file, opts, done) {
+import { getSquareIcon } from '../utils/get-square-icon.js'
+
+export default function (file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,

package/lib/generators/splashscreen.js

@@ -1,6 +1,7 @@
-const getSquareIcon = require('../utils/get-square-icon')
 
-module.exports = async function (file, opts, done) {
+import { getSquareIcon } from '../utils/get-square-icon.js'
+
+export default async function (file, opts, done) {
   const size = Math.min(file.width, file.height)
 
   const img = opts.background

package/lib/generators/svg.js

@@ -1,10 +1,11 @@
-const { optimize } = require('svgo')
-const { writeFile } = require('fs')
-const { posterize } = require('potrace')
 
-const getSquareIcon = require('../utils/get-square-icon')
+import { optimize } from 'svgo'
+import { writeFile } from 'node:fs'
+import { posterize } from 'potrace'
 
-module.exports = async function (file, opts, done) {
+import { getSquareIcon } from '../utils/get-square-icon.js'
+
+export default async function (file, opts, done) {
   const img = getSquareIcon({
     file,
     icon: opts.icon,

package/lib/modes/index.js

@@ -1,6 +1,9 @@
-const { existsSync } = require('fs')
-const { resolveDir } = require('../utils/app-paths')
 
-module.exports = existsSync(resolveDir('public'))
-  ? require('./quasar-app-v2')
-  : require('./quasar-app-v1')
+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')
+
+export { modes }

package/lib/modes/quasar-app-v1/bex.js

@@ -1,4 +1,5 @@
-module.exports = [
+
+export default [
   {
     generator: 'png',
     name: 'icon-{size}x{size}.png',

package/lib/modes/quasar-app-v1/capacitor.js

@@ -1,3 +1,4 @@
+
 const iosIconRegex = /AppIcon-(\d+\.?\d?)x?(\d+\.?\d?)?@?(\d+)?x?-?\d?\.png/
 
 function getAndroidIcons (entries) {
@@ -6,25 +7,25 @@ function getAndroidIcons (entries) {
   entries.forEach(entry => {
     const icon = {
       generator: 'png',
-      folder: `src-capacitor/android/app/src/main/res/mipmap-${entry[0]}`
+      folder: `src-capacitor/android/app/src/main/res/mipmap-${ entry[ 0 ] }`
     }
 
     list.push({
       ...icon,
       name: 'ic_launcher_foreground.png',
-      sizes: [ entry[2] ]
+      sizes: [ entry[ 2 ] ]
     })
 
     list.push({
       ...icon,
       name: 'ic_launcher_round.png',
-      sizes: [ entry[1] ]
+      sizes: [ entry[ 1 ] ]
     })
 
     list.push({
       ...icon,
       name: 'ic_launcher.png',
-      sizes: [ entry[1] ]
+      sizes: [ entry[ 1 ] ]
     })
   })
 
@@ -42,17 +43,17 @@ function getAndroidSplashscreen (entries) {
 
     list.push({
       ...icon,
-      folder: `src-capacitor/android/app/src/main/res/drawable-land-${entry[0]}`,
+      folder: `src-capacitor/android/app/src/main/res/drawable-land-${ entry[ 0 ] }`,
       sizes: [
-        [ entry[1], entry[2] ]
+        [ entry[ 1 ], entry[ 2 ] ]
       ]
     })
 
     list.push({
       ...icon,
-      folder: `src-capacitor/android/app/src/main/res/drawable-port-${entry[0]}`,
+      folder: `src-capacitor/android/app/src/main/res/drawable-port-${ entry[ 0 ] }`,
       sizes: [
-        [ entry[2], entry[1] ]
+        [ entry[ 2 ], entry[ 1 ] ]
       ]
     })
   })
@@ -61,7 +62,7 @@ function getAndroidSplashscreen (entries) {
 }
 
 function getIosIcon (name) {
-  const [,size,,multiplier] = name.match(iosIconRegex)
+  const [ ,size,,multiplier ] = name.match(iosIconRegex)
 
   return {
     generator: 'png',
@@ -76,7 +77,7 @@ function getIosIcon (name) {
   }
 }
 
-module.exports = [
+export default [
   /***************
    *** Android ***
    ***************/