#3766

Build # #3766

Build Type

push

Committed by

Commit Message

<a href="https://github.com/npm/cli/commit/<a class=hub.com/npm/cli/commit/fdde3996b44bd44b6126560856191f096bee9425">fdde3996b<a href="https://github.com/npm/cli/commit/fdde3996b44bd44b6126560856191f096bee9425">">Merge </a><a class="double-link" href="https://github.com/npm/cli/commit/<a class="double-link" href="https://github.com/npm/cli/commit/d11cf2af55a2ba03c152fdeefab598a376c2642b">d11cf2af5</a>">d11cf2af5</a><a href="https://github.com/npm/cli/commit/fdde3996b44bd44b6126560856191f096bee9425"> into 2db3eff44">2db3eff44</a>

Run Details

3288 of 3391 branches covered (96.96%)

Branch coverage included in aggregate %.

54 of 54 new or added lines in 54 files covered. (100.0%)

5877 of 6033 relevant lines covered (97.41%)

29.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

8.2

/lib/base-command.js

// Base class for npm commands

const { relative } = require('path')

const usageUtil = require('./utils/usage.js')
const ConfigDefinitions = require('./utils/config/definitions.js')
const getWorkspaces = require('./workspaces/get-workspaces.js')

class BaseCommand {
  constructor (npm) {
    this.wrapWidth = 80
    this.npm = npm
  }

  get name () {
    return this.constructor.name
  }

  get description () {
    return this.constructor.description
  }

  get ignoreImplicitWorkspace () {
    return this.constructor.ignoreImplicitWorkspace
  }

  get usage () {
    let usage = `npm ${this.constructor.name}\n\n`
    if (this.constructor.description) {
      usage = `${usage}${this.constructor.description}\n\n`
    }

    usage = `${usage}Usage:\n`
    if (!this.constructor.usage) {
      usage = `${usage}npm ${this.constructor.name}`
    } else {
      usage = `${usage}${this.constructor.usage
        .map(u => `npm ${this.constructor.name} ${u}`)
        .join('\n')}`
    }

    if (this.constructor.params) {
      usage = `${usage}\n\nOptions:\n${this.wrappedParams}`
    }

    // Mostly this just appends aliases, this could be more clear
    usage = usageUtil(this.constructor.name, usage)
    usage = `${usage}\n\nRun "npm help ${this.constructor.name}" for more info`
    return usage
  }

  get wrappedParams () {
    let results = ''
    let line = ''

    for (const param of this.constructor.params) {
      const usage = `[${ConfigDefinitions[param].usage}]`
      if (line.length && line.length + usage.length > this.wrapWidth) {
        results = [results, line].filter(Boolean).join('\n')
        line = ''
      }
      line = [line, usage].filter(Boolean).join(' ')
    }
    results = [results, line].filter(Boolean).join('\n')
    return results
  }

  usageError (prefix = '') {
    if (prefix) {
      prefix += '\n\n'
    }
    return Object.assign(new Error(`\nUsage: ${prefix}${this.usage}`), {
      code: 'EUSAGE',
    })
  }

  async execWorkspaces (args, filters) {
    throw Object.assign(new Error('This command does not support workspaces.'), {
      code: 'ENOWORKSPACES',
    })
  }

  async setWorkspaces (filters) {
    if (this.isArboristCmd) {
      this.includeWorkspaceRoot = false
    }

    const relativeFrom = relative(this.npm.localPrefix, process.cwd()).startsWith('..')
      ? this.npm.localPrefix
      : process.cwd()

    const ws = await getWorkspaces(filters, {
      path: this.npm.localPrefix,
      includeWorkspaceRoot: this.includeWorkspaceRoot,
      relativeFrom,
    })
    this.workspaces = ws
    this.workspaceNames = [...ws.keys()]
    this.workspacePaths = [...ws.values()]
  }
}
module.exports = BaseCommand

1	// Base class for npm commands
2
3	const { relative } = require('path')	1✔
4
5	const usageUtil = require('./utils/usage.js')	1✔
6	const ConfigDefinitions = require('./utils/config/definitions.js')	1✔
7	const getWorkspaces = require('./workspaces/get-workspaces.js')	1✔
8
9	class BaseCommand {
10	constructor (npm) {
11	this.wrapWidth = 80	×
12	this.npm = npm	×
13	}
14
15	get name () {
16	return this.constructor.name	×
17	}
18
19	get description () {
20	return this.constructor.description	×
21	}
22
23	get ignoreImplicitWorkspace () {
24	return this.constructor.ignoreImplicitWorkspace	×
25	}
26
27	get usage () {
28	let usage = `npm ${this.constructor.name}\n\n`	×
29	if (this.constructor.description) {	×
30	usage = `${usage}${this.constructor.description}\n\n`	×
31	}
32
33	usage = `${usage}Usage:\n`	×
34	if (!this.constructor.usage) {	×
35	usage = `${usage}npm ${this.constructor.name}`	×
36	} else {
37	usage = `${usage}${this.constructor.usage	×
38	.map(u => `npm ${this.constructor.name} ${u}`)	×
39	.join('\n')}`
40	}
41
42	if (this.constructor.params) {	×
43	usage = `${usage}\n\nOptions:\n${this.wrappedParams}`	×
44	}
45
46	// Mostly this just appends aliases, this could be more clear
47	usage = usageUtil(this.constructor.name, usage)	×
48	usage = `${usage}\n\nRun "npm help ${this.constructor.name}" for more info`	×
49	return usage	×
50	}
51
52	get wrappedParams () {
53	let results = ''	×
54	let line = ''	×
55
56	for (const param of this.constructor.params) {	×
57	const usage = `[${ConfigDefinitions[param].usage}]`	×
58	if (line.length && line.length + usage.length > this.wrapWidth) {	×
59	results = [results, line].filter(Boolean).join('\n')	×
60	line = ''	×
61	}
62	line = [line, usage].filter(Boolean).join(' ')	×
63	}
64	results = [results, line].filter(Boolean).join('\n')	×
65	return results	×
66	}
67
68	usageError (prefix = '') {	×
69	if (prefix) {	×
70	prefix += '\n\n'	×
71	}
72	return Object.assign(new Error(`\nUsage: ${prefix}${this.usage}`), {	×
73	code: 'EUSAGE',
74	})
75	}
76
77	async execWorkspaces (args, filters) {
78	throw Object.assign(new Error('This command does not support workspaces.'), {	×
79	code: 'ENOWORKSPACES',
80	})
81	}
82
83	async setWorkspaces (filters) {
84	if (this.isArboristCmd) {	×
85	this.includeWorkspaceRoot = false	×
86	}
87
88	const relativeFrom = relative(this.npm.localPrefix, process.cwd()).startsWith('..')	×
89	? this.npm.localPrefix
90	: process.cwd()
91
92	const ws = await getWorkspaces(filters, {	×
93	path: this.npm.localPrefix,
94	includeWorkspaceRoot: this.includeWorkspaceRoot,
95	relativeFrom,
96	})
97	this.workspaces = ws	×
98	this.workspaceNames = [...ws.keys()]	×
99	this.workspacePaths = [...ws.values()]	×
100	}
101	}
102	module.exports = BaseCommand	1✔

npm / cli / #3766

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous