@quasar/icongenie 2.5.2 → 2.5.3

package/lib/cmd/verify.js

@@ -1,148 +1,99 @@
-const { existsSync } = require('fs')
-const { green, red, underline } = require('kolorist')
 
-const { appDir, resolveDir } = require('../utils/app-paths')
-const { warn } = require('../utils/logger')
-
-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')
-
-function getFileStatus (file) {
-  if (!existsSync(file.absoluteName)) {
-    return red('ERROR: missing!')
-  }
-
-  if (file.generator === 'png' || file.generator === 'splashscreen') {
-    const { width, height } = getPngSize(file.absoluteName)
-
-    if (width === 0 && height === 0) {
-      return red('ERROR: not a png!')
-    }
-
-    if (width !== file.width || height !== file.height) {
-      return red(`ERROR: incorrect resolution! ${width}x${height}`)
-    }
-  }
-
-  return green('SIZE OK')
+const parseArgs = require('minimist')
+
+const argv = parseArgs(process.argv.slice(2), {
+  alias: {
+    m: 'mode',
+    p: 'profile',
+    f: 'filter',
+    h: 'help'
+  },
+  boolean: ['h']
+})
+
+if (argv.help) {
+  const modes = Object.keys(require('../modes')).join('|')
+  const generators = Object.keys(require('../generators')).join('|')
+
+  console.log(`
+  Description
+    Verifies your Quasar App's icons and splashscreens
+    for all installed modes.
+
+  Usage
+    $ icongenie verify [options]
+
+    # verify all Quasar modes
+    $ icongenie verify
+
+    # verify specific mode
+    $ icongenie verify -m spa
+
+    # verify with specific filter
+    $ icongenie verify -f ico
+
+    # verify by using a profile file
+    $ icongenie verify -p ./icongenie-profile.json
+
+    # verify by using batch of profile files
+    $ icongenie verify -p ./folder-containing-profile-files
+
+  Options
+    --mode, -m      For which Quasar mode(s) to verify the assets;
+                    Default: all
+                      [all|${modes}]
+                    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}]
+
+    --profile       Use JSON profile file(s) to extract the asset list to verify:
+                      - path to folder (absolute or relative to current folder)
+                        that contains JSON profile files (icongenie-*.json)
+                      - path to a single *.json profile file (absolute or relative
+                        to current folder)
+                    Structure of a JSON profile file:
+                      {
+                        "params": {
+                          "include": [ ... ], /* optional */
+                          ...
+                        },
+                        "assets": [ /* list of custom assets */ ]
+                      }
+
+    --help, -h      Displays this message
+  `)
+  process.exit(0)
 }
 
-function printMode (modeName, files) {
-  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()
-}
-
-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)}
- ================
-`)
-}
-
-function parseAssets (assets, include) {
-  let filesMap = []
-  let assetsOf = []
-
-  if (include) {
-    const embeddedModes = include.filter(
-      mode => existsSync(resolveDir(modes[mode].folder))
-    )
-
-    embeddedModes.forEach(mode => {
-      filesMap.push({
-        name: mode,
-        files: getAssetsFiles(modes[mode].assets)
-      })
-    })
-
-    assetsOf = assetsOf.concat(embeddedModes)
-  }
-
-  if (assets && assets.length > 0) {
-    filesMap.push({
-      name: 'profile assets',
-      files: getAssetsFiles(assets)
-    })
-
-    assetsOf.push('profile')
-  }
-
-  return {
-    filesMap,
-    assetsOf: assetsOf.join(' | ')
+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')
+
+async function runProfiles (params, profileFiles) {
+  for (let i = 0; i < profileFiles.length; i++) {
+    const profile = profileFiles[i]
+
+    console.log(`\n`)
+    log(`--------------------`)
+    log(`Verifying by profile: ${profile}`)
+    log(`--------------------`)
+    console.log(`\n`)
+
+    await verify({ ...params, profile })
   }
 }
 
-function verifyProfile (profile) {
-  const params = profile.params
-  const { assetsOf, filesMap } = parseAssets(profile.assets, params.include)
-
-  if (assetsOf.length === 0) {
-    warn(`No assets to generate! No mode/include specified, filter too specific or the respective Quasar mode(s) are not installed`)
-    return
-  }
-
-  printBanner(assetsOf, params)
-
-  filesMap.forEach(entry => {
-    const files = params.filter
-      ? entry.files.filter(file => file.generator === params.filter)
-      : entry.files
+const params = filterArgvParams(argv)
 
-    if (files.length > 0) {
-      printMode(entry.name, files)
-    }
-  })
+if (params.profile) {
+  parseArgv(params, [ 'profile' ])
+  runProfiles(params, getProfileFiles(params.profile))
 }
-
-module.exports = function verify (argv) {
-  const profile = {
-    params: {},
-    assets: []
-  }
-
-  if (argv.profile) {
-    parseArgv(argv, [ 'profile' ])
-
-    const userProfile = getProfileContent(argv.profile)
-
-    if (userProfile.params) {
-      const { profile: _, ...params } = argv
-
-      profile.params = mergeObjects(userProfile.params, params)
-      parseArgv(profile.params, [ 'include' ])
-    }
-    if (userProfile.assets) {
-      profile.assets = userProfile.assets
-    }
-  }
-  else {
-    parseArgv(argv, [ 'mode' ])
-
-    const { mode, ...params } = argv
-
-    profile.params = params
-    profile.params.include = mode
-  }
-
-  parseArgv(profile.params, [ 'filter' ])
-
-  // final thorough validation
-  validateProfileObject(profile)
-
-  verifyProfile(profile)
+else {
+  verify(params)
 }

package/lib/runner/generate.js

@@ -0,0 +1,171 @@
+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')
+
+const modes = require('../modes')
+const generators = require('../generators')
+const { mount } = require('../mount')
+
+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')
+
+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)}%
+ ==========================
+`)
+}
+
+function parseAssets (assets, include) {
+  let files = []
+  let assetsOf = []
+
+  if (include) {
+    const embeddedModes = include.filter(
+      mode => existsSync(resolveDir(modes[mode].folder))
+    )
+
+    embeddedModes.forEach(mode => {
+      files = files.concat(
+        getAssetsFiles(modes[mode].assets)
+      )
+    })
+
+    assetsOf = assetsOf.concat(embeddedModes)
+  }
+
+  if (assets && assets.length > 0) {
+    files = files.concat(getAssetsFiles(assets))
+    assetsOf.push('profile')
+  }
+
+  return {
+    files,
+    assetsOf: assetsOf.join(' | ')
+  }
+}
+
+function getUniqueFiles (files) {
+  const filePaths = {}
+  const uniqueFiles = []
+
+  files.forEach(file => {
+    if (filePaths[file.absoluteName] === void 0) {
+      filePaths[file.absoluteName] = true
+      uniqueFiles.push(file)
+    }
+  })
+
+  return uniqueFiles
+}
+
+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)})`
+      const type = (file.generator + ':').padEnd(13, ' ')
+
+      log(`Generated ${type} ${green(file.relativeName)} ${gray(size)}`)
+      resolve()
+    })
+  })
+}
+
+async function generateFromProfile (profile) {
+  const params = profile.params
+  const { assetsOf, files } = parseAssets(profile.assets, params.include)
+
+  const fileOptions = await getFilesOptions(params)
+  let uniqueFiles = getUniqueFiles(files)
+
+  if (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)
+  }
+
+  printBanner(assetsOf, params)
+
+  return Promise
+    .all(uniqueFiles.map(file => generateFile(file, fileOptions)))
+    .then(() => { mount(uniqueFiles) })
+    .then(() => uniqueFiles.length)
+}
+
+module.exports = function generate (argv) {
+  const profile = {
+    params: {},
+    assets: []
+  }
+
+  if (argv.profile) {
+    parseArgv(argv, [ 'profile' ])
+
+    const userProfile = getProfileContent(argv.profile)
+
+    if (userProfile.params) {
+      const { profile: _, ...params } = argv
+
+      profile.params = mergeObjects(userProfile.params, params)
+      parseArgv(profile.params, [ 'include' ])
+    }
+    if (userProfile.assets) {
+      profile.assets = userProfile.assets
+    }
+  }
+  else {
+    parseArgv(argv, [ 'mode' ])
+
+    const { mode, ...params } = argv
+
+    profile.params = params
+    profile.params.include = mode
+  }
+
+  profile.params = mergeObjects({}, profile.params)
+
+  parseArgv(profile.params, [
+    'quality', 'filter', 'padding',
+    'icon', 'background',
+    'splashscreenIconRatio',
+    // order matters:
+    'themeColor', 'pngColor', 'splashscreenColor', 'svgColor'
+  ])
+
+  // final thorough validation
+  validateProfileObject(profile)
+
+  return generateFromProfile(profile)
+    .then(numberOfFiles => {
+      console.log(`\n Task done - generated ${numberOfFiles} file(s)!\n`)
+    })
+}

package/lib/runner/profile.js

@@ -0,0 +1,69 @@
+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')
+
+function getParams ({ include, ...props }) {
+  if (include) {
+    props.include = include.split(',')
+  }
+
+  return props
+}
+
+function getAssets (assets) {
+  let list = []
+
+  assets.forEach(name => {
+    list = list.concat(modes[name].assets)
+  })
+
+  return list
+}
+
+function getTargetFilepath (output) {
+  const folder = dirname(output)
+  const name = basename(output)
+
+  const prefix = name.startsWith('icongenie-')
+    ? ''
+    : 'icongenie-'
+
+  const suffix = name.endsWith('.json')
+    ? ''
+    : '.json'
+
+  const filename = `${prefix}${name}${suffix}`
+  return resolve(process.cwd(), folder || '', filename)
+}
+
+module.exports = function profile ({ output, assets, ...params }) {
+  const profile = {
+    params: getParams(params),
+    assets: getAssets(assets)
+  }
+
+  validateProfileObject(profile, true)
+
+  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)
+  }
+
+  const targetFile = getTargetFilepath(output)
+  const folderName = dirname(targetFile)
+
+  if (folderName) {
+    ensureDir(folderName)
+  }
+
+  writeFileSync(targetFile, JSON.stringify(profile, null, 2), 'utf-8')
+
+  console.log(` Generated Icon Genie profile file:`)
+  log(`${targetFile}\n`)
+}

package/lib/runner/verify.js

@@ -0,0 +1,148 @@
+const { existsSync } = require('fs')
+const { green, red, underline } = require('kolorist')
+
+const { appDir, resolveDir } = require('../utils/app-paths')
+const { warn } = require('../utils/logger')
+
+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')
+
+function getFileStatus (file) {
+  if (!existsSync(file.absoluteName)) {
+    return red('ERROR: missing!')
+  }
+
+  if (file.generator === 'png' || file.generator === 'splashscreen') {
+    const { width, height } = getPngSize(file.absoluteName)
+
+    if (width === 0 && height === 0) {
+      return red('ERROR: not a png!')
+    }
+
+    if (width !== file.width || height !== file.height) {
+      return red(`ERROR: incorrect resolution! ${width}x${height}`)
+    }
+  }
+
+  return green('SIZE OK')
+}
+
+function printMode (modeName, files) {
+  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()
+}
+
+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)}
+ ================
+`)
+}
+
+function parseAssets (assets, include) {
+  let filesMap = []
+  let assetsOf = []
+
+  if (include) {
+    const embeddedModes = include.filter(
+      mode => existsSync(resolveDir(modes[mode].folder))
+    )
+
+    embeddedModes.forEach(mode => {
+      filesMap.push({
+        name: mode,
+        files: getAssetsFiles(modes[mode].assets)
+      })
+    })
+
+    assetsOf = assetsOf.concat(embeddedModes)
+  }
+
+  if (assets && assets.length > 0) {
+    filesMap.push({
+      name: 'profile assets',
+      files: getAssetsFiles(assets)
+    })
+
+    assetsOf.push('profile')
+  }
+
+  return {
+    filesMap,
+    assetsOf: assetsOf.join(' | ')
+  }
+}
+
+function verifyProfile (profile) {
+  const params = profile.params
+  const { assetsOf, filesMap } = parseAssets(profile.assets, params.include)
+
+  if (assetsOf.length === 0) {
+    warn(`No assets to generate! No mode/include specified, filter too specific or the respective Quasar mode(s) are not installed`)
+    return
+  }
+
+  printBanner(assetsOf, params)
+
+  filesMap.forEach(entry => {
+    const files = params.filter
+      ? entry.files.filter(file => file.generator === params.filter)
+      : entry.files
+
+    if (files.length > 0) {
+      printMode(entry.name, files)
+    }
+  })
+}
+
+module.exports = function verify (argv) {
+  const profile = {
+    params: {},
+    assets: []
+  }
+
+  if (argv.profile) {
+    parseArgv(argv, [ 'profile' ])
+
+    const userProfile = getProfileContent(argv.profile)
+
+    if (userProfile.params) {
+      const { profile: _, ...params } = argv
+
+      profile.params = mergeObjects(userProfile.params, params)
+      parseArgv(profile.params, [ 'include' ])
+    }
+    if (userProfile.assets) {
+      profile.assets = userProfile.assets
+    }
+  }
+  else {
+    parseArgv(argv, [ 'mode' ])
+
+    const { mode, ...params } = argv
+
+    profile.params = params
+    profile.params.include = mode
+  }
+
+  parseArgv(profile.params, [ 'filter' ])
+
+  // final thorough validation
+  validateProfileObject(profile)
+
+  verifyProfile(profile)
+}

package/lib/utils/parse-argv.js

@@ -1,5 +1,5 @@
 const { existsSync, lstatSync } = require('fs')
-const { resolve, normalize, join } = require('path')
+const { resolve, normalize, join, isAbsolute } = require('path')
 const untildify = require('untildify')
 
 const getPngSize = require('./get-png-size')
@@ -124,6 +124,27 @@ function padding (value, argv) {
     : sizes
 }
 
+function parseIconPath (value) {
+  const __path = untildify(value)
+
+  if (isAbsolute(__path)) {
+    return existsSync(__path) === true
+      ? __path
+      : null
+  }
+
+  let icon = resolve(process.cwd(), __path)
+
+  if (existsSync(icon)) {
+    return icon
+  }
+
+  const { appDir } = require('./app-paths')
+  icon = resolve(appDir, __path)
+
+  return existsSync(icon) ? icon : null
+}
+
 function icon (value, argv) {
   if (!value) {
     warn(`No source icon file specified, so using the sample one`)
@@ -131,12 +152,9 @@ function icon (value, argv) {
     return
   }
 
+  argv.icon = parseIconPath(value)
 
-  const { appDir } = require('./app-paths')
-
-  argv.icon = resolve(appDir, untildify(value))
-
-  if (!existsSync(argv.icon)) {
+  if (!argv.icon) {
     die(`Path to source icon file does not exists: "${value}"`)
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quasar/icongenie",
-  "version": "2.5.2",
+  "version": "2.5.3",
   "description": "A Quasar tool for generating all your Quasar App's icons and splashscreens",
   "bin": {
     "icongenie": "./bin/icongenie"