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

WelliJhon 發布于2019-08-23 14:06 / 1045人閱讀

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

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

上周，同事抱怨說 react 怎么不能像 angular 那樣，使用命令行工具來生成一個組件。對呀，平時工作時，想要創建一個 react 的組件，都是直接 copy 一個組件，然后做一些修改。為什么不能將這個過程交給程序去做呢？當天晚上，我就仿照 angular-cli 的 api，寫了一個生成 react 組件的命令行工具 rcli。在這里記錄一下實現的過程。

api 設計 0.1.0 版本的 rcli 參照 angular-cli 的設計，有兩個功能：

使用 rcli new PROJECT-NAME 命令，創建一個 react 項目，其中生成項目的腳手架當然是 create-react-app 啦

使用 rcli g component MyComponent 命令，創建一個 MyComponent 組件，這個組件是一個文件夾，在文件夾中包含 index.js、MyComponent.js、MyComponent.css 三個文件

后來發現 rcli g component MyComponent 命令在平時開發過程中是不夠用的，因為這個命令只是創建了一個類組件，且繼承自 React.Component。

在平時開發過程中，我們會用到這三類組件：

繼承自 React.Component 的類組件

繼承自 React.PureComponent 的類組件

函數組件（無狀態組件）

注：將來可以使用 Hooks 來代替之前的類組件

于是就有了 0.2.0 版本的 rcli

0.2.0 版本的 rcli 用法

Usage: rcli [command] [options]

Commands:
  new 
  g 

`new` command options:
  -n, --use-npm                    Whether to use npm to download dependencies

`g` command options:
  -c, --component   The name of the component
  --no-folder                      Whether the component have not it"s own folder
  -p, --pure-component             Whether the component is a extend from PureComponent
  -s, --stateless                  Whether the component is a stateless component

使用 create-react-app 來創建一個應用

rcli new PROJECT-NAME
cd PROJECT-NAME
yarn start

或者你可以使用 npm 安裝依賴

rcli new PROJECT-NAME --use-npm
cd PROJECT-NAME
npm start

生成純組件（繼承自 PureComponent，以提高性能）

rcli g -c MyNewComponent -p

生成類組件（有狀態組件）

rcli g -c MyNewComponent

等于：

rcli g -c ./MyNewComponent

生成函數組件（無狀態組件）

rcli g -c MyNewComponent -s

生成組件不在文件夾內（也不包含 css 文件和 index.js 文件）

# 默認生成的組件都會都包含在文件夾中的，若不想生成的組件被文件夾包含，則加上 --no-folder 選項
rcli g -c MyNewComponent --no-folder

實現過程 1. 創建項目

創建名為 hileix-rcli 的項目

在項目根目錄使用 npm init -y 初始化一個 npm package 的基本信息（即生成 package.json 文件）

在項目根創建 index.js 文件，用來寫用戶輸入命令后的主要邏輯代碼

編輯 package.json 文件，添加 bin 字段：

{
  "name": "hileix-rcli",
  "version": "0.2.0",
  "description": "",
  "main": "index.js",
  "bin": {
    "rcli": "./index.js"
  },
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/hileix/rcli.git"
  },
  "keywords": [],
  "author": "hileix <304192604@qq.com> (https://github.com/hileix)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/hileix/rcli/issues"
  },
  "homepage": "https://github.com/hileix/rcli#readme",
  "dependencies": {
    "chalk": "^2.4.1",
    "commander": "^2.19.0",
    "cross-spawn": "^6.0.5",
    "fs-extra": "^7.0.1"
  }
}

在項目根目錄下，使用 npm link 命令，創建軟鏈接指向到本項目的 index.js 文件。這樣，就能再開發的時候，直接使用 rcli 命令直接進行測試 ~

2. rcli 會依賴一些包：

commander：tj 大神寫的一款專門處理命令行的工具。主要用來解析用戶輸入的命令、選項

cross-spawn：nodejs spawn 的跨平臺的版本。主要用來創建子進程執行一些命令

chalk：給命令行中的文字添加樣式。

path：nodejs path 模塊

fs-extra：提供對文件操作的方法

3.實現 rcli new PROJECT-NAME

#!/usr/bin/env node

"use strict";

const program = require("commander");
const log = console.log;

// new command
program
  // 定義 new 命令，且后面跟一個必選的 projectName 參數
  .command("new ")
  // 對 new 命令的描述
  .description("use create-react-app create a app")
  // 定義使用 new 命令之后可以使用的選項 -n（使用 npm 來安裝依賴）
  // 在使用 create-react-app 中，我們可以可以添加 --use-npm 選項，來使用 npm 安裝依賴（默認使用 yarn 安裝依賴）
  // 所以，我將這個選項添加到了 rcli 中
  .option("-n, --use-npm", "Whether to use npm to download dependencies")
  // 定義執行 new 命令后調用的回調函數
  // 第一個參數便是在定義 new 命令時的必選參數 projectName
  // cmd 中包含了命令中選項的值，當我們在 new 命令中使用了 --use-npm 選項時，cmd 中的 useNpm 屬性就會為 true，否則為 undefined
  .action(function(projectName, cmd) {
    const isUseNpm = cmd.useNpm ? true : false;
    // 創建 react app
    createReactApp(projectName, isUseNpm);
  });

program.parse(process.argv);

/**
 * 使用 create-react-app 創建項目
 * @param {string} projectName 項目名稱
 * @param {boolean} isUseNpm 是否使用 npm 安裝依賴
 */
function createReactApp(projectName, isUseNpm) {
  let args = ["create-react-app", projectName];
  if (isUseNpm) {
    args.push("--use-npm");
  }
  // 創建子進程，執行 npx create-react-app PROJECT-NAME [--use-npm] 命令
  spawn.sync("npx", args, { stdio: "inherit" });
}

上面的代碼邊實現了 rcli new PROJECT-NAME 的功能：

#!/usr/bin/env node 表示使用 node 執行本腳本

4.實現 rcli g [options]

#!/usr/bin/env node

"use strict";
const program = require("commander");
const spawn = require("cross-spawn");
const chalk = require("chalk");
const path = require("path");
const fs = require("fs-extra");

const log = console.log;

program
  // 定義 g 命令
  .command("g")
  // 命令 g 的描述
  .description("Generate a component")
  // 定義 -c 選項，接受一個必選參數 componentName：組件名稱
  .option("-c, --component-name ", "The name of the component")
  // 定義 --no-folder 選項：表示當使用該選項時，組件不會被文件夾包裹
  .option("--no-folder", "Whether the component have not it is own folder")
  // 定義 -p 選項：表示當使用該選項時，組件為繼承自 React.PureComponent 的類組件
  .option(
    "-p, --pure-component",
    "Whether the component is a extend from PureComponent"
  )
  // 定義 -s 選項：表示當使用該選項時，組件為無狀態的函數組件
  .option(
    "-s, --stateless",
    "Whether the component is a extend from PureComponent"
  )
  // 定義執行 g 命令后調用的回調函數
  .action(function(cmd) {
    // 當 -c 選項沒有傳參數進來時，報錯、退出
    if (!cmd.componentName) {
      log(chalk.red("error: missing required argument `componentName`"));
      process.exit(1);
    }
    // 創建組件
    createComponent(
      cmd.componentName,
      cmd.folder,
      cmd.stateless,
      cmd.pureComponent
    );
  });

program.parse(process.argv);

/**
 * 創建組件
 * @param {string} componentName 組件名稱
 * @param {boolean} hasFolder 是否含有文件夾
 * @param {boolean} isStateless 是否是無狀態組件
 * @param {boolean} isPureComponent 是否是純組件
 */
function createComponent(
  componentName,
  hasFolder,
  isStateless = false,
  isPureComponent = false
) {
  let dirPath = path.join(process.cwd());
  // 組件在文件夾中
  if (hasFolder) {
    dirPath = path.join(dirPath, componentName);

    const result = fs.ensureDirSync(dirPath);
    // 目錄已存在
    if (!result) {
      log(chalk.red(`${dirPath} already exists`));
      process.exit(1);
    }
    const indexJs = getIndexJs(componentName);
    const css = "";
    fs.writeFileSync(path.join(dirPath, `index.js`), indexJs);
    fs.writeFileSync(path.join(dirPath, `${componentName}.css`), css);
  }
  let component;
  // 無狀態組件
  if (isStateless) {
    component = getStatelessComponent(componentName, hasFolder);
  } else {
    // 有狀態組件
    component = getClassComponent(
      componentName,
      isPureComponent ? "React.PureComponent" : "React.Component",
      hasFolder
    );
  }

  fs.writeFileSync(path.join(dirPath, `${componentName}.js`), component);
  log(
    chalk.green(`The ${componentName} component was successfully generated!`)
  );
  process.exit(1);
}

/**
 * 獲取類組件字符串
 * @param {string} componentName 組件名稱
 * @param {string} extendFrom 繼承自："React.Component" | "React.PureComponent"
 * @param {boolean} hasFolder 組件是否在文件夾中（在文件夾中的話，就會自動加載 css 文件）
 */
function getClassComponent(componentName, extendFrom, hasFolder) {
  return "省略...";
}

/**
 * 獲取無狀態組件字符串
 * @param {string} componentName 組件名稱
 * @param {boolean} hasFolder 組件是否在文件夾中（在文件夾中的話，就會自動加載 css 文件）
 */
function getStatelessComponent(componentName, hasFolder) {
  return "省略...";
}

/**
 * 獲取 index.js 文件內容
 * @param {string} componentName 組件名稱
 */
function getIndexJs(componentName) {
  return `import ${componentName} from "./${componentName}";
export default ${componentName};
`;
}

這樣就實現了 rcli g [options] 命令的功能

總結

api 設計是很重要的：好的 api 設計能讓使用者更加方便地使用，且變動少

當自己想不到該怎么設計 api 時，可以參考別人的 api，看看別人是怎么設計的好用的

GPU云服務器云服務器命令行工具 php命令行工具命令行ddos工具linux 服務器命令行管理工具

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

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

GitHub 值得收藏的前端項目[每月更新...]

摘要：也是一款優秀的響應式框架站點所使用的一套框架為微信服務量身設計的一套框架一組很小的，響應式的組件，你可以在網頁的項目上到處使用一個可定制的文件，使瀏覽器呈現的所有元素，更一致和符合現代標準。 GitHub 值得收藏的前端項目整理與收集的一些比較優秀github項目，方便自己閱讀，順便分享出來，大家一起學習，本篇文章會持續更新，版權歸原作者所有。歡迎github star與fork 預...

maxmin 2019-08-29 16:07 評論0 收藏0
webpack工程化集成React技術棧（一）

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

tianhang 2019-08-22 14:47 評論0 收藏0
react+express項目

摘要：暴露所有內建配置，項目下會新增或對部分配置文件進行修改。開發環境開發時，前端項目和后端項目運行時端口端口不同，存在跨域問題。項目目錄結構優化項目目錄結構優化開發目錄主要是目錄，因此需要修改的目錄主要是目錄。 1 開發環境準備（windows） 1.1 安裝nodejs和npm 1) 下載nodejs安裝包：http://nodejs.org/en/download/ nodejs安...

Luosunce 2019-08-23 14:13 評論0 收藏0

發表評論

登陸后可評論

0條評論

WelliJhon

男|高級講師

我要關注我要私信

TA的文章

tensorflow算法

閱讀 1253·2023-04-25 18:57
tensor.unsqueeze

閱讀 2138·2023-04-25 16:28
ffmpeg獲取視頻截圖

閱讀 3940·2021-11-24 09:39
如何識別圖片文字，PaddleOCR機器學習開源項目使用 | 機器學習

閱讀 3638·2021-11-16 11:45
【Python爬蟲】手把手帶你爬下肯德基官網（ajax的post請求）

閱讀 1827·2021-10-13 09:40
組件設計漫談

閱讀 1267·2019-08-30 15:52
彈性盒模型

閱讀 1723·2019-08-30 10:57
Canvas + WebSocket + Redis 實現一個視頻彈幕

閱讀 663·2019-08-29 16:55

国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！

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

使用 create-react-app 來創建一個應用

生成純組件（繼承自 PureComponent，以提高性能）

生成類組件（有狀態組件）

生成函數組件（無狀態組件）

生成組件不在文件夾內（也不包含 css 文件和 index.js 文件）

相關文章

GitHub 值得收藏的前端項目[每月更新...]

**webpack工程化集成React技術棧（一）**

react+express項目

發表評論

0條評論

WelliJhon

男|高級講師

TA的文章

tensorflow算法

tensor.unsqueeze

ffmpeg獲取視頻截圖

如何識別圖片文字，PaddleOCR機器學習開源項目使用 | 機器學習

【Python爬蟲】手把手帶你爬下肯德基官網（ajax的post請求）

組件設計漫談

彈性盒模型

Canvas + WebSocket + Redis 實現一個視頻彈幕

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！

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

使用 create-react-app 來創建一個應用

生成純組件（繼承自 PureComponent，以提高性能）

生成類組件（有狀態組件）

生成函數組件（無狀態組件）

生成組件不在文件夾內（也不包含 css 文件和 index.js 文件）

相關文章

發表評論

0條評論

男|高級講師

TA的文章

最新活動

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