Welcome to mirror list, hosted at ThFree Co, Russian Federation.

npm-usage.js « utils « lib - github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 3ecf068ed64940ef7208863b6d8ba9b1b8f13573 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
const npm = require('../npm.js')
const didYouMean = require('./did-you-mean.js')
const { dirname } = require('path')
const output = require('./output.js')
const { cmdList } = require('./cmd-list')

module.exports = (valid = true) => {
  npm.config.set('loglevel', 'silent')
  npm.log.level = 'silent'
  output(`
Usage: npm <command>

npm install        install all the dependencies in your project
npm install <foo>  add the <foo> dependency to your project
npm test           run this project's tests
npm run <foo>      run the script named <foo>
npm <command> -h   quick help on <command>
npm -l             display usage info for all commands
npm help <term>    search for help on <term> (in a browser)
npm help npm       more involved overview (in a browser)

All commands:
${npm.config.get('long') ? usages() : ('\n    ' + wrap(cmdList))}

Specify configs in the ini-formatted file:
    ${npm.config.get('userconfig')}
or on the command line via: npm <command> --key=value

More configuration info: npm help config
Configuration fields: npm help 7 config

npm@${npm.version} ${dirname(dirname(__dirname))}
`)

  if (npm.argv.length >= 1)
    output(didYouMean(npm.argv[0], cmdList))

  if (!valid)
    process.exitCode = 1
}

const wrap = (arr) => {
  var out = ['']
  var l = 0
  var line

  line = process.stdout.columns
  if (!line)
    line = 60
  else
    line = Math.min(60, Math.max(line - 16, 24))

  arr.sort(function (a, b) {
    return a < b ? -1 : 1
  })
    .forEach(function (c) {
      if (out[l].length + c.length + 2 < line)
        out[l] += ', ' + c
      else {
        out[l++] += ','
        out[l] = c
      }
    })
  return out.join('\n    ').substr(2)
}

const usages = () => {
  // return a string of <command>: <usage>
  var maxLen = 0
  return cmdList.reduce(function (set, c) {
    set.push([c, require(`./${npm.deref(c)}.js`).usage || ''])
    maxLen = Math.max(maxLen, c.length)
    return set
  }, []).sort((a, b) => {
    return a[0].localeCompare(b[0])
  }).map(function (item) {
    var c = item[0]
    var usage = item[1]
    return '\n    ' +
      c + (new Array(maxLen - c.length + 2).join(' ')) +
      (usage.split('\n').join('\n' + (new Array(maxLen + 6).join(' '))))
  }).join('\n')
}