npq 2.1.0 → 2.1.2

package/.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  printWidth: 100,
+  tabWidth: 2,
+  singleQuote: true,
+  semi: false,
+  trailingComma: 'none',
+  useTabs: false,
+  bracketSpacing: true
+}

package/__tests__/__fixtures__/test.marshall.js

@@ -31,7 +31,7 @@ class TestMarshall extends BaseMarshall {
 
         return data
       })
-      .catch(err => {
+      .catch((err) => {
         this.setMessage({
           pkg: pkg,
           message: err.message

package/__tests__/marshalls.base.test.js

@@ -46,9 +46,7 @@ test('checkPackage sets the error property if the validaiton failed', async () =
 
   testMarshall.init(ctx)
   await testMarshall.checkPackage(pkg, ctx, {})
-  expect(ctx.marshalls[TEST_MARSHALL_NAME].errors[0].pkg).toEqual(
-    pkg.packageString
-  )
+  expect(ctx.marshalls[TEST_MARSHALL_NAME].errors[0].pkg).toEqual(pkg.packageString)
 })
 
 test('setError sets the errors properly', () => {

package/__tests__/marshalls.classMethods.test.js

@@ -33,7 +33,5 @@ test('build marshalls without any should throw error', () => {
   expect(marshalls.buildMarshallTasks([])).rejects.toEqual(expect.any(Error))
   expect(marshalls.buildMarshallTasks({})).rejects.toEqual(expect.any(Error))
   expect(marshalls.buildMarshallTasks(5)).rejects.toEqual(expect.any(Error))
-  expect(marshalls.buildMarshallTasks('something')).rejects.toEqual(
-    expect.any(Error)
-  )
+  expect(marshalls.buildMarshallTasks('something')).rejects.toEqual(expect.any(Error))
 })

package/__tests__/marshalls.repo.test.js

@@ -81,9 +81,7 @@ describe('Repo test suites', () => {
   })
 
   test('throws the right error when the repository url does not exist', async () => {
-    fetch.mockImplementationOnce(() =>
-      Promise.reject(new Error('error'))
-    )
+    fetch.mockImplementationOnce(() => Promise.reject(new Error('error')))
 
     await expect(testMarshall.validate(fullPkgData)).rejects.toThrow(
       'no valid repository is associated with the package'
@@ -91,20 +89,17 @@ describe('Repo test suites', () => {
   })
 
   test('throws the right error when the repository url is unreachable', async () => {
-    fetch.mockImplementationOnce(() =>
-      Promise.reject(new Error('error'))
-    )
+    fetch.mockImplementationOnce(() => Promise.reject(new Error('error')))
 
-    fullPkgData.packageName.versions['1.0.0'].repository.url = 'https://dsfsdfsdfs.abcdeugwecwekjasda.com/'
+    fullPkgData.packageName.versions['1.0.0'].repository.url =
+      'https://dsfsdfsdfs.abcdeugwecwekjasda.com/'
     await expect(testMarshall.validate(fullPkgData)).rejects.toThrow(
       'the repository associated with the package (https://dsfsdfsdfs.abcdeugwecwekjasda.com/) does not exist or is unreachable at the moment.'
     )
   })
 
   test('throws the right error when the homepage url does not exist', async () => {
-    fetch.mockImplementationOnce(() =>
-      Promise.reject(new Error('error'))
-    )
+    fetch.mockImplementationOnce(() => Promise.reject(new Error('error')))
 
     const pkgData = {
       packageName: {
@@ -126,9 +121,7 @@ describe('Repo test suites', () => {
   })
 
   test('does not throw any errors if the url exists', async () => {
-    fetch.mockImplementationOnce(() =>
-      Promise.resolve('success')
-    )
+    fetch.mockImplementationOnce(() => Promise.resolve('success'))
 
     fullPkgData.packageName.versions['1.0.0'].repository.url = 'https://google.com'
     await expect(testMarshall.validate(fullPkgData)).resolves.toEqual(expect.anything())

package/__tests__/marshalls.tasks.test.js

@@ -2,14 +2,14 @@ const path = require('path')
 const marshalls = require('../lib/marshalls')
 
 const PackageRepoUtilsMock = class Fake {
-  getPackageInfo () { return Promise.resolve(true) }
+  getPackageInfo () {
+    return Promise.resolve(true)
+  }
 }
 
 test('running marshall tasks succeeds', async () => {
   marshalls.collectMarshalls = jest.fn(() => {
-    return Promise.resolve([
-      path.join(process.cwd(), '__tests__/__fixtures__/test.marshall.js')
-    ])
+    return Promise.resolve([path.join(process.cwd(), '__tests__/__fixtures__/test.marshall.js')])
   })
 
   const config = {
@@ -31,9 +31,7 @@ test('running marshall tasks succeeds', async () => {
 
 test('running marshall tasks fails', async () => {
   marshalls.collectMarshalls = jest.fn(() => {
-    return Promise.resolve([
-      path.join(process.cwd(), '__tests__/__fixtures__/test.marshall.js')
-    ])
+    return Promise.resolve([path.join(process.cwd(), '__tests__/__fixtures__/test.marshall.js')])
   })
 
   const config = {

package/__tests__/packageManager.test.js

@@ -55,25 +55,25 @@ test('package manager spawns successfully when provided array of packages to han
   expect(childProcess.spawn.mock.calls.length).toBe(1)
   expect(childProcess.spawn.mock.calls[0][0]).toBe('npm')
 
-  expect(childProcess.spawn.mock.calls[0][1]).toEqual([
-    'install',
-    'semver',
-    'express'
-  ])
+  expect(childProcess.spawn.mock.calls[0][1]).toEqual(['install', 'semver', 'express'])
   childProcess.spawn.mockReset()
 })
 
 test('package manager spawns successfully and ignore npqs own internal commands when spawning package manager', async () => {
-  process.argv = ['node', 'script name', 'install', 'semver', 'express', '--dry-run', '--packageManager']
+  process.argv = [
+    'node',
+    'script name',
+    'install',
+    'semver',
+    'express',
+    '--dry-run',
+    '--packageManager'
+  ]
   await packageManager.process('npm')
   expect(childProcess.spawn).toHaveBeenCalled()
   expect(childProcess.spawn.mock.calls.length).toBe(1)
   expect(childProcess.spawn.mock.calls[0][0]).toBe('npm')
 
-  expect(childProcess.spawn.mock.calls[0][1]).toEqual([
-    'install',
-    'semver',
-    'express'
-  ])
+  expect(childProcess.spawn.mock.calls[0][1]).toEqual(['install', 'semver', 'express'])
   childProcess.spawn.mockReset()
 })

package/__tests__/packageRepoUtils.test.js

@@ -2,9 +2,11 @@ const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
 const fetch = require('node-fetch')
 
 jest.mock('node-fetch')
-fetch.mockImplementation(() => Promise.resolve({
-  json: () => require('./mocks/registryPackageOk.mock.json')
-}))
+fetch.mockImplementation(() =>
+  Promise.resolve({
+    json: () => require('./mocks/registryPackageOk.mock.json')
+  })
+)
 
 beforeEach(() => {
   fetch.mockClear()
@@ -62,9 +64,11 @@ test('repo utils retrieves package README information', async () => {
 
 test('repo utils retrieves package latest version as null if not exists', async () => {
   const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
-  fetch.mockReturnValue(Promise.resolve({
-    json: () => require('./mocks/registryPackageUnpublished.mock.json')
-  }))
+  fetch.mockReturnValue(
+    Promise.resolve({
+      json: () => require('./mocks/registryPackageUnpublished.mock.json')
+    })
+  )
 
   const packageRepoUtils = new PackageRepoUtils()
   const packageName = 'testPackage'
@@ -74,14 +78,16 @@ test('repo utils retrieves package latest version as null if not exists', async
 
 test('repo utils retrieves package download count', async () => {
   const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
-  fetch.mockReturnValue(Promise.resolve({
-    json: () => ({
-      downloads: 1950,
-      start: '2017-11-26',
-      end: '2017-12-25',
-      package: 'express-version-route'
+  fetch.mockReturnValue(
+    Promise.resolve({
+      json: () => ({
+        downloads: 1950,
+        start: '2017-11-26',
+        end: '2017-12-25',
+        package: 'express-version-route'
+      })
     })
-  }))
+  )
 
   const packageRepoUtils = new PackageRepoUtils()
   const packageName = 'testPackage'
@@ -91,9 +97,11 @@ test('repo utils retrieves package download count', async () => {
 
 test('repo utils retrieves package README information even when not available', async () => {
   const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
-  fetch.mockReturnValue(Promise.resolve({
-    json: () => require('./mocks/registryPackageUnpublished.mock.json')
-  }))
+  fetch.mockReturnValue(
+    Promise.resolve({
+      json: () => require('./mocks/registryPackageUnpublished.mock.json')
+    })
+  )
 
   const packageRepoUtils = new PackageRepoUtils()
   const packageName = 'testPackage'
@@ -103,9 +111,11 @@ test('repo utils retrieves package README information even when not available',
 
 test('repo utils retrieves package LICENSE information', async () => {
   const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
-  fetch.mockReturnValue(Promise.resolve({
-    json: () => require('./mocks/registryPackageOk.mock.json')
-  }))
+  fetch.mockReturnValue(
+    Promise.resolve({
+      json: () => require('./mocks/registryPackageOk.mock.json')
+    })
+  )
 
   const packageRepoUtils = new PackageRepoUtils()
   const packageName = 'testPackage'
@@ -115,12 +125,16 @@ test('repo utils retrieves package LICENSE information', async () => {
 
 test('repo utils parses package version', async () => {
   const PackageRepoUtils = require('../lib/helpers/packageRepoUtils')
-  fetch.mockReturnValue(Promise.resolve({
-    json: () => require('./mocks/registryPackageOk.mock.json')
-  }))
+  fetch.mockReturnValue(
+    Promise.resolve({
+      json: () => require('./mocks/registryPackageOk.mock.json')
+    })
+  )
 
   const packageRepoUtils = new PackageRepoUtils()
   const packageName = 'testPackage'
-  const result = await packageRepoUtils.parsePackageVersion(await packageRepoUtils.getLatestVersion(packageName))
+  const result = await packageRepoUtils.parsePackageVersion(
+    await packageRepoUtils.getLatestVersion(packageName)
+  )
   expect(result).toBeTruthy()
 })

package/__tests__/scripts.test.js

@@ -16,7 +16,11 @@ let mockIsRunningInYarn
 let mockGetNpmVersion
 
 beforeEach(() => {
-  mockGetShellConfig = jest.spyOn(helpers, 'getShellConfig').mockImplementation(() => ({ name: 'testShell', profilePath: TEST_PROFILE_PATH, aliases: TEST_ALIAS }))
+  mockGetShellConfig = jest.spyOn(helpers, 'getShellConfig').mockImplementation(() => ({
+    name: 'testShell',
+    profilePath: TEST_PROFILE_PATH,
+    aliases: TEST_ALIAS
+  }))
   // Our install script does not run when installing with yarn, but we still want to be able to run tests with yarn
   mockIsRunningInYarn = jest.spyOn(helpers, 'isRunningInYarn').mockImplementation(() => false)
   // Our install script does not run when installing with npm V7, but we still want to be able to run tests with all npm versions
@@ -88,7 +92,10 @@ test('postinstall script does not create duplicate aliases', async () => {
   await postinstall.runPostInstall()
 
   const containsAlias = await helpers.fileContains(TEST_PROFILE_PATH, TEST_ALIAS)
-  const containsDoubleAlias = await helpers.fileContains(TEST_PROFILE_PATH, `${TEST_ALIAS}${TEST_ALIAS}`)
+  const containsDoubleAlias = await helpers.fileContains(
+    TEST_PROFILE_PATH,
+    `${TEST_ALIAS}${TEST_ALIAS}`
+  )
   expect(containsAlias).toBe(true)
   expect(containsDoubleAlias).toBe(false)
 })
@@ -115,7 +122,10 @@ test('uninstall script does nothing in unknown shell', async () => {
 test('uninstall handles empty profile', async () => {
   await preuninstall.runPreUninstall()
 
-  const profileExists = await fs.promises.access(TEST_PROFILE_PATH, fs.constants.F_OK).then(() => true).catch(() => false)
+  const profileExists = await fs.promises
+    .access(TEST_PROFILE_PATH, fs.constants.F_OK)
+    .then(() => true)
+    .catch(() => false)
   expect(profileExists).toBe(false)
 })
 

package/bin/npq-hero.js

@@ -3,8 +3,7 @@
 
 // Require minimum node version or bail out
 const cliSupport = require('../lib/helpers/cliSupportHandler')
-cliSupport.isEnvSupport() ||
-  (cliSupport.noSupportError() && cliSupport.packageManagerPassthrough())
+cliSupport.isEnvSupport() || (cliSupport.noSupportError() && cliSupport.packageManagerPassthrough())
 
 const inquirer = require('inquirer')
 const yargs = require('yargs')
@@ -26,7 +25,7 @@ const marshall = new Marshall({
 
 marshall
   .process()
-  .then(result => {
+  .then((result) => {
     if (result && result.error) {
       // eslint-disable-next-line no-console
       console.log()
@@ -42,12 +41,12 @@ marshall
 
     return { install: true }
   })
-  .then(status => {
+  .then((status) => {
     if (status && status.hasOwnProperty('install') && status.install === true) {
       pkgMgr.process(PACKAGE_MANAGER_TOOL, cli.package)
     }
   })
-  .catch(error => {
+  .catch((error) => {
     // eslint-disable-next-line no-console
     console.error(error)
     process.exit(-1)

package/bin/npq.js

@@ -16,7 +16,7 @@ const marshall = new Marshall({
 
 marshall
   .process()
-  .then(result => {
+  .then((result) => {
     if (cli.dryRun) {
       process.exit(0)
     }
@@ -36,12 +36,12 @@ marshall
 
     return { install: true }
   })
-  .then(status => {
+  .then((status) => {
     if (status && status.hasOwnProperty('install') && status.install === true) {
       pkgMgr.process(cli.packageManager)
     }
   })
-  .catch(error => {
+  .catch((error) => {
     // eslint-disable-next-line no-console
     console.error(error)
     process.exit(-1)

package/lib/cli.js

@@ -14,12 +14,11 @@ const argv = yargs
     command: '--packageManager [packageManager]',
     aliases: ['--pkgMgr'],
     desc: 'the package manager to offload handling the command',
-    builder: yargs => yargs.default('packageManager', 'npm')
+    builder: (yargs) => yargs.default('packageManager', 'npm')
   })
   .command({
     command: '--dry-run',
-    desc:
-      'npq will run checks only and will not proceed with actually installing a package'
+    desc: 'npq will run checks only and will not proceed with actually installing a package'
   })
   .example('npq install express')
   .epilogue('curated by Liran Tal at https://github.com/lirantal/npq').argv

package/lib/cliCommons.js

@@ -1,4 +1,3 @@
-
 const npa = require('npm-package-arg')
 class cliCommons {
   static getInstallCommand () {
@@ -10,8 +9,10 @@ class cliCommons {
         if (argv && argv.package) {
           for (let i = 0; i < argv.package.length; i++) {
             const parsedPackage = npa(argv.package[i])
+            const versionModifier =
+              parsedPackage.fetchSpec === '*' ? 'latest' : parsedPackage.fetchSpec
             // eslint-disable-next-line security/detect-object-injection
-            argv.package[i] = `${parsedPackage.name}@${parsedPackage.fetchSpec}`
+            argv.package[i] = `${parsedPackage.name}@${versionModifier}`
           }
         }
       }

package/lib/helpers/packageRepoUtils.js

@@ -8,9 +8,7 @@ const NPM_REGISTRY_API = 'https://api.npmjs.org'
 class PackageRepoUtils {
   constructor (options = {}) {
     this.registryUrl = options.registryUrl ? options.registryUrl : NPM_REGISTRY
-    this.registryApiUrl = options.registryApiUrl
-      ? options.registryApiUrl
-      : NPM_REGISTRY_API
+    this.registryApiUrl = options.registryApiUrl ? options.registryApiUrl : NPM_REGISTRY_API
     this.pkgInfoCache = {}
   }
 
@@ -23,8 +21,8 @@ class PackageRepoUtils {
       return Promise.resolve(this.pkgInfoCache[pkg])
     } else {
       return fetch(`${this.registryUrl}/${this.formatPackageForUrl(pkg)}`)
-        .then(response => response.json())
-        .then(data => {
+        .then((response) => response.json())
+        .then((data) => {
           this.pkgInfoCache[pkg] = data
           return data
         })
@@ -32,29 +30,23 @@ class PackageRepoUtils {
   }
 
   getLatestVersion (pkg) {
-    return this.getPackageInfo(pkg)
-      .then(data => {
-        return data['dist-tags'] &&
-          data['dist-tags']['latest']
-          ? data['dist-tags']['latest']
-          : null
-      })
+    return this.getPackageInfo(pkg).then((data) => {
+      return data['dist-tags'] && data['dist-tags']['latest'] ? data['dist-tags']['latest'] : null
+    })
   }
 
   getDownloadInfo (pkg) {
     return fetch(`${this.registryApiUrl}/downloads/point/last-month/${pkg}`)
-      .then(response => response.json())
+      .then((response) => response.json())
       .then(({ downloads }) => downloads)
   }
 
   getReadmeInfo (pkg) {
-    return this.getPackageInfo(pkg)
-      .then(({ readme }) => readme)
+    return this.getPackageInfo(pkg).then(({ readme }) => readme)
   }
 
   getLicenseInfo (pkg) {
-    return this.getPackageInfo(pkg)
-      .then(({ license }) => license)
+    return this.getPackageInfo(pkg).then(({ license }) => license)
   }
 
   parsePackageVersion (version) {

package/lib/marshall.js

@@ -28,7 +28,7 @@ class Marshall {
       packageRepoUtils: this.packageRepoUtils
     }
 
-    return Marshalls.tasks(config).catch(ctx => {
+    return Marshalls.tasks(config).catch((ctx) => {
       if (ctx && ctx.context && ctx.context.marshalls) {
         return this.report(ctx.context.marshalls)
       }
@@ -69,7 +69,7 @@ class Marshall {
       const packageMessages = messages[packageName]
       console.log(`  [${chalk.red(packageName)}]`)
 
-      packageMessages.forEach(message => {
+      packageMessages.forEach((message) => {
         if (message.type === MESSAGE_TYPE.ERROR) {
           console.log(`    - ${chalk.red(message.text)}`)
         } else {
@@ -93,7 +93,7 @@ class Marshall {
 
   prepareMessages (allPackageMessages, messages, isWarning) {
     if (Array.isArray(messages) && messages.length > 0) {
-      messages.forEach(msg => {
+      messages.forEach((msg) => {
         this.appendPackageMessage(allPackageMessages, msg.pkg, {
           text: msg.message,
           type: isWarning ? MESSAGE_TYPE.WARNING : MESSAGE_TYPE.ERROR

package/lib/marshalls/age.marshall.js

@@ -16,7 +16,7 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then(data => {
+    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then((data) => {
       const pkgCreatedDate = data.time.created
       const dateDiff = Date.now() - Date.parse(pkgCreatedDate)
 

package/lib/marshalls/author.marshall.js

@@ -17,11 +17,9 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then(data => {
+    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then((data) => {
       const lastVersionData =
-        data.versions &&
-        data['dist-tags'] &&
-        data.versions[data['dist-tags']['latest']]
+        data.versions && data['dist-tags'] && data.versions[data['dist-tags']['latest']]
 
       const hasAuthorEmail =
         (lastVersionData &&
@@ -33,7 +31,7 @@ class Marshall extends BaseMarshall {
           lastVersionData.authors &&
           lastVersionData.authors.filter &&
           lastVersionData.authors.filter(
-            author => author.email && validator.isEmail(author.email).length
+            (author) => author.email && validator.isEmail(author.email).length
           ))
 
       if (!hasAuthorEmail) {

package/lib/marshalls/baseMarshall.js

@@ -29,14 +29,14 @@ class BaseMarshall {
 
   checkPackage (pkg, ctx, task) {
     return this.validate(pkg)
-      .then(data => {
+      .then((data) => {
         task.output = `querying ${pkg.packageString}...`
         ctx.marshalls[this.name].data[pkg.packageString] = data
 
         // not explicitly required, but a task can return its results
         return data
       })
-      .catch(err => {
+      .catch((err) => {
         if (err instanceof Warning) {
           this.setMessage(
             {
@@ -55,8 +55,7 @@ class BaseMarshall {
   }
 
   isEnabled () {
-    const isMarshallSilent =
-      process.env[`MARSHALL_DISABLE_${this.name.toUpperCase()}`] || false
+    const isMarshallSilent = process.env[`MARSHALL_DISABLE_${this.name.toUpperCase()}`] || false
 
     return !isMarshallSilent
   }

package/lib/marshalls/downloads.marshall.js

@@ -16,17 +16,15 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils
-      .getDownloadInfo(pkg.packageName)
-      .then(downloadCount => {
-        if (downloadCount < DOWNLOAD_COUNT_THRESHOLD) {
-          throw new Error(
-            `detected a low download-count package (downloads last month < ${DOWNLOAD_COUNT_THRESHOLD})`
-          )
-        }
+    return this.packageRepoUtils.getDownloadInfo(pkg.packageName).then((downloadCount) => {
+      if (downloadCount < DOWNLOAD_COUNT_THRESHOLD) {
+        throw new Error(
+          `detected a low download-count package (downloads last month < ${DOWNLOAD_COUNT_THRESHOLD})`
+        )
+      }
 
-        return downloadCount
-      })
+      return downloadCount
+    })
   }
 }
 

package/lib/marshalls/index.js

@@ -25,9 +25,7 @@ class Marshalls {
 
   static buildMarshallTasks (marshalls, config) {
     if (!marshalls || !Array.isArray(marshalls) || marshalls.length === 0) {
-      return Promise.reject(
-        new Error('unable to collect marshalls, or no marshalls found')
-      )
+      return Promise.reject(new Error('unable to collect marshalls, or no marshalls found'))
     }
 
     const marshallTasks = marshalls.reduce((prev, curr) => {
@@ -37,7 +35,7 @@ class Marshalls {
 
       return prev.concat({
         title: marshall.title(),
-        enabled: ctx => marshall.isEnabled(ctx),
+        enabled: (ctx) => marshall.isEnabled(ctx),
         task: (ctx, task) => {
           marshall.init(ctx, task)
           return marshall.run(ctx, task).then(() => marshall.handleMessages())
@@ -51,12 +49,12 @@ class Marshalls {
   static tasks (options) {
     return this.warmUpPackagesCache(options)
       .then(() => this.collectMarshalls())
-      .then(marshalls => {
+      .then((marshalls) => {
         return this.buildMarshallTasks(marshalls, {
           packageRepoUtils: options.packageRepoUtils
         })
       })
-      .then(tasks => {
+      .then((tasks) => {
         return this.runTasks(tasks, options)
       })
   }
@@ -64,7 +62,9 @@ class Marshalls {
   static warmUpPackagesCache (options) {
     const fetchPackagesInfoPromises = []
     options.pkgs.forEach((packageMeta) => {
-      fetchPackagesInfoPromises.push(options.packageRepoUtils.getPackageInfo(packageMeta.packageName))
+      fetchPackagesInfoPromises.push(
+        options.packageRepoUtils.getPackageInfo(packageMeta.packageName)
+      )
     })
 
     return Promise.all(fetchPackagesInfoPromises)

package/lib/marshalls/license.marshall.js

@@ -15,27 +15,17 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils
-      .getLicenseInfo(pkg.packageName)
-      .then(licenseContents => {
-        if (
-          !licenseContents ||
-          licenseContents === 'ERROR: No LICENSE data found!'
-        ) {
-          throw new Error('package has no LICENSE file available')
-        }
-
-        if (
-          licenseContents &&
-          licenseContents.indexOf('# Security holding package') === 0
-        ) {
-          throw new Error(
-            'package flagged for security issues and served as place-holder'
-          )
-        }
-
-        return licenseContents
-      })
+    return this.packageRepoUtils.getLicenseInfo(pkg.packageName).then((licenseContents) => {
+      if (!licenseContents || licenseContents === 'ERROR: No LICENSE data found!') {
+        throw new Error('package has no LICENSE file available')
+      }
+
+      if (licenseContents && licenseContents.indexOf('# Security holding package') === 0) {
+        throw new Error('package flagged for security issues and served as place-holder')
+      }
+
+      return licenseContents
+    })
   }
 }
 

package/lib/marshalls/readme.marshall.js

@@ -15,27 +15,17 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils
-      .getReadmeInfo(pkg.packageName)
-      .then(readmeContents => {
-        if (
-          !readmeContents ||
-          readmeContents === 'ERROR: No README data found!'
-        ) {
-          throw new Error('package has no README file available')
-        }
-
-        if (
-          readmeContents &&
-          readmeContents.indexOf('# Security holding package') === 0
-        ) {
-          throw new Error(
-            'package flagged for security issues and served as place-holder'
-          )
-        }
-
-        return readmeContents
-      })
+    return this.packageRepoUtils.getReadmeInfo(pkg.packageName).then((readmeContents) => {
+      if (!readmeContents || readmeContents === 'ERROR: No README data found!') {
+        throw new Error('package has no README file available')
+      }
+
+      if (readmeContents && readmeContents.indexOf('# Security holding package') === 0) {
+        throw new Error('package flagged for security issues and served as place-holder')
+      }
+
+      return readmeContents
+    })
   }
 }
 

package/lib/marshalls/repo.marshall.js

@@ -16,9 +16,13 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then(data => {
-      const lastVersionData = (data.versions && data['dist-tags'] && data['dist-tags'].latest &&
-        data.versions[data['dist-tags'].latest]) || data
+    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then((data) => {
+      const lastVersionData =
+        (data.versions &&
+          data['dist-tags'] &&
+          data['dist-tags'].latest &&
+          data.versions[data['dist-tags'].latest]) ||
+        data
       if (lastVersionData && lastVersionData.repository && lastVersionData.repository.url) {
         let urlStructure, urlOfGitRepository
         try {
@@ -27,15 +31,17 @@ class Marshall extends BaseMarshall {
         } catch (error) {
           throw new Error(`no valid repository is associated with the package`)
         }
-        return fetch(urlOfGitRepository.href)
-          .catch(() => {
-            throw new Error(`the repository associated with the package (${urlOfGitRepository.href}) does not exist or is unreachable at the moment.`)
-          })
+        return fetch(urlOfGitRepository.href).catch(() => {
+          throw new Error(
+            `the repository associated with the package (${urlOfGitRepository.href}) does not exist or is unreachable at the moment.`
+          )
+        })
       } else if (lastVersionData && lastVersionData.homepage) {
-        return fetch(lastVersionData.homepage)
-          .catch(() => {
-            throw new Error(`the homepage associated with the package (${lastVersionData.homepage}) does not exist or is unreachable at the moment.`)
-          })
+        return fetch(lastVersionData.homepage).catch(() => {
+          throw new Error(
+            `the homepage associated with the package (${lastVersionData.homepage}) does not exist or is unreachable at the moment.`
+          )
+        })
       } else {
         throw new Error('the package has no associated repository or homepage.')
       }

package/lib/marshalls/scripts.marshall.js

@@ -15,12 +15,11 @@ class Marshall extends BaseMarshall {
   }
 
   validate (pkg) {
-    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then(data => {
+    return this.packageRepoUtils.getPackageInfo(pkg.packageName).then((data) => {
       const packageVersion =
         pkg.packageVersion === 'latest'
           ? data['dist-tags'] && data['dist-tags']['latest']
-          : this.packageRepoUtils.parsePackageVersion(pkg.packageVersion)
-            .version
+          : this.packageRepoUtils.parsePackageVersion(pkg.packageVersion).version
 
       if (!packageVersion) {
         return true
@@ -35,16 +34,14 @@ class Marshall extends BaseMarshall {
       // blacklisted scripts due to possible malicious intent:
       const blacklistScripts = ['install', 'preinstall', 'postinstall']
 
-      blacklistScripts.forEach(scriptName => {
+      blacklistScripts.forEach((scriptName) => {
         if (
           packageScripts &&
           packageScripts.hasOwnProperty(scriptName) &&
           packageScripts[scriptName].length > 0
         ) {
           throw new Error(
-            `detected a possible malicious intent script, act carefully: ${scriptName}: ${
-              packageScripts[scriptName]
-            }`
+            `detected a possible malicious intent script, act carefully: ${scriptName}: ${packageScripts[scriptName]}`
           )
         }
       })

package/lib/marshalls/snyk.marshall.js

@@ -37,15 +37,16 @@ class Marshall extends BaseMarshall {
     return Promise.resolve()
       .then(() => {
         if (!pkg.packageVersion || pkg.packageVersion === 'latest') {
-          return this.packageRepoUtils
-            .getLatestVersion(pkg.packageName)
+          return this.packageRepoUtils.getLatestVersion(pkg.packageName)
         }
-      }).then((versionResolved) => {
+      })
+      .then((versionResolved) => {
         return this.getSnykVulnInfo({
           packageName: pkg.packageName,
           packageVersion: versionResolved || pkg.packageVersion
         })
-      }).then(data => {
+      })
+      .then((data) => {
         if (!data) {
           throw new Error('Unable to query vulnerabilities for packages')
         }
@@ -63,8 +64,8 @@ class Marshall extends BaseMarshall {
     const url = encodeURI(`${SNYK_TEST_URL}/${packageName}/${packageVersion}?type=json`)
 
     return fetch(url)
-      .then(response => response.json())
-      .then(data => {
+      .then((response) => response.json())
+      .then((data) => {
         // format returned results the way that the
         // official test API endpoint returns them in
         if (data && data.hasOwnProperty('totalVulns')) {
@@ -88,8 +89,8 @@ class Marshall extends BaseMarshall {
         Authorization: `token ${this.snykApiToken}`
       }
     })
-      .then(response => response.json())
-      .then(data => {
+      .then((response) => response.json())
+      .then((data) => {
         if (data && data.vulnerabilities) {
           return {
             issuesCount: data.vulnerabilities.length

package/lib/packageManager.js

@@ -13,7 +13,7 @@ class packageManager {
   static spawnPackageManager (packageManager) {
     let args = []
 
-    args = args.concat(process.argv.slice(2)).filter(item => {
+    args = args.concat(process.argv.slice(2)).filter((item) => {
       switch (item) {
         case '--packageManager':
         case '--pkgMgr':

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "npq",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "marshall your npm/yarn package installs with high quality and class 🎖",
   "bin": {
     "npq": "./bin/npq.js",
     "npq-hero": "./bin/npq-hero.js"
   },
   "scripts": {
-    "lint": "standard && eslint . --ignore-path .gitignore && yarn run lint:lockfile",
+    "lint": "standard --fix && eslint . --ignore-path .gitignore && yarn run lint:lockfile",
     "lint:lockfile": "lockfile-lint --path yarn.lock --type yarn --validate-https --allowed-hosts npm yarn",
     "test": "jest",
     "test:watch": "jest --watch",
     "coverage:view": "opn coverage/lcov-report/index.html",
     "commit": "git-cz",
+    "format": "prettier --config .prettierrc.js --write '**/*.js'",
     "docs": "yarn run docs:code && yarn run docs:api",
     "docs:api": "doxdox *.js --layout bootstrap --output docs/index.html",
     "docs:code": "docco *.js --output docs/code",
@@ -47,8 +48,10 @@
     "eslint-plugin-security": "^1.3.0",
     "husky": "^3.0.0",
     "jest": "^24.9.0",
+    "lint-staged": "^13.1.0",
     "lockfile-lint": "^2.0.1",
     "opn-cli": "^4.0.0",
+    "prettier": "^2.8.3",
     "semantic-release": "^15.0.0",
     "standard": "^12.0.0"
   },
@@ -91,7 +94,7 @@
   "husky": {
     "hooks": {
       "commit-msg": "commitlint --env HUSKY_GIT_PARAMS",
-      "pre-commit": "git status",
+      "pre-commit": "lint-staged",
       "pre-push": "yarn run lint && yarn run test",
       "post-commit": "git status",
       "post-checkout": "git status",
@@ -103,6 +106,13 @@
       "@commitlint/config-angular"
     ]
   },
+  "lint-staged": {
+    "**/*.js": [
+      "yarn run format",
+      "yarn run lint",
+      "git add"
+    ]
+  },
   "standard": {
     "env": [
       "node",
@@ -178,7 +188,7 @@
     "node-fetch": "^2.6.7",
     "npm-package-arg": "^10.1.0",
     "semver": "^7.3.8",
-    "update-notifier": "^6.0.2",
+    "update-notifier": "^5",
     "validator": "^13.6.0",
     "yargs": "^17.6.2"
   },

package/scripts/postinstall.js

@@ -29,13 +29,19 @@ const runPostInstall = async () => {
   }
 
   try {
-    console.log('Thank you for installing npq! We want to help you make conscious decisions before installing potentially dangerous packages.')
-    console.log('To do that, we can alias npm and yarn to npq, so that e.g. `npm install <package>` will first use npq to verify the package and prompt you if it finds any issues.')
-    const answers = await inquirer.prompt([{
-      type: 'confirm',
-      name: 'install',
-      message: `Do you want to add ${shellConfig.name} aliases for npm and yarn?`
-    }])
+    console.log(
+      'Thank you for installing npq! We want to help you make conscious decisions before installing potentially dangerous packages.'
+    )
+    console.log(
+      'To do that, we can alias npm and yarn to npq, so that e.g. `npm install <package>` will first use npq to verify the package and prompt you if it finds any issues.'
+    )
+    const answers = await inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'install',
+        message: `Do you want to add ${shellConfig.name} aliases for npm and yarn?`
+      }
+    ])
     if (answers['install']) {
       // eslint-disable-next-line security/detect-non-literal-fs-filename
       await fs.promises.appendFile(shellConfig.profilePath, shellConfig.aliases)

package/scripts/scriptHelpers.js

@@ -5,11 +5,11 @@ const semver = require('semver')
 
 const BASH_ZSH_ALIASES = '\nalias npm="npq-hero"\nalias yarn="NPQ_PKG_MGR=yarn npq-hero"\n'
 const SHELLS = {
-  'bash': {
+  bash: {
     profilePath: `${os.homedir()}/.bash_profile`,
     aliases: BASH_ZSH_ALIASES
   },
-  'zsh': {
+  zsh: {
     profilePath: `${os.homedir()}/.zshrc`,
     aliases: BASH_ZSH_ALIASES
   }
@@ -61,7 +61,6 @@ const getProfile = async (profilePath) => {
     return profileData
   } catch (err) {
     if (err && err.code === 'ENOENT') {
-
     } else if (err) {
       throw err
     }