vite编写并发布一个react组件

听说vite已经到了2.x版本,赶紧打开文档看了看


嗯~ o( ̄▽ ̄)o,库模式?必须试试

yarn create vite

输入项目名称后,选择react回车、再选中react回车,ok,生成的目录结构如下



打开vite.config.js,默认配置如下:

import { defineConfig } from 'vite'
import reactRefresh from '@vitejs/plugin-react-refresh'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [reactRefresh()]
})

那么我们按照库模式修改配置,打包文件输出到lib/dist目录下

import { defineConfig } from 'vite'
import reactRefresh from '@vitejs/plugin-react-refresh'
import { resolve } from 'path'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [reactRefresh()],
  build: {
    lib: {
      entry: resolve(__dirname, 'components/index.jsx'),
      name: 'callduck-design',
      // formats: ['es'],
      fileName: (format) => `callduck-design.${format}.js`
    },
    rollupOptions: {
      // 确保外部化处理那些你不想打包进库的依赖
      external: ['react'],
      output: {
        // 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
        globals: {
          react: 'React'
        }
      }
    },
    outDir: 'lib/dist'
  }
})

库入口是components目录下的index.jsx文件,该文件用于导出库组件,如:

export { default as Button } from './button/button'

那么我们需要写个button组件

import React from 'react'

function Button({children}) {
  return (
    <button>{children}</button>
  )
}

export default Button

接下来就可以打包组件了,

yarn
yarn build

结果如下图:



打包后生成了两个文件



因为vite默认是生成es和umd两种类型的,如果只需要一种,可以修改配置文件中build.lib.formats选项。
文件打包好,我们需要发布到npm上,首先我们在本机登录一下npm账号
yarn login

出现下图显示表示登录成功。什么,还没npm账号?作为新时代农民工,npm账号必须注册一下(此处省略)



我们要发布的包在lib目录下,那么在该目录下添加package.json文件

  "name": "callduck-design",
  "version": "0.0.1",
  "description": "An enterprise-class UI design language and React components implementation",
  "keywords": [
    "callduck",
    "component",
    "components",
    "design",
    "framework",
    "frontend",
    "react",
    "react-component",
    "ui"
  ],
  "files": ["dist"],
  "main": "./dist/callduck-design.umd.js",
  "module": "./dist/callduck-design.es.js",
  "exports": {
    ".": {
      "import": "./dist/callduck-design.es.js",
      "require": "./dist/callduck-design.umd.js"
    }
  },
  "repository": "https://github.com/YutLee/callduck-design.git",
  "author": "YutLee",
  "license": "MIT"
}

那么我们进入到该目录

cd lib

激动人心的时刻到了,输入发布命令

yarn publish

结果... ...



什么,竟然报错了,好吧,原来是镜像搞的鬼
切换回原镜像


OK,重新yarn publish


打开浏览器,进入https://www.npmjs.com/,登录账号,进入到packages查看是否上传成功
QQ截图20210826155829.png

发布后,我们就可以使用这个包了,就在刚才的项目里引用试试

yarn add callduck-design

到src/app.jsx文件里引用这个组件

import React from 'react'
import './app.css'
import { Button } from 'callduck-design'

function App() {
  return (
    <Button>CallDuck Design</Button>
  )
}

export default App

回到命令行,启动项目

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

推荐阅读更多精彩内容