记一次npm发包

前言

天天使用npm下包,有没有考虑是如果实现的。对于日常使用频率高的组件、方法等,来回的复制代码就很不方便,既然如此就开发一个通用的仓库,以后可以随时随地使用。

分享一下我自己的组件库 lp-vue 里面有详细的使用教程,后期会更新更多东西

新建项目

在根目录中新建packages目录,这个就是组件目录

编写组件

在packages中新建文件夹demo,这个就是demo组件,每个文件夹属于一个组件。

  • 创建组件

新建demo.vue文件

<template>
  <h1>{{ msg }}</h1>
</template>
<script>
export default {
  name: 'Demo',
  props: {
    msg: String
  },
}
</script>
  • 注册并导出组件

新建index.js文件

import Demo from './demo.vue';
Demo.install = function install(Vue) {
  Vue.component(Demo.name, Demo);
};
export default Demo;

导出组件

在packages中新建index.js文件

import Demo from './demo/index.js'
//组件列表
const components = [
  Demo
];
const install = function(Vue) {
  components.forEach(component => {
    Vue.component(component.name, component);
  });
};
/* istanbul ignore if */
if (typeof window !== 'undefined' && window.Vue) {
  install(window.Vue);
}
export default {
  install,
  Demo
};

打包组件

新建文件build/webpack.common.js,这个文件可以参考element组件库的打包方式。

const path = require("path");
const ProgressBarPlugin = require("progress-bar-webpack-plugin");
const VueLoaderPlugin = require("vue-loader/lib/plugin");
const UglifyJsPlugin = require("uglifyjs-webpack-plugin");

const config = require("./config");

module.exports = {
  mode: "production",
  entry: {
    app: ["./packages/index.js"],   //这个就是指定的入口文件
  },
  output: {
    path: path.resolve(process.cwd(), "./lib"), //目标lib
    publicPath: "/dist/",
    filename: "lp-vue.common.js",   //文件名,也是最终使用的文件
    chunkFilename: "[id].js",
    libraryExport: "default",
    library: "LPVUE",
    libraryTarget: "commonjs2",
  },
  resolve: {
    extensions: [".js", ".vue", ".json"],
    alias: config.alias,
    modules: ["node_modules"],
  },
  externals: config.externals,
  performance: {
    hints: false,
  },
  stats: {
    children: false,
  },
  optimization: {
    minimize: false,
  },
  module: {
    rules: [
      {
        test: /\.(jsx?|babel|es6)$/,
        include: process.cwd(),
        exclude: config.jsexclude,
        loader: "babel-loader",
      },
      {
        test: /\.vue$/,
        loader: "vue-loader",
        options: {
          compilerOptions: {
            preserveWhitespace: false,
          },
        },
      },
      {
        test: /\.(scss|css)$/,
        loaders: ["style-loader", "css-loader", "sass-loader"],
      },
      {
        test: /\.(svg|otf|ttf|woff2?|eot|gif|png|jpe?g)(\?\S*)?$/,
        loader: "url-loader",
        query: {
          limit: 10000,
          name: path.posix.join("static", "[name].[hash:7].[ext]"),
        },
      },
    ],
  },
  plugins: [
    new ProgressBarPlugin(),
    new VueLoaderPlugin(),
    new UglifyJsPlugin({
      uglifyOptions: {
        compress: true,
      },
    }),
  ],
};

配置package.json

{
  "name": "lp-vue", //包名
  "version": "1.0.0",   //版本
  "description": "vue2组件库&方法&指令集合", //描述
  "main": "lib/lp-vue.common.js",   //入口文件
  "files": [
    "lib"
  ],    //要上传的文件
  "scripts": {
    "common": "webpack --config build/webpack.common.js"    //打包文件
  },
  "keywords": [
    "vue2",
    "components",
    "directives",
    "methods",
    "utils",
    "lp-vue",
    "element-ui"
  ],    //关键字
  "homepage": "https://www.lingping.icu/lp-vue",    //主页地址
  "author": "lingping", //作者
  "license": "MIT", 
  "unpkg": "lib/index.js",  
  "devDependencies": {
    
  },
  "dependencies": {
   
  }
}

上传到npm库

  1. 注册账号

想要发布到npm仓库,就必须要有一个账号,先去npm官网注册一个账号,注意记住用户名、密码和邮箱,发布的时候可能会用到。

  1. 切换npm
npm config set registry=https://registry.npmjs.org
  1. 登录npm
npm login

如果没有登录会跳转去登录,也可以使用添加用户:

npm adduser
  1. 发布
npm publish

如果发布失败可能名字重复了,每次发布都需要修改版本号,发布成功后就可以去官网查看自己发布的包。

使用包

执行安装命令 npm i lp-vue

如果安装失败,可能是包没有同步的问题,一般国内会使用镜像源npmmirror,所以可以去镜像网站上查询npmmirror 镜像站

最后

发包其实很简单,就是几个命令,主要考验的是文件的编写,以及webpack、vite打包知识,这些可以多参考开源项目的打包思路。

书洞笔记

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

推荐阅读更多精彩内容