summaryrefslogtreecommitdiff
path: root/deps/npm/lib/utils/config/describe-all.js
blob: c8a973cc0fd21c99ea62c26edec701e9a2cb3fe3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
const definitions = require('./definitions.js')
const describeAll = () => {
  // sort not-deprecated ones to the top
  /* istanbul ignore next - typically already sorted in the definitions file,
   * but this is here so that our help doc will stay consistent if we decide
   * to move them around. */
  const sort = ([keya, {deprecated: depa}], [keyb, {deprecated: depb}]) => {
    return depa && !depb ? 1
      : !depa && depb ? -1
      : keya.localeCompare(keyb, 'en')
  }
  return Object.entries(definitions).sort(sort)
    .map(([key, def]) => def.describe())
    .join(
      '\n\n<!-- automatically generated, do not edit manually -->\n' +
        '<!-- see lib/utils/config/definitions.js -->\n\n'
    )
}
module.exports = describeAll