通過nodejs實現自定義命令

scola666 發布于2019-08-21 18:23 / 1896人閱讀

摘要：通過給這些命令輸入不同的參數，可以得到相應的功能。通過篇文章，你將學會如何一步步地編寫運行在弄的環境的自定義命令。其中可以通過這條命令查詢到將配置文件中的鏈接到全局看到這里，你應該了解我們正是借助第二步，實現自定義命令的。

歡迎關注我的公眾號睿Talk，獲取我最新的文章：

一、前言

我們開發用到的一些庫都有自己特有的命令，如webpack，babel和jest等。通過給這些命令輸入不同的參數，可以得到相應的功能。通過篇文章，你將學會如何一步步地編寫運行在弄的環境的自定義命令。

二、編寫命令文件

新建一個文件夾cmd，然后建一個main.js文件，文件內容如下：

#!/usr/bin/env node

console.log("hello command");

注意一定要有這行代碼：#!/usr/bin/env node，這行代碼叫shebang或者hashbang，它會告訴操作系統在運行這個文件文件的時候，需要用node的解析器來解析。

這時候如果想直接運行這個命令，將會得到一個報錯：

需要給這個文件添加一個執行的權限：

chomd +x main.js

這樣就能正常的運行這一命令了：

下一步，我們將借助npm的特性，來給我們的命令命名。

三、使用npm定制命令

先在cmd目錄初始化npm

npm init

然后在生成的package.json文件中添加以下內容：

"bin":{
    "mycmd": "main.js"
  },

然后再運行

npm link

完成后就可以直接輸入mycmd命令得到結果了

此時你可能會感到疑惑，為什么通過npm link就能實現自定義命令呢？下面我們再詳細了解npm link的運作機制。

四、npm link

輸入命令后，npm幫我們做了以下這些工作

在全局的npm包環境中幫我們建立一個軟鏈，路徑在{prefix}/lib/node_modules/。其中prefix可以通過這條命令查詢到：

npm get prefix

將配置文件中的bins鏈接到全局：{prefix}/bin/{name}

看到這里，你應該了解我們正是借助第二步，實現自定義命令的。但第一步的命令又有什么作用呢？

npm link第一步所做的工作將會為我們本地開發工具庫帶來很大的幫助。當我們的工具庫還沒完成的時候，我們并不想將其npm publish出去，而是希望先在本地調試一下。這時候，可以進入調試的目標項目，比如cmd-test文件夾，運行以下命令：

npm link cmd

其中cmd就是我們的包名。運行完此命令后，npm會幫我們在cmd-test文件夾中的node_modules目錄下建立一個cmd的軟鏈。當然，前提是cmd-test文件夾中已經有node_modules目錄，否則會一直向上找node_modules目錄直到根目錄位置。你也可以手動建一個。

npm link cmd的效果跟npm install cmd效果是完全一樣的，我們可以使用link過來的所有功能，這對我們本地調試工具庫非常有幫助。

如果要去除這個軟鏈，執行下面的命令就可以了：

npm unlink cmd

說得有點遠了，再扯回到自定義命令上面來。如果我們希望給命令傳入參數，該如何做呢？

五、commander

我們可以借助commander這個工具，幫我們獲取到從process.argv里面傳進來的參數，使用方法也很簡單:

#!/usr/bin/env node

/**
 * Module dependencies.
 */

var program = require("commander");

program
  .version("0.1.0")
  .option("-p, --peppers", "Add peppers")
  .option("-P, --pineapple", "Add pineapple")
  .option("-b, --bbq-sauce", "Add bbq sauce")
  .option("-c, --cheese [type]", "Add the specified type of cheese [marble]", "marble")
  .parse(process.argv);

console.log("you ordered a pizza with:");
if (program.peppers) console.log("  - peppers");
if (program.pineapple) console.log("  - pineapple");
if (program.bbqSauce) console.log("  - bbq");
console.log("  - %s cheese", program.cheese);

通過option這個函數來定義支持的參數，然后在使用的時候直接通過獲取program的屬性拿到傳進來的參數。具體用法請看官方文檔：commander

六、總結

本文介紹了如何在 Node 開發環境下定制自己的命令，完成一些日常的自動化任務。如果這些任務比較通用，還可以發布到 npm，為更多的人提升效率。

GPU云服務器云服務器通過實例創建自定義鏡像自定義命令實現自定義手勢自定義如何實現

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/90415.html

用 nodejs 寫一個命令行工具：創建 react 組件的命令行工具

摘要：用寫一個命令行工具創建組件的命令行工具前言上周，同事抱怨說怎么不能像那樣，使用命令行工具來生成一個組件。為什么不能將這個過程交給程序去做呢當天晚上，我就仿照的，寫了一個生成組件的命令行工具。用 nodejs 寫一個命令行工具：創建 react 組件的命令行工具前言上周，同事抱怨說 react 怎么不能像 angular 那樣，使用命令行工具來生成一個組件。對呀，平時工作時，想要...

WelliJhon 2019-08-23 14:06 評論0 收藏0
Nodejs模塊加載與ES6模塊加載實現

摘要：以后需要引用模塊的變量函數類就在這個模塊對象的取出，即使再次進來模塊也不會重新執行，只會從緩存獲取。所以對相同模塊的再次加載都是優先緩存方式，核心模塊的緩存檢查依然優先于文件模塊。內建模塊導出啟動會生成全局變量，提供方法協助加載內建模塊。原始時代作為一門語言的引入代碼方式，相較于其他如PHP的include和require，Ruby的require，Python的import機制，...

陳江龍 2019-08-26 10:38 評論0 收藏0
gulp和webpack入門介紹

摘要：介紹說明的包管理器，用于插件管理包括安裝卸載管理依賴等使用安裝插件命令提示符執行插件名稱。總結安裝新建文件全局和本地安裝安裝插件新建文件通過命令提示符運行任務。 showImg(https://segmentfault.com/img/remote/1460000010873466); 前言眾所周知目前比較火的工具就是gulp和webpack，但webpack和gulp卻有所不同，本...

hsluoyz 2019-08-20 18:58 評論0 收藏0
十分鐘搭建centos+nodejs+nestjs+caddy+pm2線上環境

摘要：安裝及線上環境配置安裝官方安裝說明地址執行命令至此，安裝完成版本查看安裝官方文檔地址首次安裝執行命令以后創建項目只需在你需要的路徑下執行開發測試環境下直接執行以下命令啟動項目后面加上可以在修改現有文件后自動進行重啟瀏覽器輸入即可 centos+node.js+nest.js+caddy+pm2安裝及線上環境配置 node.js安裝官方安裝說明地址 https://github.com...

xiaoqibTn 2019-08-22 18:50 評論0 收藏0
webpack工程化集成React技術棧（一）

項目開始前，我們先聊一聊關于項目的一些說明。該項目起始于2017年初，當時公司主要技術棧為gulp+angular，鑒于react的火熱的生態，在公司決定研發bss管理系統時選用react開發，目的也是為react native打下基礎，以解決后期公司大前端技術棧的逐步成熟。（當時沒有選擇vue開發的主要原因是weex生態還不夠特別成熟），既然決定換新，項目的構建也跟著一起換，從gulp轉向火熱的...

tianhang 2019-08-22 14:47 評論0 收藏0