project-name-generator中文文档|project-name-generator js中文教程|解析

npm npmdoc 2年前 (2021-12-21) 389次浏览

project-name-generator中文文档|project-name-generator js中文教程|解析

安装命令:npm i project-name-generator

项目名称生成器

生成古怪的名字,如spiffy-waterfallsassy-breadmature-dew-8239以用于任何需要随机但令人难忘的名字的地方。

对对象名称、临时文件夹、密码、项目名称、唯一 ID 等有用

安装

npm install project-name-generator --save

快速开始

var generate = require('project-name-generator');
 
generate().dashed; // 'uptight-guitar'
 
generate().spaced; // 'grandiose clam'
 
generate().raw; // ['deluxe', 'grandmother']
 
generate({ number: true }).dashed; // 'disgraceful-temper-7794'
 
generate({ words: 4 }).raw; // ['tiny', 'crabby', 'wired', 'quicksand']
 
generate({ words: 4, number: true }).dashed; // 'breakable-judicious-luxuriant-tax-3931'
 
generate({ words: 2, alliterative: true }).spaced; // 'elegant experience'
 

快速入门 CLI

这个包包含一个 cli 脚本。您可以使用 npm 全局拉入包
npm install -g project-name-generator

从命令行调用

$ project-name-generator
{ raw: [ 'spry', 'bath' ],
  dashed: 'spry-bath',
  spaced: 'spry bath' }

对于 CLI 选项

project-name-generator -h

Usage: project-name-generator [options]


Options:

  -V, --version          output the version number
  -w, --words [num]      number of words [2]
  -n, --numbers          use numbers
  -a, --alliterative     use alliterative
  -o, --output [output]  output type [raw|dashed|spaced]
  -h, --help             output usage information

应用程序接口

该模块返回单个函数, generate(options)

generate()不带参数调用将返回一个对象:

{
    raw: ['whispering', 'valley'],
    dashed: 'whispering-valley',
    spaced: 'whispering valley'
}

options参数对象可以有属性

  • words (number) – 生成的单词数(不包括数字)。所有单词都是形容词,除了最后一个是名词。默认为2
  • number (boolean) – 是否生成数字后缀。该数字介于 1 – 9999 之间,包括 1 和 9999。默认为false
  • 头韵(boolean) – 是否输出以相同字母开头的单词。默认为false

generate({ words: 3 }) 将返回:

{
    raw: ['harmonious', 'endurable', 'substance'],
    dashed: 'harmonious-endurable-substance',
    spaced: 'harmonious endurable substance'
}

generate({ words: 5, number: true }) 将返回:

{
  raw: [ 'exciting', 'cooperative', 'legal', 'lackadaisical', 'blood', 4099 ],
  dashed: 'exciting-cooperative-legal-lackadaisical-blood-4099',
  spaced: 'exciting cooperative legal lackadaisical blood 4099'
}

generate({ words: 2, number: false, alliterative: true }) 将返回:

{
  raw: [ 'elegant', 'experience' ],
  dashed: 'elegant-experience',
  spaced: 'elegant experience'
}

测试

在本地运行测试:

npm install

npm test

该库已使用 Node.js 12.18.4 进行测试

地位

依赖项的最新程度如何?

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:project-name-generator中文文档|project-name-generator js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}