@quasar/icongenie 2.5.4 → 3.0.0

package/lib/utils/node-version-check.js

@@ -1,13 +1,13 @@
 // version-check
 
 const version = process.version.split('.')
-const major = parseInt(version[0].replace(/\D/g, ''), 10)
-const minor = parseInt(version[1].replace(/\D/g,''), 10)
-const patch = parseInt(version[2].replace(/\D/g,''), 10)
+const major = parseInt(version[ 0 ].replace(/\D/g, ''), 10)
+const minor = parseInt(version[ 1 ].replace(/\D/g,''), 10)
+const patch = parseInt(version[ 2 ].replace(/\D/g,''), 10)
 
 const min = {
-  major: 10,
-  minor: 0,
+  major: 14,
+  minor: 19,
   patch: 0
 }
 
@@ -21,7 +21,7 @@ if (
   console.error()
   console.error('--------------------------------------------------------')
   console.error(' INCOMPATIBLE NODE VERSION')
-  console.error(` @quasar/icongenie requires Node ${min.major}.${min.minor}.${min.patch} or superior`)
+  console.error(` @quasar/icongenie requires Node ${ min.major }.${ min.minor }.${ min.patch } or superior`)
   console.error()
   console.error(' You are running Node ' + process.version)
   console.error(' Please install a compatible Node version and try again')

package/lib/utils/package-json.js

@@ -0,0 +1,6 @@
+
+import { readFileSync } from 'node:fs'
+
+export const packageJson = JSON.parse(
+  readFileSync(new URL('../../package.json', import.meta.url), 'utf-8')
+)

package/lib/utils/parse-argv.js

@@ -1,11 +1,16 @@
-const { existsSync, lstatSync } = require('fs')
-const { resolve, normalize, join, isAbsolute } = require('path')
-const untildify = require('untildify')
 
-const getPngSize = require('./get-png-size')
-const { warn } = require('./logger')
-const generators = require('../generators')
-const defaultParams = require('./default-params')
+import { existsSync, lstatSync } from 'node:fs'
+import { resolve, normalize, isAbsolute } from 'node:path'
+import untildify from 'untildify'
+
+import { getPngSize } from './get-png-size.js'
+import { warn } from './logger.js'
+import { generators } from '../generators/index.js'
+import { defaultParams } from './default-params.js'
+import { appDir } from './app-paths.js'
+import { modes } from '../modes/index.js'
+
+const modesList = Object.keys(modes)
 
 function die (msg) {
   warn(msg)
@@ -25,32 +30,30 @@ function profile (value, argv) {
   }
 
   if (
-    !value.endsWith('.json') &&
-    !lstatSync(profilePath).isDirectory()
+    !value.endsWith('.json')
+    && !lstatSync(profilePath).isDirectory()
   ) {
-    die(`Specified profile (${value}) is not a .json file`)
+    die(`Specified profile (${ value }) is not a .json file`)
   }
 
   argv.profile = profilePath
 }
 
 function mode (value, argv) {
-  const possibleValues = Object.keys(require('../modes'))
-
   if (!value) {
-    argv.mode = possibleValues
+    argv.mode = modesList
     return
   }
 
   const list = value.split(',')
 
   if (list.includes('all')) {
-    argv.mode = possibleValues
+    argv.mode = modesList
     return
   }
 
-  if (list.some(mode => !possibleValues.includes(mode))) {
-    die(`Invalid mode requested: "${value}"`)
+  if (list.some(mode => !modesList.includes(mode))) {
+    die(`Invalid mode requested: "${ value }"`)
   }
 
   argv.mode = list
@@ -61,15 +64,13 @@ function include (value, argv) {
     return
   }
 
-  const possibleValues = Object.keys(require('../modes'))
-
   if (value.includes('all')) {
-    argv.include = possibleValues
+    argv.include = modesList
     return
   }
 
-  if (value.some(mode => !possibleValues.includes(mode))) {
-    die(`Invalid include requested: "${value}"`)
+  if (value.some(mode => !modesList.includes(mode))) {
+    die(`Invalid include requested: "${ value }"`)
   }
 }
 
@@ -85,7 +86,7 @@ function quality (value, argv) {
     die(`Invalid quality level number specified`)
   }
   if (numeric < 1 || numeric > 12) {
-    die(`Invalid quality level specified (${value}) - should be between 1 - 12`)
+    die(`Invalid quality level specified (${ value }) - should be between 1 - 12`)
   }
 
   argv.quality = numeric
@@ -93,7 +94,7 @@ function quality (value, argv) {
 
 function filter (value) {
   if (value && !Object.keys(generators).includes(value)) {
-    die(`Unknown filter value specified (${value}); there is no such generator`)
+    die(`Unknown filter value specified (${ value }); there is no such generator`)
   }
 }
 
@@ -120,7 +121,7 @@ function padding (value, argv) {
   })
 
   argv.padding = sizes.length === 1
-    ? [ sizes[0], sizes[0] ]
+    ? [ sizes[ 0 ], sizes[ 0 ] ]
     : sizes
 }
 
@@ -139,7 +140,6 @@ function parseIconPath (value) {
     return icon
   }
 
-  const { appDir } = require('./app-paths')
   icon = resolve(appDir, __path)
 
   return existsSync(icon) ? icon : null
@@ -148,14 +148,16 @@ function parseIconPath (value) {
 function icon (value, argv) {
   if (!value) {
     warn(`No source icon file specified, so using the sample one`)
-    argv.icon = normalize(join(__dirname, '../../samples/icongenie-icon.png'))
+    argv.icon = normalize(
+      new URL('../../samples/icongenie-icon.png', import.meta.url).pathname
+    )
     return
   }
 
   argv.icon = parseIconPath(value)
 
   if (!argv.icon) {
-    die(`Path to source icon file does not exists: "${value}"`)
+    die(`Path to source icon file does not exists: "${ value }"`)
   }
 
   const { width, height } = getPngSize(argv.icon)
@@ -174,12 +176,10 @@ function background (value, argv) {
     return
   }
 
-  const { appDir } = require('./app-paths')
-
   argv.background = resolve(appDir, untildify(value))
 
   if (!existsSync(argv.background)) {
-    die(`Path to background source file does not exists: "${value}"`)
+    die(`Path to background source file does not exists: "${ value }"`)
   }
 
   const { width, height } = getPngSize(argv.background)
@@ -196,18 +196,18 @@ function background (value, argv) {
 function getColorParser (name, defaultValue) {
   return (value, argv) => {
     if (!value) {
-      argv[name] = argv.themeColor || defaultValue
+      argv[ name ] = argv.themeColor || defaultValue
       return
     }
 
     if (
-      (value.length !== 3 && value.length !== 6) ||
-      /^[0-9A-Fa-f]+$/.test(value) !== true
+      (value.length !== 3 && value.length !== 6)
+      || /^[0-9A-Fa-f]+$/.test(value) !== true
     ) {
-      die(`Invalid ${name} color specified: "${value}"`)
+      die(`Invalid ${ name } color specified: "${ value }"`)
     }
 
-    argv[name] = '#' + value
+    argv[ name ] = '#' + value
   }
 }
 
@@ -223,7 +223,7 @@ function splashscreenIconRatio (value, argv) {
     die(`Invalid splashscreen icon ratio number specified`)
   }
   if (numeric < 0 || numeric > 100) {
-    die(`Invalid splashscreen icon ratio specified (${value}) - should be between 0 - 100`)
+    die(`Invalid splashscreen icon ratio specified (${ value }) - should be between 0 - 100`)
   }
 
   argv.splashscreenIconRatio = numeric
@@ -236,8 +236,6 @@ function output (value) {
 }
 
 function assets (value, argv) {
-  const possibleValues = Object.keys(require('../modes'))
-
   if (!value) {
     argv.assets = []
     return
@@ -246,12 +244,12 @@ function assets (value, argv) {
   const list = value.split(',')
 
   if (list.includes('all')) {
-    argv.assets = possibleValues
+    argv.assets = modesList
     return
   }
 
-  if (list.some(mode => !possibleValues.includes(mode))) {
-    die(`Invalid assets requested: "${value}"`)
+  if (list.some(mode => !modesList.includes(mode))) {
+    die(`Invalid assets requested: "${ value }"`)
   }
 
   argv.assets = list
@@ -278,13 +276,13 @@ const parsers = {
   assets // profile cmd
 }
 
-module.exports = function (argv, list) {
+export function parseArgv (argv, list) {
   list.forEach(name => {
-    const fn = parsers[name]
+    const fn = parsers[ name ]
     if (fn === void 0) {
-      die(`Invalid command parameter specified (${name})`)
+      die(`Invalid command parameter specified (${ name })`)
     }
 
-    fn(argv[name], argv)
+    fn(argv[ name ], argv)
   })
 }

package/lib/utils/spawn-sync.js

@@ -1,9 +1,10 @@
-const crossSpawn = require('cross-spawn')
 
-const { log, warn } = require('./logger')
+import crossSpawn from 'cross-spawn'
 
-module.exports = function spawnSync (cmd, params, opts, onFail) {
-  log(`[sync] Running "${cmd} ${params.join(' ')}"\n`)
+import { log, warn } from './logger.js'
+
+export function spawnSync (cmd, params, opts, onFail) {
+  log(`[sync] Running "${ cmd } ${ params.join(' ') }"\n`)
 
   const runner = crossSpawn.sync(
     cmd,
@@ -13,7 +14,7 @@ module.exports = function spawnSync (cmd, params, opts, onFail) {
 
   if (runner.status || runner.error) {
     warn()
-    warn(`Command "${cmd}" failed with exit code: ${runner.status}`)
+    warn(`Command "${ cmd }" failed with exit code: ${ runner.status }`)
     onFail && onFail()
   }
 }

package/lib/utils/validate-profile-object.js

@@ -1,8 +1,12 @@
-const Joi = require('@hapi/joi')
-const { red } = require('kolorist')
 
-const generatorsList = Object.keys(require('../generators'))
-const modesList = [ 'all' ].concat(Object.keys(require('../modes')))
+import Joi from '@hapi/joi'
+import { red } from 'kolorist'
+
+import { generators } from '../generators/index.js'
+import { modes } from '../modes/index.js'
+
+const generatorsList = Object.keys(generators)
+const modesList = [ 'all' ].concat(Object.keys(modes))
 const platformsList = [ 'cordova-ios', 'cordova-android' ]
 
 const baseParamsSchema = {
@@ -58,7 +62,7 @@ const assetsSchema = Joi.array().items({
  * When generating the icon, we're expecting a hash on the color (automatically added to user input via the CLI)
  */
 const getColorParamsSchema = (requireHash) => {
-  const colorPattern = Joi.string().pattern(new RegExp(`^${requireHash ? '#' : ''}[0-9A-Fa-f]{3}([0-9A-Fa-f]{3})?$`))
+  const colorPattern = Joi.string().pattern(new RegExp(`^${ requireHash ? '#' : '' }[0-9A-Fa-f]{3}([0-9A-Fa-f]{3})?$`))
   return {
     themeColor: colorPattern,
     pngColor: colorPattern,
@@ -74,7 +78,7 @@ const getParamsSchema = (isGeneratingProfileFile) => {
   }
 }
 
-module.exports = function validateProfileObject (profileObject, generatingProfileFile = false) {
+export function validateProfileObject (profileObject, generatingProfileFile = false) {
   const profileSchema = Joi.object({
     params: getParamsSchema(generatingProfileFile),
     assets: assetsSchema
@@ -82,8 +86,8 @@ module.exports = function validateProfileObject (profileObject, generatingProfil
 
   const { error } = profileSchema.validate(profileObject)
   if (error) {
-    console.error(` ${red('ERROR')}: Input parameters are not valid. Please correct them.`)
-    console.error(` ${error}`)
+    console.error(` ${ red('ERROR') }: Input parameters are not valid. Please correct them.`)
+    console.error(` ${ error }`)
     console.log()
     process.exit(1)
   }

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "@quasar/icongenie",
-  "version": "2.5.4",
+  "version": "3.0.0",
   "description": "A Quasar tool for generating all your Quasar App's icons and splashscreens",
   "bin": {
-    "icongenie": "./bin/icongenie"
+    "icongenie": "./bin/icongenie.js"
+  },
+  "type": "module",
+  "scripts": {
+    "lint": "eslint --ext .js ./ --fix"
   },
-  "scripts": {},
   "repository": {
     "type": "git",
     "url": "git+https://github.com/quasarframework/quasar.git"
   },
+  "engines": {
+    "node": ">= 14.19.0"
+  },
   "keywords": [
     "vuejs",
     "vue",
@@ -39,23 +45,27 @@
     "@hapi/joi": "^17.1.1",
     "cross-spawn": "^7.0.2",
     "elementtree": "^0.1.7",
-    "fast-glob": "^3.2.11",
-    "fs-extra": "^10.0.1",
-    "imagemin": "^7.0.1",
+    "fast-glob": "^3.2.12",
+    "fs-extra": "^11.1.1",
+    "imagemin": "^8.0.1",
     "imagemin-pngquant": "^9.0.2",
-    "is-png": "^2.0.0",
-    "kolorist": "^1.5.1",
-    "minimist": "^1.2.6",
+    "is-png": "^3.0.1",
+    "kolorist": "^1.8.0",
+    "minimist": "^1.2.8",
     "png2icons": "^2.0.1",
     "potrace": "^2.1.5",
-    "read-chunk": "^3.2.0",
-    "sharp": "^0.30.3",
-    "svgo": "^2.8.0",
+    "read-chunk": "^4.0.3",
+    "sharp": "^0.32.1",
+    "svgo": "^3.0.2",
     "untildify": "^4.0.0",
-    "update-notifier": "^5.1.0"
+    "update-notifier": "^6.0.2"
+  },
+  "devDependencies": {
+    "eslint": "^8.31.0",
+    "eslint-plugin-n": "^15.6.1"
   },
   "resolutions": {
-    "minimist": "^1.2.6"
+    "minimist": "^1.2.8"
   },
   "publishConfig": {
     "access": "public"