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

資訊專欄INFORMATION COLUMN

用 nodejs 寫一個命令行工具 :創(chuàng)建 react 組件的命令行工具

WelliJhon / 1041人閱讀

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

用 nodejs 寫一個命令行工具 :創(chuàng)建 react 組件的命令行工具 前言

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

api 設(shè)計 0.1.0 版本的 rcli 參照 angular-cli 的設(shè)計,有兩個功能:

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

使用 rcli g component MyComponent 命令, 創(chuàng)建一個 MyComponent 組件, 這個組件是一個文件夾,在文件夾中包含 index.jsMyComponent.jsMyComponent.css 三個文件

后來發(fā)現(xiàn) rcli g component MyComponent 命令在 平時開發(fā)過程中是不夠用的,因為這個命令只是創(chuàng)建了一個類組件,且繼承自 React.Component

在平時開發(fā) 過程中,我們會用到這三類組件:

繼承自 React.Component 的類組件

繼承自 React.PureComponent 的類組件

函數(shù)組件(無狀態(tài)組件)

注: 將來可以使用 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 來創(chuàng)建一個應(yīng)用
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
生成類組件(有狀態(tài)組件)
rcli g -c MyNewComponent

等于:

rcli g -c ./MyNewComponent
生成函數(shù)組件(無狀態(tài)組件)
rcli g -c MyNewComponent -s
生成組件不在文件夾內(nèi)(也不包含 css 文件和 index.js 文件)
# 默認生成的組件都會都包含在文件夾中的,若不想生成的組件被文件夾包含,則加上 --no-folder 選項
rcli g -c MyNewComponent --no-folder
實現(xiàn)過程 1. 創(chuàng)建項目

創(chuàng)建名為 hileix-rcli 的項目

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

在項目根創(chuàng)建 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 命令,創(chuàng)建軟鏈接指向到本項目的 index.js 文件。這樣,就能再開發(fā)的時候,直接使用 rcli 命令直接進行測試 ~

2. rcli 會依賴一些包:

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

cross-spawn:nodejs spawn 的跨平臺的版本。主要用來創(chuàng)建子進程執(zhí)行一些命令

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

path:nodejs path 模塊

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

3.實現(xiàn) rcli new PROJECT-NAME
#!/usr/bin/env node

"use strict";

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

// new command
program
  // 定義 new 命令,且后面跟一個必選的 projectName 參數(shù)
  .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")
  // 定義執(zhí)行 new 命令后調(diào)用的回調(diào)函數(shù)
  // 第一個參數(shù)便是在定義 new 命令時的必選參數(shù) projectName
  // cmd 中包含了命令中選項的值,當我們在 new 命令中使用了 --use-npm 選項時,cmd 中的 useNpm 屬性就會為 true,否則為 undefined
  .action(function(projectName, cmd) {
    const isUseNpm = cmd.useNpm ? true : false;
    // 創(chuàng)建 react app
    createReactApp(projectName, isUseNpm);
  });

program.parse(process.argv);

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

上面的代碼邊實現(xiàn)了 rcli new PROJECT-NAME 的功能:

#!/usr/bin/env node 表示使用 node 執(zhí)行本腳本

4.實現(xiàn) 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 選項,接受一個必選參數(shù) 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 選項:表示當使用該選項時,組件為無狀態(tài)的函數(shù)組件
  .option(
    "-s, --stateless",
    "Whether the component is a extend from PureComponent"
  )
  // 定義執(zhí)行 g 命令后調(diào)用的回調(diào)函數(shù)
  .action(function(cmd) {
    // 當 -c 選項沒有傳參數(shù)進來時,報錯、退出
    if (!cmd.componentName) {
      log(chalk.red("error: missing required argument `componentName`"));
      process.exit(1);
    }
    // 創(chuàng)建組件
    createComponent(
      cmd.componentName,
      cmd.folder,
      cmd.stateless,
      cmd.pureComponent
    );
  });

program.parse(process.argv);

/**
 * 創(chuàng)建組件
 * @param {string} componentName 組件名稱
 * @param {boolean} hasFolder 是否含有文件夾
 * @param {boolean} isStateless 是否是無狀態(tài)組件
 * @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;
  // 無狀態(tài)組件
  if (isStateless) {
    component = getStatelessComponent(componentName, hasFolder);
  } else {
    // 有狀態(tài)組件
    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 "省略...";
}

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

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

這樣就實現(xiàn)了 rcli g [options] 命令的功能

總結(jié)

api 設(shè)計是很重要的:好的 api 設(shè)計能讓使用者更加方便地使用,且變動少

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

文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/100082.html

相關(guān)文章

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

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

    maxmin 評論0 收藏0
  • webpack工程化集成React技術(shù)棧(一)

    項目開始前,我們先聊一聊關(guān)于項目的一些說明。該項目起始于2017年初,當時公司主要技術(shù)棧為gulp+angular,鑒于react的火熱的生態(tài),在公司決定研發(fā)bss管理系統(tǒng)時選用react開發(fā),目的也是為react native打下基礎(chǔ),以解決后期公司大前端技術(shù)棧的逐步成熟。(當時沒有選擇vue開發(fā)的主要原因是weex生態(tài)還不夠特別成熟),既然決定換新,項目的構(gòu)建也跟著一起換,從gulp轉(zhuǎn)向火熱的...

    tianhang 評論0 收藏0
  • react+express項目

    摘要:暴露所有內(nèi)建配置,項目下會新增或?qū)Σ糠峙渲梦募M行修改。開發(fā)環(huán)境開發(fā)時,前端項目和后端項目運行時端口端口不同,存在跨域問題。項目目錄結(jié)構(gòu)優(yōu)化項目目錄結(jié)構(gòu)優(yōu)化開發(fā)目錄主要是目錄,因此需要修改的目錄主要是目錄。 1 開發(fā)環(huán)境準備(windows) 1.1 安裝nodejs和npm 1) 下載nodejs安裝包:http://nodejs.org/en/download/ nodejs安...

    Luosunce 評論0 收藏0

發(fā)表評論

0條評論

WelliJhon

|高級講師

TA的文章

閱讀更多
最新活動
閱讀需要支付1元查看
<