從0開始發(fā)布一個NPM包

(這篇文章以React為例,其他框架類同古劲。)

預備工作

  1. 首先初始化一個React項目掰曾,也可以直接Fork我之前用React初始化的一個Demo桶雀。這個Demo之前也寫過一篇文章介紹辕狰,目的就是讓大家真正理解每一步的由來改备。從0開始利用Webpack搭建React Demo控漠。
  2. NPM官網(wǎng),注冊個人賬號蔓倍。
  3. 給自己的NPM包取一個名字悬钳,并且通過搜索你取的這個名字的方式在NPM官網(wǎng)驗證這個名字是否存在,如果存在需要重新?lián)Q一個獨一無二的名字偶翅。確定名字之后默勾,將package.json文件的name 換成你確定的名字,例如我作為案例的組件名:react-components-calendar 聚谁。

開始開發(fā)

  1. 根據(jù)我Demo里面的目錄結(jié)構(gòu)母剥,建議先在components目錄開發(fā)我們的組件,然后在page目錄進行引用形导。

  2. 配置webpack.config.js

      entry: {
        app: ['./src/main.js'],
        component: ['./components/index.js']
      },
      output: {
        path: path.resolve(__dirname, '../build'),
        filename: '[name].js',
        publicPath: "/build/",
        libraryTarget: 'umd',
        library: 'Calendar'
      },
      externals: {
        'react': 'react',
        'react-dom': 'react-dom'
      }
    

    在Demo的基礎上环疼,主要做了三項改進:

    1. 入口entry項新增了component這一項目,用來作為我們開發(fā)的組件的入口朵耕。

    2. 輸出output項filename文件名采用[name]獲取entry的鍵名作為文件名炫隶。libraryTarget為確定你打包后的文件,模塊組織是遵循的什么規(guī)范阎曹,可選項有:

      "var" - Export by setting a variable: var Library = xxx (default)
      "this" - Export by setting a property of this: this["Library"] = xxx
      "commonjs" - Export by setting a property of exports: exports["Library"] = xxx
      "commonjs2" - Export by setting module.exports: module.exports = xxx
      "amd" - Export to AMD (optionally named - set the name via the library option)
      "umd" - Export to AMD, CommonJS2 or as property in root
      

      一般采用通用類型umd伪阶。library用來指定你使用require時的模塊名。

    3. 擴展externals处嫌,這項配置不處理的某些以依賴庫栅贴。比如,我們的組件是基于React的熏迹,如果我們的組件也是用在React項目里檐薯,那組件依賴的React就不需要進行babel轉(zhuǎn)義了。如果轉(zhuǎn)義注暗,那樣打出來的包就會特別大厨剪,沒必要。不過在測試開發(fā)階段友存,這項應該注釋掉祷膳,在打包發(fā)布之前加上就可以。

  3. 配置package.json

    "main": "build/component.js"
    

    只需要在main這項定義打包后的組件的位置就OK了屡立。

打包發(fā)布

  1. 執(zhí)行yarn build打包后直晨,在build目錄會生成app.js文件和component.js文件。但是我們這里只需要component.js文件膨俐,因為我沒有對webpack.config.js做環(huán)境的區(qū)分勇皇,所以會將entry項的文件都打包出來。現(xiàn)在我們webpack配置比較簡單焚刺,所以需要手動處理敛摘,將app.js刪除后再提交。

  2. 現(xiàn)在開始發(fā)布

    #先登錄NPM賬號:
    npm login
    
    #會依次讓你輸入用戶名乳愉、密碼兄淫、和郵箱
    Username: simbawu        
    Password:
    Email: (this IS public) wsbin610@163.com
    
    #登錄成功會出現(xiàn)以下提示信息:
    Logged in as simbawu on https://registry.npmjs.org/.
    
    #執(zhí)行發(fā)布命令:
    npm publish
    
    #發(fā)布成功后會出現(xiàn)以下提示信息:
    + react-components-calendar@0.0.7  
    #這里react-components-calendar是我的NPM包名屯远,0.0.7是包的版本號
    
  3. 接下來,我們可以在NPM官網(wǎng)捕虽,通過搜索包名或者在個人中心看到剛剛發(fā)布的包慨丐。

    NPM

測試驗證

  1. 安裝剛剛發(fā)布的包

    yarn add react-components-calendar --dev
    
  2. 安裝成功后,在之前我們引入開發(fā)的組件的地方將引用路徑替換為包引用

    // import Calendar from '../../../components/index.js'
    import Calendar from 'react-components-calendar'
    
  3. 注釋webpack.config.js中的externals這項

    output: {
        path: path.resolve(__dirname, '../build'),
        filename: '[name].js',
        publicPath: "/build/",
        libraryTarget: 'umd',
        library: 'Calendar'
      },
      // externals: {
      //   'react': 'react',
      //   'react-dom': 'react-dom'
      // },
    
  4. 啟動項目泄私,查看效果房揭。

    yarn start
    
    Calendar Preview

最后,祝賀大功告成晌端!趕緊去發(fā)自己的第一個包吧~

附上本項目的源碼:react-components-calendar捅暴。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市咧纠,隨后出現(xiàn)的幾起案子伶唯,更是在濱河造成了極大的恐慌,老刑警劉巖惧盹,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件乳幸,死亡現(xiàn)場離奇詭異,居然都是意外死亡钧椰,警方通過查閱死者的電腦和手機粹断,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來嫡霞,“玉大人瓶埋,你說我怎么就攤上這事≌锘Γ” “怎么了养筒?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長端姚。 經(jīng)常有香客問我晕粪,道長,這世上最難降的妖魔是什么渐裸? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任巫湘,我火速辦了婚禮,結(jié)果婚禮上昏鹃,老公的妹妹穿的比我還像新娘尚氛。我一直安慰自己,他們只是感情好洞渤,可當我...
    茶點故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布阅嘶。 她就那樣靜靜地躺著,像睡著了一般载迄。 火紅的嫁衣襯著肌膚如雪讯柔。 梳的紋絲不亂的頭發(fā)上抡蛙,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天,我揣著相機與錄音磷杏,去河邊找鬼溜畅。 笑死捏卓,一個胖子當著我的面吹牛极祸,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播怠晴,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼遥金,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蒜田?” 一聲冷哼從身側(cè)響起稿械,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎冲粤,沒想到半個月后美莫,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡梯捕,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年厢呵,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片傀顾。...
    茶點故事閱讀 39,932評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡襟铭,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出短曾,到底是詐尸還是另有隱情寒砖,我是刑警寧澤,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布嫉拐,位于F島的核電站哩都,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏婉徘。R本人自食惡果不足惜茅逮,卻給世界環(huán)境...
    茶點故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望判哥。 院中可真熱鬧献雅,春花似錦、人聲如沸塌计。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽锌仅。三九已至章钾,卻和暖如春墙贱,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背贱傀。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工惨撇, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人府寒。 一個月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓魁衙,卻偏偏與公主長得像,于是被迫代替她去往敵國和親株搔。 傳聞我的和親對象是個殘疾皇子剖淀,可洞房花燭夜當晚...
    茶點故事閱讀 44,884評論 2 354

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

  • 項目地址 從頭開始建立一個React App - 項目基本配置 npm init 生成 package.json ...
    瘦人假嚕嚕閱讀 89,532評論 33 78
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,128評論 25 707
  • 學習流程 參考文檔:入門Webpack,看這篇就夠了Webpack for React 一. 簡單使用webpac...
    Jason_Zeng閱讀 3,138評論 2 16
  • 如果你臨時被安排去接受一個你從來沒有接觸過崗位,你對它的了解是一片空白炮姨,你會不會焦慮捌刮、徹夜難眠?我不僅焦慮舒岸、慌張绅作、...
    豪小閱讀 205評論 1 2
  • 我不知道鼓足了多大勇氣才寫了這篇文章,也不知道自己到底想表達什么 …… 我吁津,性格有點高傲棚蓄,霸道,有些事情喜歡較真碍脏,...
    悟空_86c7閱讀 133評論 0 0