@jsreport/jsreport-cli 3.0.0-beta.2 → 3.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 jsreport
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2017 jsreport
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,12 +1,16 @@
-# @jsreport/jsreport-cli
-[![NPM Version](http://img.shields.io/npm/v/@jsreport/jsreport-cli.svg?style=flat-square)](https://npmjs.com/package/@jsreport/jsreport-cli)
-
-**Command line interface for jsreport**
-
-See http://jsreport.net/learn/cli for documentation
-
-## Changelog
-
-### 3.0.0-beta.1
-
-Adaptations for the v3 APIs
+# @jsreport/jsreport-cli
+[![NPM Version](http://img.shields.io/npm/v/@jsreport/jsreport-cli.svg?style=flat-square)](https://npmjs.com/package/@jsreport/jsreport-cli)
+
+**Command line interface for jsreport**
+
+See http://jsreport.net/learn/cli for documentation
+
+## Changelog
+
+### 3.1.0
+
+internal refactor (use latest version of yargs)
+
+### 3.0.0-beta.1
+
+Adaptations for the v3 APIs

package/cli.js

@@ -1,93 +1,93 @@
-#!/usr/bin/env node
-'use strict'
-
-// eslint-disable-next-line no-var
-var semver = require('semver')
-// eslint-disable-next-line no-var
-var cliPackageJson = require('./package.json')
-
-if (!semver.satisfies(process.versions.node, cliPackageJson.engines.node)) {
-  console.error(
-    'jsreport cli requires to have installed a nodejs version of at least ' +
-    cliPackageJson.engines.node +
-    ' but you have installed version ' + process.versions.node + '. please update your nodejs version and try again'
-  )
-
-  process.exit(1)
-}
-
-const path = require('path')
-const Liftoff = require('liftoff')
-const commander = require('./lib/commander')
-const { printError } = require('./lib/errorUtils')
-const help = require('./lib/commands/help')
-const init = require('./lib/commands/init')
-const repair = require('./lib/commands/repair')
-const configure = require('./lib/commands/configure')
-const render = require('./lib/commands/render')
-
-const cli = new Liftoff({
-  processTitle: 'jsreport',
-  moduleName: '@jsreport/jsreport-cli',
-  configName: '.jsreport'
-})
-
-cli.launch({}, initCLI)
-
-function initCLI (env) {
-  const isCLIDev = process.env.JSREPORT_CLI_DEV === 'enabled'
-  const args = process.argv.slice(2)
-  const cwd = process.cwd()
-  let localCommander
-
-  if (!isCLIDev && !env.modulePath) {
-    // if no local installation is found,
-    // try to detect if some global command was specified
-    const globalCliHandler = commander(cwd, {
-      cliName: 'jsreport',
-      builtInCommands: [help, init, repair, configure, render]
-    })
-
-    globalCliHandler.on('started', (err, info) => {
-      if (err) {
-        printError(err, console)
-        return process.exit(1)
-      }
-
-      if (!info.handled) {
-        if (info.mainCommand != null) {
-          console.error('"' + info.mainCommand + '" command not found')
-          console.error('Local jsreport-cli not found in:', env.cwd)
-          console.error('Try installing jsreport-cli or jsreport package to have more commands available')
-
-          return process.exit(1)
-        }
-
-        console.error('Local jsreport-cli not found in:', env.cwd)
-        console.error('Try installing jsreport-cli or jsreport package')
-
-        return process.exit(1)
-      }
-    })
-
-    globalCliHandler.start(args)
-  } else {
-    if (isCLIDev) {
-      localCommander = require(path.join(cwd, 'lib/commander.js'))(cwd, { cliName: 'jsreport' })
-    } else {
-      // Check for semver difference between global cli and local installation
-      if (semver.gt(cliPackageJson.version, env.modulePackage.version)) {
-        console.log('Warning: jsreport-cli version mismatch:')
-        console.log('Global jsreport-cli is', cliPackageJson.version)
-        console.log('Local jsreport-cli is', env.modulePackage.version)
-      }
-
-      localCommander = require(path.join(path.dirname(env.modulePath), 'lib/commander.js'))(cwd, {
-        cliName: 'jsreport'
-      })
-    }
-
-    // start processing
-    localCommander.start(args)
-  }
-}
+#!/usr/bin/env node
+'use strict'
+
+// eslint-disable-next-line no-var
+var semver = require('semver')
+// eslint-disable-next-line no-var
+var cliPackageJson = require('./package.json')
+
+if (!semver.satisfies(process.versions.node, cliPackageJson.engines.node)) {
+  console.error(
+    'jsreport cli requires to have installed a nodejs version of at least ' +
+    cliPackageJson.engines.node +
+    ' but you have installed version ' + process.versions.node + '. please update your nodejs version and try again'
+  )
+
+  process.exit(1)
+}
+
+const path = require('path')
+const Liftoff = require('liftoff')
+const commander = require('./lib/commander')
+const { printError } = require('./lib/utils/error')
+const help = require('./lib/commands/help')
+const init = require('./lib/commands/init')
+const repair = require('./lib/commands/repair')
+const configure = require('./lib/commands/configure')
+const render = require('./lib/commands/render')
+
+const cli = new Liftoff({
+  processTitle: 'jsreport',
+  moduleName: '@jsreport/jsreport-cli',
+  configName: '.jsreport'
+})
+
+cli.launch({}, initCLI)
+
+function initCLI (env) {
+  const isCLIDev = process.env.JSREPORT_CLI_DEV === 'enabled'
+  const args = process.argv.slice(2)
+  const cwd = process.cwd()
+  let localCommander
+
+  if (!isCLIDev && !env.modulePath) {
+    // if no local installation is found,
+    // try to detect if some global command was specified
+    const globalCliHandler = commander(cwd, {
+      cliName: 'jsreport',
+      builtInCommands: [help, init, repair, configure, render]
+    })
+
+    globalCliHandler.on('started', (err, info) => {
+      if (err) {
+        printError(err, console)
+        return process.exit(1)
+      }
+
+      if (!info.handled) {
+        if (info.mainCommand != null) {
+          console.error('"' + info.mainCommand + '" command not found')
+          console.error('Local jsreport-cli not found in:', env.cwd)
+          console.error('Try installing jsreport-cli or jsreport package to have more commands available')
+
+          return process.exit(1)
+        }
+
+        console.error('Local jsreport-cli not found in:', env.cwd)
+        console.error('Try installing jsreport-cli or jsreport package')
+
+        return process.exit(1)
+      }
+    })
+
+    globalCliHandler.start(args)
+  } else {
+    if (isCLIDev) {
+      localCommander = require(path.join(cwd, 'lib/commander'))(cwd, { cliName: 'jsreport' })
+    } else {
+      // Check for semver difference between global cli and local installation
+      if (semver.gt(cliPackageJson.version, env.modulePackage.version)) {
+        console.log('Warning: jsreport-cli version mismatch:')
+        console.log('Global jsreport-cli is', cliPackageJson.version)
+        console.log('Local jsreport-cli is', env.modulePackage.version)
+      }
+
+      localCommander = require(path.join(path.dirname(env.modulePath), 'lib/commander'))(cwd, {
+        cliName: 'jsreport'
+      })
+    }
+
+    // start processing
+    localCommander.start(args)
+  }
+}

package/example.config.json

@@ -1,43 +1,43 @@
-{
-  "httpPort": 5488,
-  "store": {
-    "provider": "fs"
-  },
-  "blobStorage": {
-    "provider": "fs"
-  },
-  "logger": {
-    "console": {
-      "transport": "console",
-      "level": "debug"
-    },
-    "file": {
-      "transport": "file",
-      "level": "info",
-      "filename": "logs/reporter.log"
-    },
-    "error": {
-      "transport": "file",
-      "level": "error",
-      "filename": "logs/error.log"
-    }
-  },
-  "allowLocalFilesAccess": false,
-  "reportTimeout": 60000,
-  "workers": {
-    "numberOfWorkers": 2
-  },
-  "extensions": {
-    "authentication": {
-      "cookieSession": {},
-      "admin": {
-        "username": "admin",
-        "password": "password"
-      },
-      "enabled": false
-    },
-    "sample-template": {
-      "createSamples": true
-    }
-  }
-}
+{
+  "httpPort": 5488,
+  "store": {
+    "provider": "fs"
+  },
+  "blobStorage": {
+    "provider": "fs"
+  },
+  "logger": {
+    "console": {
+      "transport": "console",
+      "level": "debug"
+    },
+    "file": {
+      "transport": "file",
+      "level": "info",
+      "filename": "logs/reporter.log"
+    },
+    "error": {
+      "transport": "file",
+      "level": "error",
+      "filename": "logs/error.log"
+    }
+  },
+  "allowLocalFilesAccess": false,
+  "reportTimeout": 60000,
+  "workers": {
+    "numberOfWorkers": 2
+  },
+  "extensions": {
+    "authentication": {
+      "cookieSession": {},
+      "admin": {
+        "username": "admin",
+        "password": "password"
+      },
+      "enabled": false
+    },
+    "sample-template": {
+      "createSamples": true
+    }
+  }
+}

package/example.server.js

@@ -1,14 +1,14 @@
-const jsreport = require('$moduleName$')()
-
-if (process.env.JSREPORT_CLI) {
-  // export jsreport instance to make it possible to use jsreport-cli
-  module.exports = jsreport
-} else {
-  jsreport.init().then(() => {
-    // running
-  }).catch((e) => {
-    // error during startup
-    console.error(e.stack)
-    process.exit(1)
-  })
-}
+const jsreport = require('$moduleName$')()
+
+if (process.env.JSREPORT_CLI) {
+  // export jsreport instance to make it possible to use jsreport-cli
+  module.exports = jsreport
+} else {
+  jsreport.init().then(() => {
+    // running
+  }).catch((e) => {
+    // error during startup
+    console.error(e.stack)
+    process.exit(1)
+  })
+}

package/index.js

@@ -1,22 +1,20 @@
-'use strict'
-
-const commander = require('./lib/commander')
-const main = require('./lib/cliExtension')
-const keepAliveProcess = require('./lib/keepAliveProcess')
-const daemonHandler = require('./lib/daemonHandler')
-const config = require('./jsreport.config')
-
-module.exports = function (options) {
-  const newConfig = Object.assign({}, config)
-
-  newConfig.options = options
-  newConfig.main = main
-  newConfig.directory = __dirname
-
-  return newConfig
-}
-
-module.exports.commander = commander
-module.exports.tempResources = main.tempResources
-module.exports.keepAliveProcess = keepAliveProcess
-module.exports.daemonHandler = daemonHandler
+const commander = require('./lib/commander')
+const main = require('./lib/cliExtension')
+const keepAliveProcess = require('./lib/keepAliveProcess')
+const daemonHandler = require('./lib/daemonHandler')
+const config = require('./jsreport.config')
+
+module.exports = function (options) {
+  const newConfig = Object.assign({}, config)
+
+  newConfig.options = options
+  newConfig.main = main
+  newConfig.directory = __dirname
+
+  return newConfig
+}
+
+module.exports.commander = commander
+module.exports.tempResources = main.tempResources
+module.exports.keepAliveProcess = keepAliveProcess
+module.exports.daemonHandler = daemonHandler

package/jsreport.config.js

@@ -1,8 +1,8 @@
-module.exports = {
-  name: 'cli',
-  main: './lib/cliExtension.js',
-  dependencies: [],
-  requires: {
-    core: '3.x.x'
-  }
-}
+module.exports = {
+  name: 'cli',
+  main: './lib/cliExtension.js',
+  dependencies: [],
+  requires: {
+    core: '3.x.x'
+  }
+}

package/lib/cliExtension.js

@@ -1,59 +1,59 @@
-'use strict'
-
-const path = require('path')
-const searchExtensionsCommands = require('./registerExtensionsCommands')
-
-module.exports = (reporter, definition) => {
-  if (reporter.compilation) {
-    reporter.compilation.resourceInTemp('nssm.exe', path.join(path.dirname(require.resolve('winser-with-api')), './bin/nssm.exe'))
-    reporter.compilation.resourceInTemp('nssm64.exe', path.join(path.dirname(require.resolve('winser-with-api')), './bin/nssm64.exe'))
-    reporter.compilation.resourceInTemp('WinRun.exe', path.join(path.dirname(require.resolve('silent-spawn')), './WinRun.exe'))
-  }
-
-  reporter.cli = {
-    findCommandsInExtensions: async () => {
-      const extensionsCommands = await searchExtensionsCommands(
-        reporter.extensionsManager.extensions,
-        { registerCommand: () => {} }
-      )
-
-      return extensionsCommands
-    }
-  }
-
-  // only require commander and register route when the process was started from keep alive
-  if (process.env.JSREPORT_CLI_DAEMON_PROCESS) {
-    const Commander = require('./commander')
-
-    reporter.on('express-configure', (app) => {
-      app.post('/api/cli/render-keep-alive', async (req, res) => {
-        try {
-          const { cwd, args } = req.body
-
-          const commander = Commander(cwd)
-
-          const { error, logs } = await commander.startAndWait(args)
-
-          const respBody = {}
-
-          if (error) {
-            respBody.message = error.message
-            respBody.stack = error.stack
-          }
-
-          respBody.logs = logs
-
-          res.status(error == null ? 200 : 400).json(respBody)
-        } catch (e) {
-          res.status(500).json({
-            message: `Error while executing commander. ${e.message}`,
-            stack: e.stack,
-            logs: []
-          })
-        }
-      })
-    })
-  }
-}
-
-module.exports.tempResources = ['nssm.exe', 'nssm64.exe', 'WinRun.exe']
+'use strict'
+
+const path = require('path')
+const detectAndRegisterExtensionsCommands = require('./detectAndRegisterExtensionsCommands')
+
+module.exports = (reporter, definition) => {
+  if (reporter.compilation) {
+    reporter.compilation.resourceInTemp('nssm.exe', path.join(path.dirname(require.resolve('winser-with-api')), './bin/nssm.exe'))
+    reporter.compilation.resourceInTemp('nssm64.exe', path.join(path.dirname(require.resolve('winser-with-api')), './bin/nssm64.exe'))
+    reporter.compilation.resourceInTemp('WinRun.exe', path.join(path.dirname(require.resolve('silent-spawn')), './WinRun.exe'))
+  }
+
+  reporter.cli = {
+    findCommandsInExtensions: async () => {
+      const extensionsCommands = await detectAndRegisterExtensionsCommands(
+        reporter.extensionsManager.extensions,
+        { registerCommand: () => {} }
+      )
+
+      return extensionsCommands
+    }
+  }
+
+  // only require commander and register route when the process was started from keep alive
+  if (process.env.JSREPORT_CLI_DAEMON_PROCESS) {
+    const Commander = require('./commander')
+
+    reporter.on('express-configure', (app) => {
+      app.post('/api/cli/render-keep-alive', async (req, res) => {
+        try {
+          const { cwd, args } = req.body
+
+          const commander = Commander(cwd)
+
+          const { error, logs } = await commander.startAndWait(args)
+
+          const respBody = {}
+
+          if (error) {
+            respBody.message = error.message
+            respBody.stack = error.stack
+          }
+
+          respBody.logs = logs
+
+          res.status(error == null ? 200 : 400).json(respBody)
+        } catch (e) {
+          res.status(500).json({
+            message: `Error while executing commander. ${e.message}`,
+            stack: e.stack,
+            logs: []
+          })
+        }
+      })
+    })
+  }
+}
+
+module.exports.tempResources = ['nssm.exe', 'nssm64.exe', 'WinRun.exe']

package/lib/{createCommandParser.js → commander/createCommandParser.js}

@@ -1,45 +1,44 @@
-'use strict'
-
-const yargs = require('yargs')
-
-module.exports = function createCommandParser (instance, cliName) {
-  let cli = instance || yargs([])
-  const commandHelp = 'To show more information about a command, type: jsreport <command> -h'
-
-  if (cliName != null && cliName !== '') {
-    cli = cli.scriptName(cliName)
-  }
-
-  return (
-    cli
-      .usage(`Usage:\n\njsreport [options] <command> [options]\n\n${commandHelp}`)
-      // this makes strict works correctly when passing unknown dashed options
-      .parserConfiguration({ 'camel-case-expansion': false })
-      .showHidden(false)
-      .showHelpOnFail(false)
-      .exitProcess(false)
-      .version(false)
-      .help('help', 'Show help')
-      .alias('help', 'h')
-      // adding version option explicitly because we have a custom handler for it
-      .option('version', {
-        global: false,
-        alias: 'v',
-        description: 'Show version number',
-        type: 'boolean'
-      })
-      // we are only declaring the "context" option to allow passing
-      // a context object for other commands,
-      // it is not mean to be used by users, that why it is hidden (description: false)
-      // it needs to be global because we don't know if other command will be .strict() or not
-      // and could cause validation errors
-      .option('context', {
-        global: false,
-        alias: '_context_',
-        description: false, // makes the option invisible
-        type: 'string' // necessary to don't have any value if option is omitted
-      })
-      .hide('context')
-      .epilog(commandHelp)
-  )
-}
+const yargs = require('yargs')
+
+module.exports = function createCommandParser (instance, _cliName) {
+  let cli = instance || yargs([])
+  const cliName = _cliName || 'jsreport'
+  const commandHelp = 'To show more information about a command, type: jsreport <command> -h'
+
+  if (cliName != null && cliName !== '') {
+    cli = cli.scriptName(cliName)
+  }
+
+  return (
+    cli
+      .usage(`Usage:\n\njsreport [options] <command> [options]\n\n${commandHelp}`)
+      // this makes strict works correctly when passing unknown dashed options
+      .parserConfiguration({ 'camel-case-expansion': false })
+      .showHidden(false)
+      .showHelpOnFail(false)
+      .exitProcess(false)
+      .version(false)
+      .help('help', 'Show help')
+      .alias('help', 'h')
+      // adding version option explicitly because we have a custom handler for it
+      .option('version', {
+        global: false,
+        alias: 'v',
+        description: 'Show version number',
+        type: 'boolean'
+      })
+      // we are only declaring the "context" option to allow passing
+      // a context object for other commands,
+      // it is not mean to be used by users, that why it is hidden (description: false)
+      // it needs to be global because we don't know if other command will be .strict() or not
+      // and could cause validation errors
+      .option('context', {
+        global: false,
+        alias: '_context_',
+        description: false, // makes the option invisible
+        type: 'string' // necessary to don't have any value if option is omitted
+      })
+      .hide('context')
+      .epilog(commandHelp)
+  )
+}