前端vue组件库开发注意点

初始化

文件目录

- packages  #组件
- cli  # 脚手架,一件添加新组件的文件,包括文档里的文件
- docs  # 文档
- play  #  组件开发环境
  1. 使用pnpm 的workspace, 需要pnpm-workspace.yaml 和package.json里配置有哪些包。

pnpm-workspace.yaml

packages:
  - packages/*
  - cli
  - docs
  - play
  # exclude packages that are inside test directories
  - '!**/test/**'

package.json

"workspaces": [
    "packages/*",
    "cli",
    "docs",
    "play"
  ],
  1. package.json要设置type为module

  2. 不需要创建一个 .npmrc 文件,配置 shamefully-hoist 为 true(扁平结构), 因为使用pnpm就避免了这个问题。

  3. 使用 npx eslint --init 初始化 ESLint 配置, 后面的自动下载会失败,可以手动复制,加上 -D -w下载。后面的开发可以配合vite-plugin-eslint强制代码风格正确。

打包注意事项

  1. 尽量打包到dist里,不要改成其他如lib,可能外部项目导致无法导出子文件(我这里导不出style.css)

  2. package.json要正确加上配置

"type": "module",
  "main": "./dist/hj-ui-plus.umd.js",
  "module": "./dist/hj-ui-plus.es.js",
  "types": "./dist/hj-ui-plus/index.d.ts",
  "files": [
    "./dist",
    "package.json",
    "README.md"
  ],
  "exports": {
    ".": {
      "types": "./dist/hj-ui-plus/index.d.ts", // 虽然上面加了,但这里还要加,不然typescript会报错(虽然可以在tsconfig.json里的compilerOptions改"noImplicitAny": false,但这样及降低健壮性了)
      "require": "./dist/hj-ui-plus.umd.js",
      "import": "./dist/hj-ui-plus.es.js"
    },
    "./*": "./*"  // 这个也必须加,不然也导不出子项目
  },

发布gihub page

可以用包 gh-pages

不过要注意项目的.git - config 里的url要是ssh的地址,不然命令行运行时会报错443。

遇见一奇怪错误,features文案中有<script setup>的话编译生产后,主页会报读locales错误,还无法点击跳转。vitepress版本1.0.0-rc.30

基本框例子: https://github.com/Garyhjj/hj-ui-plus

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

推荐阅读更多精彩内容