add init

Author: DavidWells

.gitignore

@@ -0,0 +1,108 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

README.md

@@ -0,0 +1,99 @@
+# Parse NPM Script
+
+Parse a given `npm` script command from `package.json` & return information.
+
+- What the `script` lifecycle looks like
+- How the command **really** resolves
+- & What the final command run is
+
+Useful for parsing dependencies actually used and figuring out wtf is happening in a complex `package.json`.
+
+## Usage
+
+```js
+const path = require('path')
+const util = require('util')
+const parse = require('./lib')
+
+/* path to your package.json file */
+const packagePath = path.join(__dirname, 'tests/fixtures/one.json')
+
+async function runParser() {
+  const parsed = await parse(packagePath, 'npm run build')
+  console.log(util.inspect(parsed, {
+    showHidden: false,
+    depth: null
+  }))
+}
+
+runParser()
+
+/* Parsed contents
+{
+  command: 'npm run build',
+  steps: [{
+      name: 'prebuild',
+      raw: 'echo a && npm run foo',
+      parsed: ['echo a', 'echo foo']
+    },
+    {
+      name: 'build',
+      raw: 'echo b && npm run cleanup',
+      parsed: ['echo b', 'echo cleanup']
+    },
+    {
+      name: 'postbuild',
+      raw: 'echo c',
+      parsed: 'echo c'
+    }
+  ],
+  raw: ['echo a', 'echo foo', 'echo b', 'echo cleanup', 'echo c'],
+  combined: 'echo a && echo foo && echo b && echo cleanup && echo c'
+}
+*/
+```
+
+## Example:
+
+Parsing a `package.json`
+
+```json
+{
+  "name": "parse-npm-script",
+  "scripts": {
+    "foo": "echo foo",
+    "cleanup": "echo cleanup",
+    "prebuild": "echo a && npm run foo",
+    "build": "echo b && npm run cleanup",
+    "postbuild": "echo c"
+  },
+  "author": "David Wells",
+  "license": "MIT"
+}
+```
+
+Will result in this output:
+
+```js
+{
+  command: 'npm run build',
+  steps: [{
+      name: 'prebuild',
+      raw: 'echo a && npm run foo',
+      parsed: ['echo a', 'echo foo']
+    },
+    {
+      name: 'build',
+      raw: 'echo b && npm run cleanup',
+      parsed: ['echo b', 'echo cleanup']
+    },
+    {
+      name: 'postbuild',
+      raw: 'echo c',
+      parsed: 'echo c'
+    }
+  ],
+  raw: ['echo a', 'echo foo', 'echo b', 'echo cleanup', 'echo c'],
+  combined: 'echo a && echo foo && echo b && echo cleanup && echo c'
+}
+```

lib/index.js

@@ -0,0 +1,18 @@
+const parse = require('./parser')
+const parseJson = require('./parse-json')
+
+/**
+ * Parse npm package script command
+ * @param  {object|string} pkgOrObject - path to package.json or resolved pkg object
+ * @param  {string}  command - npm script command to resolve & parse
+ * @return {Promise} - resolved command data
+ */
+async function parseNpmScript(pkgOrObject, command) {
+  if (typeof pkgOrObject === 'object') {
+    return parse(pkgOrObject, command)
+  }
+  const pkg = await parseJson(pkgOrObject)
+  return parse(pkg, command)
+}
+
+module.exports = parseNpmScript

lib/parse-json.js

@@ -0,0 +1,11 @@
+const fs = require('fs')
+const { promisify } = require('util')
+const readFileAsync = promisify(fs.readFile)
+
+async function parseJson(packagePath, script) {
+  const pkgString = await readFileAsync(packagePath, 'utf-8')
+  const pkg = JSON.parse(pkgString)
+  return pkg
+}
+
+module.exports = parseJson

lib/parser-utils.js

@@ -0,0 +1,137 @@
+
+const __DEV__ = false
+const noOp = () => {}
+let LOGGER = noOp
+if (__DEV__) {
+  LOGGER = (padLevel, ...args) => {
+    console.log(`${'  '.repeat(padLevel)}${args.join(' ')}`)
+  }
+}
+
+const COMPLEX_BASH_COMMANDS = [ // complex command, do not parse further
+  'bash', 'sh', 'ssh', '.', 'source',
+  'su', 'sudo',
+  'cd', // TODO: try parse simple cd, to unwrap further
+  'if',
+  'eval',
+  'cross-env'
+]
+
+const SIMPLE_BASH_COMMAND = [
+  'node', 'npx', 'git',
+  'rm', 'mkdir',
+  'echo', 'cat',
+  'exit', 'kill'
+]
+
+const PACKAGE_INSTALLER = ['npm', 'yarn']
+
+const REGEXP_ESCAPE = /\\/g
+const REGEXP_QUOTE = /[" ]/g
+const wrapJoinBashArgs = (args) => args.map((arg) => {
+  return `"${arg.replace(REGEXP_ESCAPE, '\\\\').replace(REGEXP_QUOTE, '\\$&')}"`
+}).join(' ')
+
+const warpBashSubShell = (command) => `(
+${indentLine(command, '  ')}
+)`
+
+function parseCommand(pkg, scriptString, level, log = LOGGER) {
+  log(level, '[parseCommand]', `input: <${scriptString}>`)
+  scriptString = scriptString.trim()
+
+  const [leadingCommand, secondCommand, ...additionalCommands] = scriptString.split(' ')
+
+  // Check for complex bash
+  if (COMPLEX_BASH_COMMANDS.includes(leadingCommand) || leadingCommand.startsWith('./')) {
+    log(level, '✓ directly executable complex command, return')
+    return scriptString
+  } else {
+    log(level, `? not directly executable complex command: ${leadingCommand}`)
+  }
+
+  // Check for combo commands
+  if (scriptString.includes(' && ')) {
+    log(level, '✓ combo command, split')
+
+    const subCommandList = scriptString.split(' && ')
+    return subCommandList.map((command) => {
+      return parseCommand(pkg, command, level + 1, log) || command
+    })
+    /*
+    return warpBashSubShell(subCommandList.map((command) => {
+      return parseCommand(pkg, command, level + 1, log) || command
+    }).join('\n'))
+    */
+  } else {
+    log(level, `? not combo command, I guess`)
+  }
+
+  if (SIMPLE_BASH_COMMAND.includes(leadingCommand)) {
+    log(level, '✓ directly executable simple command, return')
+
+    return scriptString
+  } else {
+    log(level, `? not directly executable simple command: ${leadingCommand}`)
+  }
+
+  // TODO: consider allow package dependency command
+
+  if (PACKAGE_INSTALLER.includes(leadingCommand)) {
+    if (secondCommand === 'run') {
+      log(level, '✓ package script, parse')
+      const [scriptName, ...extraArgs] = additionalCommands
+      extraArgs[0] === '--' && extraArgs.shift()
+      return parsePackageScript(pkg, scriptName, extraArgs.join(' '), level + 1, log)
+    }
+    if (secondCommand === 'test' || secondCommand === 't') {
+      log(level, '✓ package test script, parse')
+      const [...extraArgs] = additionalCommands
+      extraArgs[0] === '--' && extraArgs.shift()
+      return parsePackageScript(pkg, 'test', extraArgs.join(' '), level + 1, log)
+    }
+    if (secondCommand === 'start') {
+      log(level, '✓ package test script, parse')
+      const [...extraArgs] = additionalCommands
+      extraArgs[0] === '--' && extraArgs.shift()
+      return parsePackageScript(pkg, 'start', extraArgs.join(' '), level + 1, log)
+    }
+  } else {
+    log(level, '? unknown npm/yarn script')
+  }
+
+  log(level, '? unknown script, bail')
+  return scriptString
+}
+
+function parsePackageScript(pkg, scriptName, extraArgsString = '', level, log = LOGGER) {
+  log(level, '[parsePackageScript]', `script name: <${scriptName}>, extra: ${extraArgsString}`)
+
+  const scriptString = pkg.scripts[scriptName]
+  if (!scriptString) {
+    throw new Error(`[parsePackageScript] missing script with name: ${scriptName}`)
+  }
+
+  const otherScriptString = [scriptString, extraArgsString].filter(Boolean).join(' ')
+  const command = parseCommand(pkg, otherScriptString, level + 1, log)
+  if (command) {
+    return command
+  }
+
+  log(level, '? unexpected script, bail to npm run')
+
+  return [`${otherScriptString}`, extraArgsString].filter(Boolean).join(' -- ')
+  // return [`npm run ${scriptName}`, extraArgsString].filter(Boolean).join(' -- ')
+}
+
+const REGEXP_INDENT_LINE = /\n/g
+function indentLine(string, indentString = '  ', indentStringStart = indentString) {
+  return `${indentStringStart}${string.replace(REGEXP_INDENT_LINE, `\n${indentString}`)}`
+}
+
+module.exports = {
+  wrapJoinBashArgs,
+  warpBashSubShell,
+  parseCommand,
+  parsePackageScript
+}