來乒躺,用心感受自己的第一個npm包

1.前言

之前總是npm install 別人的包招盲,使用別人的插件,剛好最近面試嘉冒,面試官有問曹货,自己寫過插件嗎?這不讳推,今天花了一下午的時間顶籽,搞了一下這玩意~

這里我寫了一個對話彈窗的組件,嗯银觅,因為之前用別的框架礼饱,對話框Modal總是無法改成自己想要的,于是自己寫了一個,突然一想镊绪,為何不做成一個npm 包呢匀伏,話不多說,開始吧

這里是基于vue開發(fā)的自己一個npm包蝴韭,可能寫得很菜够颠,但是我很認 (可) 真 (愛)

建議邊看我的github代碼,邊對應著就不會很懵, https://github.com/PDKSophia/p-dialog-modal

2.步驟

一: 跟平常一樣寫我們的vue代碼

二: 發(fā)布到npm上

2.1 新建一個空白文件夾

  mkdir npm // 這里文件夾名為 npm

2.2 初始化項目

進入到 npm 文件夾榄鉴,初始化項目摧找。然后會讓你填一些項目相關的信息,跟著提示填就是了牢硅。沒啥說的蹬耘。注意name不要和現(xiàn)有的其他npm包重名了,不然一會兒發(fā)Npm包的時候會失敗减余,可以先去npmjs.com搜一下有沒有重名的综苔。

  npm init

2.3 package.json

因為這是一個vue的組件包,而且使用了es6和webpack位岔,所以在devDependencies字段中如筛,應該至少加入以下依賴,下邊這是我的package.json抒抬,對應的字段杨刨,自己查一哈

{
    "name": "p-dialog-modal",
    "version": "1.0.3",
    "description": "彈窗組件,自己的第一個npm包擦剑,有些粗略和簡單",
    "main": "dist/pdkModal.min.js",
    "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "webpack-dev-server --hot --inline",
    "build": "webpack --display-error-details --config webpack.config.js"
    },
    "repository": {
    "type": "git",
    "url": "git+https://github.com/PDKSophia/p-dialog-modal.git"
    },
    "author": "PDK",
    "license": "ISC",
    "bugs": {
    "url": "https://github.com/PDKSophia/p-dialog-modal/issues"
    },
    "homepage": "https://github.com/PDKSophia/p-dialog-modal#readme",
    "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-plugin-transform-object-rest-spread": "^6.26.0",
    "babel-plugin-transform-runtime": "^6.23.0",
    "babel-polyfill": "^6.26.0",
    "babel-preset-es2015": "^6.24.1",
    "css-loader": "^0.28.7",
    "es6-promise": "^4.1.1",
    "less": "^2.7.3",
    "less-loader": "^4.0.5",
    "style-loader": "^0.19.0",
    "url-loader": "^0.6.2",
    "vue": "^2.5.9",
    "vue-hot-reload-api": "^2.2.4",
    "vue-html-loader": "^1.2.4",
    "vue-loader": "^13.5.0",
    "vue-router": "^3.0.1",
    "vue-style-loader": "^3.0.3",
    "vue-template-compiler": "^2.5.9",
    "vuex": "^3.0.1",
    "webpack": "^3.9.1",
    "webpack-dev-server": "^2.9.5"
    }
}

2.4 執(zhí)行下載依賴包

  npm install

2.5 新建 src 和 dist 文件夾

dist代表發(fā)布時的目錄妖胀,src是開發(fā)目錄。dist里面的js是到時候通過webpack打包后的文件惠勒。待會只會提交dist目錄到npm官網(wǎng)上赚抡,src不提交。

src文件夾中纠屋,我們寫一個app.vue

  <!-- app.vue -->

  <template>
    <div>
      <p>我是{{ user.name }}</p>
      <p>我來自{{ user.from }}</p>
    </div>
  </template>

  <script>
    export default {
      data () {
        return {}
      },
      props: {
        user: {
          type: Object
        }
      }
    }
  </script>

  <style scoped lang='less'>
  </style>

src文件夾中涂臣,我們寫一個index.js,目的就是把這個app導出去

  // index.js

  import NpmVue from './app.vue'
  export default NpmVue

2.6 加入webpack打包配置售担,并把src中的內(nèi)容打包進dist目錄中

在根目錄下新增webpack.config.js文件

const path = require("path");
const webpack = require("webpack");
const uglify = require("uglifyjs-webpack-plugin");
 
module.exports = {
    devtool: 'source-map',
    entry: "./src/index.js",//入口文件赁遗,就是上步驟的src目錄下的index.js文件,
    output: {
        path: path.resolve(__dirname, './dist'),//輸出路徑族铆,就是上步驟中新建的dist目錄岩四,
        publicPath: '/dist/',
        filename: 'pdkModal.min.js', // 輸出文件,對應package.json中的main字段
        libraryTarget: 'umd',
        umdNamedDefine: true
    },
    module: {
        rules: [{
                test: /\.vue$/,  
                loader: 'vue-loader'
            },
            {
                test: /\.less$/,
                use: [
                    { loader: "style-loader" },
                    { loader: "css-loader" },
                    { loader: "less-loader" }
                ]
            },
            {
                test: /\.js$/,
                exclude: /node_modules|vue\/dist|vue-router\/|vue-loader\/|vue-hot-reload-api\//,
                loader: 'babel-loader'
            },
            {
                test: /\.(png|jpg|gif|ttf|svg|woff|eot)$/,
                loader: 'url-loader',
                query: {
                    limit: 30000,
                    name: '[name].[ext]?[hash]'
                }
            }
        ]
    },
    plugins: [
        new webpack.DefinePlugin({
            "process.env": {
                NODE_ENV: JSON.stringify("production")
            }
        })
    ]
};

2.7 打包

執(zhí)行 npm run build骑素,就會在dist目錄下生成一個pdkModal.min.js,這就是我們npm包的主文件

注意炫乓,這里要修改package.json中的main字段指向的主文件信息

  npm run build

修改package.json中的main字段

  {
    ...
    "main": "dist/pdkModal.min.js" // 換成你的
  }

2.8 忽略要上的文件

新建一個文件刚夺,名為.npmignore,是不需要發(fā)布到npm的文件和文件夾末捣,規(guī)則和.gitignore一樣侠姑。如果你的項目底下有.gitignore但是沒有.npmignore,那么會使用.gitignore里面的配置

.*
*.md
*.yml
build/
node_modules/
src/
test/

2.9發(fā)布

先去npm注冊一個賬號 (一定要進行郵箱驗證)箩做,然后進入根目錄莽红,運行 npm login

它會讓你輸入你的用戶名,密碼和郵箱邦邦,若登錄成功安吁,會顯示:

  Logged in as 你的名字 on https://registry.npmjs.org/.

接著執(zhí)行 npm publish 發(fā)布到npm官網(wǎng)上

當你的包需要更新時,需要自己手動修改package.json中的version版本號燃辖,慣例是+1啦鬼店,比如1.0.0-->1.0.1。然后npm login,npm publish黔龟。即可妇智。

鏈接

這是我自己寫的包 : https://github.com/PDKSophia/p-dialog-modal

我的掘金 : https://juejin.im/user/594ca8a35188250d892f4139

我的博客: https://github.com/PDKSophia/blog.io

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市氏身,隨后出現(xiàn)的幾起案子巍棱,更是在濱河造成了極大的恐慌,老刑警劉巖蛋欣,帶你破解...
    沈念sama閱讀 221,635評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件航徙,死亡現(xiàn)場離奇詭異,居然都是意外死亡陷虎,警方通過查閱死者的電腦和手機到踏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來泻红,“玉大人夭禽,你說我怎么就攤上這事∫曷罚” “怎么了?”我有些...
    開封第一講書人閱讀 168,083評論 0 360
  • 文/不壞的土叔 我叫張陵菩彬,是天一觀的道長缠劝。 經(jīng)常有香客問我,道長骗灶,這世上最難降的妖魔是什么惨恭? 我笑而不...
    開封第一講書人閱讀 59,640評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮耙旦,結(jié)果婚禮上脱羡,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好锉罐,可當我...
    茶點故事閱讀 68,640評論 6 397
  • 文/花漫 我一把揭開白布帆竹。 她就那樣靜靜地躺著,像睡著了一般脓规。 火紅的嫁衣襯著肌膚如雪栽连。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,262評論 1 308
  • 那天侨舆,我揣著相機與錄音秒紧,去河邊找鬼。 笑死挨下,一個胖子當著我的面吹牛熔恢,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播臭笆,決...
    沈念sama閱讀 40,833評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼叙淌,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了耗啦?” 一聲冷哼從身側(cè)響起凿菩,我...
    開封第一講書人閱讀 39,736評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎帜讲,沒想到半個月后衅谷,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,280評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡似将,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,369評論 3 340
  • 正文 我和宋清朗相戀三年获黔,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片在验。...
    茶點故事閱讀 40,503評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡玷氏,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出腋舌,到底是詐尸還是另有隱情盏触,我是刑警寧澤,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布块饺,位于F島的核電站赞辩,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏授艰。R本人自食惡果不足惜辨嗽,卻給世界環(huán)境...
    茶點故事閱讀 41,870評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望淮腾。 院中可真熱鬧糟需,春花似錦屉佳、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,340評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至诅诱,卻和暖如春髓堪,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背娘荡。 一陣腳步聲響...
    開封第一講書人閱讀 33,460評論 1 272
  • 我被黑心中介騙來泰國打工干旁, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人炮沐。 一個月前我還...
    沈念sama閱讀 48,909評論 3 376
  • 正文 我出身青樓争群,卻偏偏與公主長得像,于是被迫代替她去往敵國和親大年。 傳聞我的和親對象是個殘疾皇子换薄,可洞房花燭夜當晚...
    茶點故事閱讀 45,512評論 2 359

推薦閱讀更多精彩內(nèi)容