@quasar/icongenie 2.5.3 → 3.0.0

package/lib/runner/generate.js

@@ -1,37 +1,38 @@
-const { existsSync } = require('fs')
-const { ensureFileSync } = require('fs-extra')
-const { green, gray } = require('kolorist')
 
-const { appDir, resolveDir } = require('../utils/app-paths')
-const { log, warn } = require('../utils/logger')
+import { existsSync } from 'node:fs'
+import { ensureFileSync } from 'fs-extra'
+import { green, gray } from 'kolorist'
 
-const modes = require('../modes')
-const generators = require('../generators')
-const { mount } = require('../mount')
+import { appDir, resolveDir } from '../utils/app-paths.js'
+import { log, warn } from '../utils/logger.js'
 
-const getAssetsFiles = require('../utils/get-assets-files')
-const getFilesOptions = require('../utils/get-files-options')
-const parseArgv = require('../utils/parse-argv')
-const mergeObjects = require('../utils/merge-objects')
-const getProfileContent = require('../utils/get-profile-content')
-const getFileSize = require('../utils/get-file-size')
-const validateProfileObject = require('../utils/validate-profile-object')
+import { modes } from '../modes/index.js'
+import { generators } from '../generators/index.js'
+import { mount } from '../mount/index.js'
+
+import { getAssetsFiles } from '../utils/get-assets-files.js'
+import { getFilesOptions } from '../utils/get-files-options.js'
+import { parseArgv } from '../utils/parse-argv.js'
+import { mergeObjects } from '../utils/merge-objects.js'
+import { getProfileContent } from '../utils/get-profile-content.js'
+import { getFileSize } from '../utils/get-file-size.js'
+import { validateProfileObject } from '../utils/validate-profile-object.js'
 
 function printBanner (assetsOf, params) {
   console.log(` Generating files with the following options:
  ==========================
- Quasar project folder..... ${green(appDir)}
- ${green(`Quality level............. ${params.quality}/12`)}
- Icon source file.......... ${green(params.icon)}
- Icon trimming............. ${params.skipTrim ? 'no' : green('yes')}
- Icon padding.............. ${green(`horizontal: ${params.padding[0]}; vertical: ${params.padding[1]}`)}
- Background source file.... ${params.background ? green(params.background) : 'none'}
- Assets of................. ${green(assetsOf)}
- Generator filter.......... ${params.filter ? green(params.filter) : 'none'}
- Svg color................. ${green(params.svgColor)}
- Png color................. ${green(params.pngColor)}
- Splashscreen color........ ${green(params.splashscreenColor)}
- Splashscreen icon ratio... ${green(params.splashscreenIconRatio)}%
+ Quasar project folder..... ${ green(appDir) }
+ ${ green(`Quality level............. ${ params.quality }/12`) }
+ Icon source file.......... ${ green(params.icon) }
+ Icon trimming............. ${ params.skipTrim ? 'no' : green('yes') }
+ Icon padding.............. ${ green(`horizontal: ${ params.padding[ 0 ] }; vertical: ${ params.padding[ 1 ] }`) }
+ Background source file.... ${ params.background ? green(params.background) : 'none' }
+ Assets of................. ${ green(assetsOf) }
+ Generator filter.......... ${ params.filter ? green(params.filter) : 'none' }
+ Svg color................. ${ green(params.svgColor) }
+ Png color................. ${ green(params.pngColor) }
+ Splashscreen color........ ${ green(params.splashscreenColor) }
+ Splashscreen icon ratio... ${ green(params.splashscreenIconRatio) }%
  ==========================
 `)
 }
@@ -42,12 +43,12 @@ function parseAssets (assets, include) {
 
   if (include) {
     const embeddedModes = include.filter(
-      mode => existsSync(resolveDir(modes[mode].folder))
+      mode => existsSync(resolveDir(modes[ mode ].folder))
     )
 
     embeddedModes.forEach(mode => {
       files = files.concat(
-        getAssetsFiles(modes[mode].assets)
+        getAssetsFiles(modes[ mode ].assets)
       )
     })
 
@@ -70,8 +71,8 @@ function getUniqueFiles (files) {
   const uniqueFiles = []
 
   files.forEach(file => {
-    if (filePaths[file.absoluteName] === void 0) {
-      filePaths[file.absoluteName] = true
+    if (filePaths[ file.absoluteName ] === void 0) {
+      filePaths[ file.absoluteName ] = true
       uniqueFiles.push(file)
     }
   })
@@ -85,11 +86,11 @@ function generateFile (file, opts) {
 
   return new Promise(resolve => {
     // use the appropriate generator to handle the file creation
-    generators[file.generator](file, opts, () => {
-      const size = `(${getFileSize(file.absoluteName)})`
+    generators[ file.generator ](file, opts, () => {
+      const size = `(${ getFileSize(file.absoluteName) })`
       const type = (file.generator + ':').padEnd(13, ' ')
 
-      log(`Generated ${type} ${green(file.relativeName)} ${gray(size)}`)
+      log(`Generated ${ type } ${ green(file.relativeName) } ${ gray(size) }`)
       resolve()
     })
   })
@@ -121,7 +122,7 @@ async function generateFromProfile (profile) {
     .then(() => uniqueFiles.length)
 }
 
-module.exports = function generate (argv) {
+export function generate (argv) {
   const profile = {
     params: {},
     assets: []
@@ -166,6 +167,6 @@ module.exports = function generate (argv) {
 
   return generateFromProfile(profile)
     .then(numberOfFiles => {
-      console.log(`\n Task done - generated ${numberOfFiles} file(s)!\n`)
+      console.log(`\n Task done - generated ${ numberOfFiles } file(s)!\n`)
     })
 }

package/lib/runner/profile.js

@@ -1,10 +1,12 @@
-const { resolve, dirname, basename, isAbsolute, relative } = require('path')
-const { writeFileSync } = require('fs')
-const { ensureDir } = require('fs-extra')
 
-const { log } = require('../utils/logger')
-const modes = require('../modes')
-const validateProfileObject = require('../utils/validate-profile-object')
+import { resolve, dirname, basename, isAbsolute, relative } from 'node:path'
+import { writeFileSync } from 'node:fs'
+import { ensureDir } from 'fs-extra'
+
+import { log } from '../utils/logger.js'
+import { modes } from '../modes/index.js'
+import { validateProfileObject } from '../utils/validate-profile-object.js'
+import { appDir } from '../utils/app-paths.js'
 
 function getParams ({ include, ...props }) {
   if (include) {
@@ -18,7 +20,7 @@ function getAssets (assets) {
   let list = []
 
   assets.forEach(name => {
-    list = list.concat(modes[name].assets)
+    list = list.concat(modes[ name ].assets)
   })
 
   return list
@@ -36,11 +38,11 @@ function getTargetFilepath (output) {
     ? ''
     : '.json'
 
-  const filename = `${prefix}${name}${suffix}`
+  const filename = `${ prefix }${ name }${ suffix }`
   return resolve(process.cwd(), folder || '', filename)
 }
 
-module.exports = function profile ({ output, assets, ...params }) {
+export function profile ({ output, assets, ...params }) {
   const profile = {
     params: getParams(params),
     assets: getAssets(assets)
@@ -51,7 +53,6 @@ module.exports = function profile ({ output, assets, ...params }) {
   if (profile.params.icon && isAbsolute(profile.params.icon) === false) {
     // generate icon path relative to app root
     // so it won't matter from where the profile file is run
-    const { appDir } = require('../utils/app-paths')
     profile.params.icon = relative(appDir, profile.params.icon)
   }
 
@@ -65,5 +66,5 @@ module.exports = function profile ({ output, assets, ...params }) {
   writeFileSync(targetFile, JSON.stringify(profile, null, 2), 'utf-8')
 
   console.log(` Generated Icon Genie profile file:`)
-  log(`${targetFile}\n`)
+  log(`${ targetFile }\n`)
 }

package/lib/runner/verify.js

@@ -1,17 +1,18 @@
-const { existsSync } = require('fs')
-const { green, red, underline } = require('kolorist')
 
-const { appDir, resolveDir } = require('../utils/app-paths')
-const { warn } = require('../utils/logger')
+import { existsSync } from 'node:fs'
+import { green, red, underline } from 'kolorist'
 
-const modes = require('../modes')
-const { verifyMount } = require('../mount')
-const getAssetsFiles = require('../utils/get-assets-files')
-const getPngSize = require('../utils/get-png-size')
-const parseArgv = require('../utils/parse-argv')
-const mergeObjects = require('../utils/merge-objects')
-const getProfileContent = require('../utils/get-profile-content')
-const validateProfileObject = require('../utils/validate-profile-object')
+import { appDir, resolveDir } from '../utils/app-paths.js'
+import { warn } from '../utils/logger.js'
+
+import { modes } from '../modes/index.js'
+import { verifyMount } from '../mount/index.js'
+import { getAssetsFiles } from '../utils/get-assets-files.js'
+import { getPngSize } from '../utils/get-png-size.js'
+import { parseArgv } from '../utils/parse-argv.js'
+import { mergeObjects } from '../utils/merge-objects.js'
+import { getProfileContent } from '../utils/get-profile-content.js'
+import { validateProfileObject } from '../utils/validate-profile-object.js'
 
 function getFileStatus (file) {
   if (!existsSync(file.absoluteName)) {
@@ -26,7 +27,7 @@ function getFileStatus (file) {
     }
 
     if (width !== file.width || height !== file.height) {
-      return red(`ERROR: incorrect resolution! ${width}x${height}`)
+      return red(`ERROR: incorrect resolution! ${ width }x${ height }`)
     }
   }
 
@@ -34,10 +35,10 @@ function getFileStatus (file) {
 }
 
 function printMode (modeName, files) {
-  console.log(` ${green(underline(`Mode ${modeName.toUpperCase()}`))} \n`)
+  console.log(` ${ green(underline(`Mode ${ modeName.toUpperCase() }`)) } \n`)
 
   files.forEach(file => {
-    console.log(` ${getFileStatus(file)} - ${(file.generator + ':').padEnd(13, ' ')} ${file.relativeName} ${verifyMount(file)}`)
+    console.log(` ${ getFileStatus(file) } - ${ (file.generator + ':').padEnd(13, ' ') } ${ file.relativeName } ${ verifyMount(file) }`)
   })
 
   console.log()
@@ -46,26 +47,26 @@ function printMode (modeName, files) {
 function printBanner (assetsOf, params) {
   console.log(` VERIFYING with the following options:
  ================
- Root folder..... ${green(appDir)}
- Assets of....... ${green(assetsOf)}
- Assets filter... ${!params.filter ? 'none' : green(params.filter)}
+ Root folder..... ${ green(appDir) }
+ Assets of....... ${ green(assetsOf) }
+ Assets filter... ${ !params.filter ? 'none' : green(params.filter) }
  ================
 `)
 }
 
 function parseAssets (assets, include) {
-  let filesMap = []
+  const filesMap = []
   let assetsOf = []
 
   if (include) {
     const embeddedModes = include.filter(
-      mode => existsSync(resolveDir(modes[mode].folder))
+      mode => existsSync(resolveDir(modes[ mode ].folder))
     )
 
     embeddedModes.forEach(mode => {
       filesMap.push({
         name: mode,
-        files: getAssetsFiles(modes[mode].assets)
+        files: getAssetsFiles(modes[ mode ].assets)
       })
     })
 
@@ -109,7 +110,7 @@ function verifyProfile (profile) {
   })
 }
 
-module.exports = function verify (argv) {
+export function verify (argv) {
   const profile = {
     params: {},
     assets: []

package/lib/utils/app-paths.js

@@ -1,28 +1,28 @@
-const { existsSync } = require('fs')
-const { normalize, join, sep } = require('path')
 
-function getAppDir () {
-  let dir = process.cwd()
+import { existsSync } from 'node:fs'
+import { normalize, join, sep } from 'node:path'
 
-  while (dir.length && dir[dir.length - 1] !== sep) {
+import { fatal } from './logger.js'
+
+function getAppInfo () {
+  let appDir = process.cwd()
+
+  while (appDir.length && appDir[ appDir.length - 1 ] !== sep) {
     if (
-      existsSync(join(dir, 'quasar.conf.js')) ||
-      existsSync(join(dir, 'quasar.config.js'))
+      existsSync(join(appDir, 'quasar.config.js'))
+      || existsSync(join(appDir, 'quasar.config.mjs'))
+      || existsSync(join(appDir, 'quasar.config.ts'))
+      || existsSync(join(appDir, 'quasar.config.cjs'))
+      || existsSync(join(appDir, 'quasar.conf.js')) // legacy
     ) {
-      return dir
+      return appDir
     }
 
-    dir = normalize(join(dir, '..'))
+    appDir = normalize(join(appDir, '..'))
   }
 
-  const { warn } = require('./logger')
-
-  warn(`Error. This command must be executed inside a Quasar v1+ project folder.`)
-  warn()
-  process.exit(1)
+  fatal(`Error. This command must be executed inside a Quasar project folder.`)
 }
 
-const appDir = getAppDir()
-
-module.exports.appDir = appDir
-module.exports.resolveDir = dir => join(appDir, dir)
+export const appDir = getAppInfo()
+export const resolveDir = dir => join(appDir, dir)

package/lib/utils/default-params.js

@@ -1,4 +1,5 @@
-module.exports = {
+
+export const defaultParams = {
   quality: 5,
   splashscreenIconRatio: 40,
 

package/lib/utils/filter-argv-params.js

@@ -1,12 +1,13 @@
-module.exports = function filterArgvParams (argv) {
+
+export function filterArgvParams (argv) {
   const params = {}
 
   Object.keys(argv).forEach(key => {
     if (key.length > 1 && key !== 'help') {
       // kebab to camel case
-      const prop = key.replace(/(-\w)/g, m => m[1].toUpperCase())
+      const prop = key.replace(/(-\w)/g, m => m[ 1 ].toUpperCase())
 
-      params[prop] = argv[key]
+      params[ prop ] = argv[ key ]
     }
   })
 

package/lib/utils/get-assets-files.js

@@ -1,10 +1,11 @@
-const { join } = require('path')
 
-const { appDir } = require('./app-paths')
+import { join } from 'node:path'
+
+import { appDir } from './app-paths.js'
 
 const tagRegex = /\{(.*?)\}/g
 
-module.exports = function getAssetsFiles (assets) {
+export function getAssetsFiles (assets) {
   const list = []
 
   assets.forEach(({ sizes, ...props }) => {
@@ -17,7 +18,7 @@ module.exports = function getAssetsFiles (assets) {
           : [ size, size ]
 
         const replacer = isArray
-          ? `${width}x${height}`
+          ? `${ width }x${ height }`
           : width
 
         list.push({
@@ -41,7 +42,7 @@ module.exports = function getAssetsFiles (assets) {
     }
 
     if (tag) {
-      file.tag = tag.replace(tagRegex, (_, p) => file[p === 'size' ? 'width' : p])
+      file.tag = tag.replace(tagRegex, (_, p) => file[ p === 'size' ? 'width' : p ])
     }
 
     return file

package/lib/utils/get-compression.js

@@ -1,11 +1,11 @@
-const { dirname } = require('path')
 
-const imagemin = require('imagemin')
-const pngquant = require('imagemin-pngquant')
+import { dirname } from 'node:path'
 
-const { BICUBIC2, HERMITE, BEZIER, BICUBIC, BILINEAR, NEAREST_NEIGHBOR } = require('png2icons')
+import imagemin from 'imagemin'
+import pngquant from 'imagemin-pngquant'
+import { BICUBIC2, HERMITE, BEZIER, BICUBIC, BILINEAR, NEAREST_NEIGHBOR } from 'png2icons'
 
-module.exports.getIcoCompression = function getIcoCompression (quality) {
+export function getIcoCompression (quality) {
   switch (quality) {
     case 1:
     case 2:
@@ -28,7 +28,7 @@ module.exports.getIcoCompression = function getIcoCompression (quality) {
   }
 }
 
-module.exports.getPngCompression = function getPngCompression (quality) {
+export function getPngCompression (quality) {
   if (quality === 12) {
     return () => {}
   }

package/lib/utils/get-file-size.js

@@ -1,6 +1,7 @@
-const { statSync } = require('fs')
 
-const units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']
+import { statSync } from 'node:fs'
+
+const units = [ 'B', 'KB', 'MB', 'GB', 'TB', 'PB' ]
 
 function humanStorageSize (bytes) {
   let u = 0
@@ -10,9 +11,9 @@ function humanStorageSize (bytes) {
     ++u
   }
 
-  return `${bytes.toFixed(1)}${units[u]}`
+  return `${ bytes.toFixed(1) }${ units[ u ] }`
 }
 
-module.exports = function getFileSize (filename) {
+export function getFileSize (filename) {
   return humanStorageSize(statSync(filename).size)
 }

package/lib/utils/get-files-options.js

@@ -1,12 +1,13 @@
-const sharp = require('sharp')
 
-const { getPngCompression, getIcoCompression } = require('./get-compression')
+import sharp from 'sharp'
+
+import { getPngCompression, getIcoCompression } from './get-compression.js'
 
 function getRgbColor (color) {
   let hex = color.replace(/^#/, '')
 
   if (hex.length === 3) {
-    hex = hex[0] + hex[0] + hex[1] + hex[1] + hex[2] + hex[2]
+    hex = hex[ 0 ] + hex[ 0 ] + hex[ 1 ] + hex[ 1 ] + hex[ 2 ] + hex[ 2 ]
   }
 
   const num = parseInt(hex, 16)
@@ -19,7 +20,7 @@ function getRgbColor (color) {
   }
 }
 
-module.exports = async function getFilesOptions ({
+export async function getFilesOptions ({
   quality,
   padding,
 
@@ -51,8 +52,8 @@ module.exports = async function getFilesOptions ({
   const computedPadding = padding
     ? (
       padding.length === 1
-        ? { horiz: padding[0], vert: padding[0] }
-        : { horiz: padding[0], vert: padding[1] }
+        ? { horiz: padding[ 0 ], vert: padding[ 0 ] }
+        : { horiz: padding[ 0 ], vert: padding[ 1 ] }
     )
     : { horiz: 0, vert: 0 }
 

package/lib/utils/get-png-size.js

@@ -1,5 +1,6 @@
-const readChunk = require('read-chunk')
-const isPng = require('is-png')
+
+import { readChunkSync } from 'read-chunk'
+import isPng from 'is-png'
 
 // "fried" png's - http://www.jongware.com/pngdefry.html
 const friedChunk = 'CgBI'
@@ -10,15 +11,15 @@ function getSize (buffer) {
     : [ 20, 16 ]
 
   return {
-    height: buffer.readUInt32BE(offset[0]),
-    width: buffer.readUInt32BE(offset[1])
+    height: buffer.readUInt32BE(offset[ 0 ]),
+    width: buffer.readUInt32BE(offset[ 1 ])
   }
 }
 
-module.exports = function getPngSize (file) {
-  const buffer = readChunk.sync(file, 0, 40)
+export function getPngSize (file) {
+  const buffer = readChunkSync(file, { startPosition: 0, length: 40 })
 
   return isPng(buffer) !== true
-    ? { width: 0, height: 0}
+    ? { width: 0, height: 0 }
     : getSize(buffer)
 }

package/lib/utils/get-profile-content.js

@@ -1,13 +1,17 @@
-const { resolve } = require('path')
 
-const { warn } = require('./logger')
-const { appDir } = require('./app-paths')
+import { resolve } from 'node:path'
+import { readFileSync } from 'node:fs'
 
-module.exports = function getProfileContent (profileFile) {
+import { warn } from './logger.js'
+import { appDir } from './app-paths.js'
+
+export function getProfileContent (profileFile) {
   const file = resolve(appDir, profileFile)
 
   try {
-    return require(file)
+    return JSON.parse(
+      readFileSync(file, 'utf-8')
+    )
   }
   catch (err) {
     warn(`Specified profile file has a syntax error`)

package/lib/utils/get-profile-files.js

@@ -1,8 +1,9 @@
-const { basename } = require('path')
-const glob = require('fast-glob')
-const { lstatSync } = require('fs')
 
-const { warn } = require('../utils/logger')
+import { basename } from 'node:path'
+import glob from 'fast-glob'
+import { lstatSync } from 'node:fs'
+
+import { warn } from '../utils/logger.js'
 
 function parseFolder (folder) {
   const profileFiles = glob.sync(`icongenie-*.json`, {
@@ -14,19 +15,19 @@ function parseFolder (folder) {
   const numberOfFiles = profileFiles.length
 
   if (numberOfFiles === 0) {
-    warn(`No icongenie-*.json files detected in "${folder}" folder!`)
+    warn(`No icongenie-*.json files detected in "${ folder }" folder!`)
     process.exit(1)
   }
 
-  console.log(` Detected ${numberOfFiles} JSON profile file(s):\n`)
-  console.log(` * ${folder}`)
+  console.log(` Detected ${ numberOfFiles } JSON profile file(s):\n`)
+  console.log(` * ${ folder }`)
 
   profileFiles.forEach((file, index) => {
     const prefix = index + 1 < profileFiles.length
       ? `├──`
       : `└──`
 
-    console.log(` ${prefix} ${basename(file)}`)
+    console.log(` ${ prefix } ${ basename(file) }`)
   })
 
   console.log()
@@ -34,7 +35,7 @@ function parseFolder (folder) {
   return profileFiles
 }
 
-module.exports = function getProfileFiles (profileParam) {
+export function getProfileFiles (profileParam) {
   return lstatSync(profileParam).isDirectory()
     ? parseFolder(profileParam)
     : [ profileParam ]

package/lib/utils/get-square-icon.js

@@ -1,6 +1,7 @@
-const { warn } = require('../utils/logger')
 
-module.exports = function getSquareIcon ({
+import { warn } from '../utils/logger.js'
+
+export function getSquareIcon ({
   file,
   icon,
   size,
@@ -10,7 +11,7 @@ module.exports = function getSquareIcon ({
   const img = icon.clone()
   let width = size - 2 * horiz
   let height = size - 2 * vert
-  let corrections = []
+  const corrections = []
 
   if (width <= 0) {
     width = size
@@ -25,7 +26,7 @@ module.exports = function getSquareIcon ({
   }
 
   if (corrections.length > 0) {
-    warn(`Correction on padding for ${file.relativeName} due to padding exceeding file's dimension of ${size}x${size}px`)
+    warn(`Correction on padding for ${ file.relativeName } due to padding exceeding file's dimension of ${ size }x${ size }px`)
   }
 
   img.resize({

package/lib/utils/logger.js

@@ -1,19 +1,20 @@
-const { green, red } = require('kolorist')
+
+import { green, red } from 'kolorist'
 
 const banner = '*'
 
 const logBanner = green(banner)
 const warnBanner = red(banner)
 
-module.exports.log = function (msg) {
-  console.log(msg ? ` ${logBanner} ${msg}` : '')
+export function log (msg) {
+  console.log(msg ? ` ${ logBanner } ${ msg }` : '')
 }
 
-module.exports.warn = function (msg) {
-  console.warn(msg ? ` ${warnBanner} ⚠️  ${msg}\n` : '')
+export function warn (msg) {
+  console.warn(msg ? ` ${ warnBanner } ⚠️  ${ msg }\n` : '')
 }
 
-module.exports.fatal = function (msg) {
-  console.error(msg ? ` ${warnBanner} ⚠️  ${msg}` : '')
+export function fatal (msg) {
+  console.error(msg ? ` ${ warnBanner } ⚠️  ${ msg }` : '')
   process.exit(1)
 }

package/lib/utils/merge-objects.js

@@ -1,12 +1,13 @@
-module.exports = function mergeObjects () {
+
+export function mergeObjects () {
   const base = {}
 
   for (let i = 0; i < arguments.length; i++) {
-    const obj = arguments[i]
+    const obj = arguments[ i ]
 
     Object.keys(obj).forEach(key => {
-      if (obj[key] !== void 0) {
-        base[key] = obj[key]
+      if (obj[ key ] !== void 0) {
+        base[ key ] = obj[ key ]
       }
     })
   }