创建自定义Create React App Template

Create React App(简称CRA)是一个官方支持的创建 React 单页应用程序的方法。它提供了一个快速开始搭建项目脚手架的方法。但是官方只提供了 cra-templatecra-template-typescript 这两个基本的模版。它不包含 React Router, React Redux, linter, prettier等我们开发中经常用到的依赖以及配置,然后我们在开始一个项目的时候不得不一个个地安装,配置这些依赖,非常浪费时间。但是现在我们可以通过自定义CRA tempate来解决这个问题了。当然你也可以在 npm 官网上通过搜索“cra-template”来找到很多优秀的CRA template来供自己使用。

创建自己的CRA template

  1. 新建项目(在这个例子中,假定我们的模版名称为spring)
yarn create react-app cra-template-spring
  1. 添加你需要的任何依赖以及配置
  2. 创建模版

3.1 创建 template/ 目录

mkdir template/

3.2 将根目录的.gitignore文件复制到 template/目录, 注意放到template目录下的gitignore文件不要以“.”开头

cp .gitignore template/gitignore

3.3 在根目录创建template.json,注意是根目录,这是一个容易出错的地方,放到template目录下的话是无效的。

{
  "package": {
    "dependencies": {
      "@ant-design/icons": "^4.6.2",
      "@reduxjs/toolkit": "^1.5.1",
      "@testing-library/jest-dom": "^5.11.4",
      "@testing-library/react": "^11.1.0",
      "@testing-library/user-event": "^12.1.10",
      "@types/jest": "^26.0.22",
      "@types/node": "^14.14.37",
      "@types/react": "^17.0.3",
      "@types/react-dom": "^17.0.3",
      "antd": "^4.15.0",
      "babel-plugin-import": "^1.13.3",
      "less": "^3.11.1",
      "less-loader": "^6.1.0",
      "react": "^17.0.2",
      "react-dom": "^17.0.2",
      "react-redux": "^7.2.3",
      "react-router-dom": "^5.2.0",
      "react-scripts": "4.0.3",
      "redux": "^4.0.5",
      "redux-logger": "^3.0.6",
      "redux-thunk": "^2.3.0",
      "typescript": "^4.2.3",
      "web-vitals": "^1.0.1"
    },
    "scripts": {
      "start": "react-app-rewired start",
      "build": "react-app-rewired build",
      "test": "react-app-rewired test",
      "eject": "react-scripts eject"
    },
    "devDependencies": {
      "@types/react-redux": "^7.1.16",
      "@types/react-router-dom": "^5.1.7",
      "@types/redux-logger": "^3.0.8",
      "customize-cra": "^1.0.0",
      "react-app-rewired": "^2.1.8"
    }
  }
}

3.4 将 src 和 public 目录 复制到 template目录下

cp -a ./src/. template/src && cp -a ./public/. template/public

3.5 将其他根目录下的各种配置文件复制到 template目录,如 tsconfig.json, paths.json等

修改项目配置,准备发布到npm

  1. 在package.json中添加 license, author, description, keywords, repository等meta信息
  2. 在package.json中添加 main, files项
{
  "main": "template.json",
  "files": [
    "template",
    "template.json"
  ]
}
  1. 你还可以添加一些自动化的脚本来方便以后模版的更新和升级
{
    "clean-files": "rm -rf ./template/public ./template/src",
    "copy-files": "cp -a ./src/. template/src && cp -a ./public/. template/public",
    "prepublishOnly": "yarn clean-files && yarn copy-files"
}

在本地测试你的CRA tempate

yarn create-react-app my-app --template file:../path/to/your/template/

发布到NPM

将包到npm的需要有npm账号,你可以自己注册一个
如果已经有npm账号,先登陆,然后发布即可

npm login
npm publish --access public

等你的CRA tempate发布成功后,就可以尝试用它创建一个新的项目了,

npx create-react-app my-app --template spring
#or
yarn create react-app my-app --template spring

最后安利一个作者本人创建的CRA template: Spring
它包含了 react-app-rewired, antd, react-router-dom, redux, typescript, redux-thunk, redux-logger等依赖和配置,可以用于快速开始一个小的react项目。

附参考链接

Create React App
How to create custom Create React App (CRA) templates

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容