@quasar/icongenie 3.1.1 → 5.0.0

package/lib/mount/mount-cordova.js

@@ -1,8 +1,9 @@
+// oxlint-disable new-cap
 
-import { readFileSync, writeFileSync, existsSync } from 'node:fs'
+import { existsSync, readFileSync, writeFileSync } from 'node:fs'
 import elementTree from 'elementtree'
 import { relative } from 'node:path'
-import { red, green } from 'kolorist'
+import { green, red } from 'kolorist'
 
 import { resolveDir } from '../utils/app-paths.js'
 import { log, warn } from '../utils/logger.js'
@@ -11,26 +12,25 @@ import { spawnSync } from '../utils/spawn-sync.js'
 const cordovaConfigXml = resolveDir('src-cordova/config.xml')
 const srcCordovaDir = resolveDir('src-cordova')
 
-const platformList = [ 'cordova-android', 'cordova-ios' ]
-const generatorList = [ 'png', 'splashscreen' ]
+const platformList = ['cordova-android', 'cordova-ios']
+const generatorList = ['png', 'splashscreen']
 
-function getNode (root, tag, selector) {
-  return (
-    root.find(`${ tag }${ selector }`)
-    || elementTree.SubElement(root, tag)
-  )
+function getNode(root, tag, selector) {
+  return root.find(`${tag}${selector}`) || elementTree.SubElement(root, tag)
 }
 
-function hasNode (root, tag, selector) {
-  return root.find(`${ tag }${ selector }`)
+function hasNode(root, tag, selector) {
+  return root.find(`${tag}${selector}`)
 }
 
-export function isCordovaFile (file) {
-  return platformList.includes(file.platform)
-    && generatorList.includes(file.generator)
+export function isCordovaFile(file) {
+  return (
+    platformList.includes(file.platform) &&
+    generatorList.includes(file.generator)
+  )
 }
 
-function getCordovaFiles (files) {
+function getCordovaFiles(files) {
   const cordovaFiles = []
 
   files.forEach(file => {
@@ -42,11 +42,15 @@ function getCordovaFiles (files) {
   return cordovaFiles
 }
 
-function updateConfigXml (cordovaFiles, hasSplashscreen) {
-  const doc = elementTree.parse(readFileSync(cordovaConfigXml, 'utf-8'))
+function updateConfigXml(cordovaFiles, hasSplashscreen) {
+  const doc = elementTree.parse(readFileSync(cordovaConfigXml, 'utf8'))
   const rootNode = doc.getroot()
 
-  if (hasSplashscreen && !rootNode.find('preference[@name="SplashMaintainAspectRatio"]')) {
+  if (
+    hasSplashscreen &&
+    // oxlint-disable-next-line unicorn/prefer-array-some
+    !rootNode.find('preference[@name="SplashMaintainAspectRatio"]')
+  ) {
     const prefNode = elementTree.SubElement(rootNode, 'preference')
     prefNode.set('name', 'SplashMaintainAspectRatio')
     prefNode.set('value', 'true')
@@ -65,8 +69,7 @@ function updateConfigXml (cordovaFiles, hasSplashscreen) {
   cordovaFiles.forEach(file => {
     const isAndroid = file.platform === 'cordova-android'
     const node = isAndroid ? androidNode : iosNode
-    const src = relative(srcCordovaDir, file.absoluteName)
-      .replace(/\\/g, '/') // Windows support
+    const src = relative(srcCordovaDir, file.absoluteName).replaceAll('\\', '/') // Windows support
 
     if (file.generator === 'splashscreen') {
       // <splash src="res/screen/android/splash-land-hdpi.png" density="land-hdpi"/>
@@ -75,7 +78,7 @@ function updateConfigXml (cordovaFiles, hasSplashscreen) {
       const entry = getNode(
         node,
         'splash',
-        isAndroid ? `[@density="${ file.density }"]` : `[@src="${ src }"]`
+        isAndroid ? `[@density="${file.density}"]` : `[@src="${src}"]`
       )
 
       entry.set('src', src)
@@ -83,8 +86,7 @@ function updateConfigXml (cordovaFiles, hasSplashscreen) {
       if (isAndroid) {
         entry.set('density', file.density)
       }
-    }
-    else if (file.generator === 'png') {
+    } else if (file.generator === 'png') {
       // <icon src="res/android/ldpi.png" density="ldpi" />
       // <icon src="res/ios/icon-60@3x.png" width="180" height="180" />
 
@@ -92,32 +94,31 @@ function updateConfigXml (cordovaFiles, hasSplashscreen) {
         node,
         'icon',
         isAndroid
-          ? `[@density="${ file.density }"]`
-          : `[@width="${ file.width }"][@height="${ file.height }"]`
+          ? `[@density="${file.density}"]`
+          : `[@width="${file.width}"][@height="${file.height}"]`
       )
 
       entry.set('src', src)
 
       if (isAndroid) {
         entry.set('density', file.density)
-      }
-      else {
+      } else {
         entry.set('width', file.width)
         entry.set('height', file.height)
       }
     }
   })
 
-  writeFileSync(cordovaConfigXml, doc.write({ indent: 4 }), 'utf-8')
+  writeFileSync(cordovaConfigXml, doc.write({ indent: 4 }), 'utf8')
   log(`Updated src-cordova/config.xml`)
 }
 
-function hasDeepProp (target /* , param1, param2, ... */) {
+function hasDeepProp(target, ...args) {
   let obj = target
 
-  for (let i = 1; i < arguments.length; i++) {
-    const prop = arguments[ i ]
-    obj = obj[ prop ]
+  for (let i = 0; i < args.length; i++) {
+    const prop = args[i]
+    obj = obj[prop]
 
     if (obj === void 0) {
       return false
@@ -127,45 +128,52 @@ function hasDeepProp (target /* , param1, param2, ... */) {
   return true
 }
 
-function installSplashscreenPlugin () {
+function installSplashscreenPlugin() {
   const pkgPath = resolveDir('src-cordova/package.json')
 
-  if (!existsSync(pkgPath)) {
-    // malformed /src-cordova...
-    return
-  }
+  // malformed /src-cordova...
+  if (!existsSync(pkgPath)) return
 
-  const pkg = JSON.parse(
-    readFileSync(pkgPath, 'utf8')
-  )
+  const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'))
 
   if (
-    hasDeepProp(pkg, 'dependencies', 'cordova-plugin-splashscreen')
-    || hasDeepProp(pkg, 'cordova', 'plugins', 'cordova-plugin-splashscreen')
-  ) {
     // it's already installed, so nothing to do
+    hasDeepProp(pkg, 'dependencies', 'cordova-plugin-splashscreen') ||
+    hasDeepProp(pkg, 'cordova', 'plugins', 'cordova-plugin-splashscreen')
+  ) {
     return
   }
 
   log(`Installing cordova-plugin-splashscreen...`)
 
-  spawnSync('cordova', [ 'plugin', 'add', 'cordova-plugin-splashscreen' ], {
-    cwd: srcCordovaDir
-  }, () => {
-    warn()
-    warn('Failed to install cordova-plugin-splashscreen. Please do it manually.')
-    console.log(' -> /src-cordova: $ cordova plugin add cordova-plugin-splashscreen\n')
-  })
+  spawnSync(
+    'cordova',
+    ['plugin', 'add', 'cordova-plugin-splashscreen'],
+    {
+      cwd: srcCordovaDir
+    },
+    () => {
+      warn()
+      warn(
+        'Failed to install cordova-plugin-splashscreen. Please do it manually.'
+      )
+      console.log(
+        ' -> /src-cordova: $ cordova plugin add cordova-plugin-splashscreen\n'
+      )
+    }
+  )
 
   console.log()
 }
 
-export function mountCordova (files) {
+export function mountCordova(files) {
   if (existsSync(cordovaConfigXml)) {
     const cordovaFiles = getCordovaFiles(files)
 
-    if (cordovaFiles.length > 0) {
-      const hasSplashscreen = cordovaFiles.some(file => file.generator === 'splashscreen')
+    if (cordovaFiles.length !== 0) {
+      const hasSplashscreen = cordovaFiles.some(
+        file => file.generator === 'splashscreen'
+      )
 
       if (hasSplashscreen) {
         installSplashscreenPlugin()
@@ -176,13 +184,14 @@ export function mountCordova (files) {
   }
 }
 
-export function verifyCordova (file) {
+export function verifyCordova(file) {
   if (isCordovaFile(file) && existsSync(cordovaConfigXml)) {
-    const doc = elementTree.parse(readFileSync(cordovaConfigXml, 'utf-8'))
+    const doc = elementTree.parse(readFileSync(cordovaConfigXml, 'utf8'))
     const isAndroid = file.platform === 'cordova-android'
 
-    const node = doc.getroot()
-      .find(`platform[@name="${ isAndroid ? 'android' : 'ios' }"]`)
+    const node = doc
+      .getroot()
+      .find(`platform[@name="${isAndroid ? 'android' : 'ios'}"]`)
 
     // verify that the platform is installed
     if (!node) {
@@ -193,17 +202,16 @@ export function verifyCordova (file) {
 
     if (file.generator === 'splashscreen') {
       const selector = isAndroid
-        ? `[@density="${ file.density }"]`
-        : `[@src="${ src }"]`
+        ? `[@density="${file.density}"]`
+        : `[@src="${src}"]`
 
       if (!hasNode(node, 'splash', selector)) {
         return red('ERROR: no entry for it in src-cordova/config.xml')
       }
-    }
-    else {
+    } else {
       const selector = isAndroid
-        ? `[@density="${ file.density }"]`
-        : `[@width="${ file.width }"][@height="${ file.height }"]`
+        ? `[@density="${file.density}"]`
+        : `[@width="${file.width}"][@height="${file.height}"]`
 
       if (!hasNode(node, 'icon', selector)) {
         return red('ERROR: no entry for it in src-cordova/config.xml')

package/lib/mount/mount-tag.js

@@ -1,15 +1,12 @@
-
 import { log } from '../utils/logger.js'
 
-export function mountTag (files) {
+export function mountTag(files) {
   const tagFiles = files.filter(file => file.tag)
 
-  if (tagFiles.length === 0) {
-    return
-  }
+  if (tagFiles.length === 0) return
 
   console.log()
-  log(`You will need the following tags in your /index.html or /src/index.template.html:\n`)
+  log(`You will need the following tags in your /index.html:\n`)
   tagFiles.forEach(file => {
     console.log(file.tag)
   })

package/lib/runner/generate.js

@@ -1,7 +1,6 @@
-
 import { existsSync } from 'node:fs'
 import { ensureFileSync } from 'fs-extra'
-import { green, gray } from 'kolorist'
+import { gray, green } from 'kolorist'
 
 import { appDir, resolveDir } from '../utils/app-paths.js'
 import { log, warn } from '../utils/logger.js'
@@ -18,45 +17,43 @@ 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) {
+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)}%
  ==========================
 `)
 }
 
-function parseAssets (assets, include) {
-  let files = []
-  let assetsOf = []
+function parseAssets(assets, include) {
+  const files = []
+  const assetsOf = []
 
   if (include) {
-    const embeddedModes = include.filter(
-      mode => existsSync(resolveDir(modes[ mode ].folder))
+    const embeddedModes = include.filter(mode =>
+      existsSync(resolveDir(modes[mode].folder))
     )
 
     embeddedModes.forEach(mode => {
-      files = files.concat(
-        getAssetsFiles(modes[ mode ].assets)
-      )
+      files.push(...getAssetsFiles(modes[mode].assets))
     })
 
-    assetsOf = assetsOf.concat(embeddedModes)
+    assetsOf.push(...embeddedModes)
   }
 
-  if (assets && assets.length > 0) {
-    files = files.concat(getAssetsFiles(assets))
+  if (assets && assets.length !== 0) {
+    files.push(...getAssetsFiles(assets))
     assetsOf.push('profile')
   }
 
@@ -66,13 +63,13 @@ function parseAssets (assets, include) {
   }
 }
 
-function getUniqueFiles (files) {
+function getUniqueFiles(files) {
   const filePaths = {}
   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)
     }
   })
@@ -80,23 +77,23 @@ function getUniqueFiles (files) {
   return uniqueFiles
 }
 
-function generateFile (file, opts) {
+function generateFile(file, opts) {
   // ensure that the file (and its folder) exists
   ensureFileSync(file.absoluteName)
 
   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()
     })
   })
 }
 
-async function generateFromProfile (profile) {
+async function generateFromProfile(profile) {
   const params = profile.params
   const { assetsOf, files } = parseAssets(profile.assets, params.include)
 
@@ -104,32 +101,33 @@ async function generateFromProfile (profile) {
   let uniqueFiles = getUniqueFiles(files)
 
   if (params.filter) {
-    uniqueFiles = uniqueFiles.filter(
-      file => file.generator === params.filter
-    )
+    uniqueFiles = uniqueFiles.filter(file => file.generator === params.filter)
   }
 
   if (uniqueFiles.length === 0) {
-    warn(`No assets to generate! No mode/include specified, filter too specific or the respective Quasar mode(s) are not installed`)
-    return Promise.resolve(0)
+    warn(
+      `No assets to generate! No mode/include specified, filter too specific or the respective Quasar mode(s) are not installed`
+    )
+    return 0
   }
 
   printBanner(assetsOf, params)
 
-  return Promise
-    .all(uniqueFiles.map(file => generateFile(file, fileOptions)))
-    .then(() => { mount(uniqueFiles) })
+  return Promise.all(uniqueFiles.map(file => generateFile(file, fileOptions)))
+    .then(() => {
+      mount(uniqueFiles)
+    })
     .then(() => uniqueFiles.length)
 }
 
-export function generate (argv) {
+export function generate(argv) {
   const profile = {
     params: {},
     assets: []
   }
 
   if (argv.profile) {
-    parseArgv(argv, [ 'profile' ])
+    parseArgv(argv, ['profile'])
 
     const userProfile = getProfileContent(argv.profile)
 
@@ -137,14 +135,13 @@ export function generate (argv) {
       const { profile: _, ...params } = argv
 
       profile.params = mergeObjects(userProfile.params, params)
-      parseArgv(profile.params, [ 'include' ])
+      parseArgv(profile.params, ['include'])
     }
     if (userProfile.assets) {
       profile.assets = userProfile.assets
     }
-  }
-  else {
-    parseArgv(argv, [ 'mode' ])
+  } else {
+    parseArgv(argv, ['mode'])
 
     const { mode, ...params } = argv
 
@@ -155,18 +152,23 @@ export function generate (argv) {
   profile.params = mergeObjects({}, profile.params)
 
   parseArgv(profile.params, [
-    'quality', 'filter', 'padding',
-    'icon', 'background',
+    'quality',
+    'filter',
+    'padding',
+    'icon',
+    'background',
     'splashscreenIconRatio',
     // order matters:
-    'themeColor', 'pngColor', 'splashscreenColor', 'svgColor'
+    'themeColor',
+    'pngColor',
+    'splashscreenColor',
+    'svgColor'
   ])
 
   // final thorough validation
   validateProfileObject(profile)
 
-  return generateFromProfile(profile)
-    .then(numberOfFiles => {
-      console.log(`\n Task done - generated ${ numberOfFiles } file(s)!\n`)
-    })
+  return generateFromProfile(profile).then(numberOfFiles => {
+    console.log(`\n Task done - generated ${numberOfFiles} file(s)!\n`)
+  })
 }

package/lib/runner/profile.js

@@ -1,5 +1,4 @@
-
-import { resolve, dirname, basename, isAbsolute, relative } from 'node:path'
+import { basename, dirname, isAbsolute, relative, resolve } from 'node:path'
 import { writeFileSync } from 'node:fs'
 import { ensureDir } from 'fs-extra'
 
@@ -8,7 +7,7 @@ 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 }) {
+function getParams({ include, ...props }) {
   if (include) {
     props.include = include.split(',')
   }
@@ -16,44 +15,37 @@ function getParams ({ include, ...props }) {
   return props
 }
 
-function getAssets (assets) {
-  let list = []
-
-  assets.forEach(name => {
-    list = list.concat(modes[ name ].assets)
-  })
-
-  return list
+function getAssets(assets) {
+  return assets.reduce((acc, name) => {
+    acc.push(...modes[name].assets)
+    return acc
+  }, [])
 }
 
-function getTargetFilepath (output) {
+function getTargetFilepath(output) {
   const folder = dirname(output)
   const name = basename(output)
 
-  const prefix = name.startsWith('icongenie-')
-    ? ''
-    : 'icongenie-'
+  const prefix = name.startsWith('icongenie-') ? '' : 'icongenie-'
 
-  const suffix = name.endsWith('.json')
-    ? ''
-    : '.json'
+  const suffix = name.endsWith('.json') ? '' : '.json'
 
-  const filename = `${ prefix }${ name }${ suffix }`
+  const filename = `${prefix}${name}${suffix}`
   return resolve(process.cwd(), folder || '', filename)
 }
 
-export function profile ({ output, assets, ...params }) {
-  const profile = {
+export function profile({ output, assets, ...params }) {
+  const acc = {
     params: getParams(params),
     assets: getAssets(assets)
   }
 
-  validateProfileObject(profile, true)
+  validateProfileObject(acc, true)
 
-  if (profile.params.icon && isAbsolute(profile.params.icon) === false) {
+  if (acc.params.icon && !isAbsolute(acc.params.icon)) {
     // generate icon path relative to app root
     // so it won't matter from where the profile file is run
-    profile.params.icon = relative(appDir, profile.params.icon)
+    acc.params.icon = relative(appDir, acc.params.icon)
   }
 
   const targetFile = getTargetFilepath(output)
@@ -63,8 +55,8 @@ export function profile ({ output, assets, ...params }) {
     ensureDir(folderName)
   }
 
-  writeFileSync(targetFile, JSON.stringify(profile, null, 2), 'utf-8')
+  writeFileSync(targetFile, JSON.stringify(acc, null, 2), 'utf8')
 
   console.log(` Generated Icon Genie profile file:`)
-  log(`${ targetFile }\n`)
+  log(`${targetFile}\n`)
 }