[NodeJs系列][譯]如何開始一個Node項目

今天分享一篇來自Phil Nash的文章，介紹了一些咱們在構件項目時的小技巧，文末可見原文地址

若是你對NodeJs系列感興趣，歡迎關注微信公衆號：前端神盾局

建立一個Node項目

通常狀況下我會使用npm來初始化一個全新的Node項目

npm init
複製代碼

npm會循例問我幾個問題以後便會在本地生成一個package.json文件。接下來我開始着手構建項目。

首先我會從Github倉庫拷貝一份.gitignore模版文件。以後（若是我還沒忘記的話）我一般會建立一個開源協議的文件。

顯然，這很沒有效率。

這周我有幸看到Tierney Cyren的推文:

這四個命令將我從繁瑣的手動操做中解脫出來，讓項目有了一個好的開始：

• npx license mit 經過license包下載對應的協議
• npx gitignore node使用gitignore包自動的從Github倉庫中下載相關文件
• npx covgen使用covgen包生成一份貢獻者契約，這會讓你的項目更受貢獻者的歡迎。

若是你以前從未使用過npx，請先嚐試在本地運行它，若是運行失敗，能夠經過npm下載安裝。對於一個新項目來講,npx是頗有用的，它能夠避免安裝一些只有在項目建立時纔會用到的全局依賴。

• npm init -y會接受npm init過程當中的默認選項。

爲確保npm init -y的結果是符合預期，Tierney建議咱們先配置npm init的默認項。

自定義你的npm init

npm config list能夠查看npm已有配置。grep管道能夠過濾出與npm init有關的配置項。

npm config list | grep init
複製代碼

你能夠使用命令行或者npm config edit調用編輯器來配置諸如做者的名稱、郵箱、url、開源協議以及項目版本這些默認選項。

npm set init.author.name "Your name"
npm set init.author.email "your@email.com"
npm set init.author.url "https://your-url.com"
npm set init.license "MIT"
npm set init.version "1.0.0"
複製代碼

一旦有了自定義的配置，npm init -y就會按照你的預期初始化。

建立一個初始化腳本

我對Tierney的建議作了點改進，下面是一段bash腳本，靈感來源於Tierney的推文。

function node-project {
  git init
  npx license $(npm get init.license) -o "$(npm get init.author.name)" > LICENSE
  npx gitignore node
  npx covgen "$(npm get init.author.email)"
  npm init -y
  git add -A
  git commit -m "Initial commit"
}
複製代碼

相較於Tierney的版本，這裏直接從npm init的默認值中獲取做者名稱、email以及協議類型。同時添加了git初始化的命令。

你能夠把這個函數存放在~/.bash_profile文件中，經過source ~/.bash_profile或者新建命令行窗口運行node-project去啓動它。你能夠隨意的新增刪除腳本以適應你的項目需求。

原文地址：philna.sh/blog/2019/0…