摘要:發(fā)布包文檔如果沒有注冊賬戶如果沒有登錄登錄后發(fā)布包,在工程目錄下執(zhí)行
以 markdown-clear ,創(chuàng)建過程為例,講解整個(gè)NPM包創(chuàng)建和發(fā)布流程
1 如何創(chuàng)建一個(gè)包 1.1 創(chuàng)建并使用一個(gè)工程在GitHub上新建一個(gè)倉庫,其名markdown-clear
clone 這個(gè)工程到本地
1.2 添加LICENCE或LICENSE文件, 說明對應(yīng)的開源協(xié)議到SPDX License List 或者Open Source Initiative,下載相應(yīng)協(xié)議的模板,我們這里選用MIT
修改必要的協(xié)議時(shí)間和作者
MIT License Copyright (c)1.3 添加README或者ReadMe.md或者README.md文件Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
說明項(xiàng)目的一些信息
給出詳細(xì)參考資料的鏈接
給讀者一個(gè)整體的導(dǎo)航內(nèi)容
1.4 添加.gitignore 文件,忽略不需要提交的文件變更可以去github gitignore 下載一個(gè)最相近的模板然后改改
可以去gitignore.io生成一個(gè),然后把內(nèi)容拿下了
可以參考gitignore.io 文檔,自己配命令行工具,以便隨時(shí)可以玩
我們這里生成了一個(gè)Node + IntellJ-all 的結(jié)果
內(nèi)容語法參考gitignore doc
1.5 初始化NPM包使用npm init 初始化工程
按照提示填入相應(yīng)的內(nèi)容
1.6 到這里的目錄結(jié)構(gòu)工程三大件以及npm包配置文件都有了
markdown-clear ------------- .gitignore ------------- LICENCE ------------- README.md ------------- package.json1.7 EditorConfig
跨編輯器的編輯器設(shè)置,網(wǎng)站掛了,EditorConfig
1.8 ESLint新一代JavaScript代碼質(zhì)量檢測工具ESLint
2 代碼結(jié)構(gòu)組織 2.1 加入代碼相關(guān)的目錄markdown-clear -------------- src // 源代碼目錄 比如coffee,typescript,es6+等代碼的目錄 -------------- lib // 轉(zhuǎn)義生成的代碼目錄,比如babel轉(zhuǎn)義后的es5代碼的目錄 -------------- docs // 代碼相關(guān)的設(shè)計(jì)和使用文檔 -------------- tests // 相關(guān)的測試目錄2.2 代碼實(shí)現(xiàn)
寫代碼 src 目錄
轉(zhuǎn)換后的代碼 lib 目錄
babel官網(wǎng)
babel 配置文件 .babelrc
{ "presets":["es2015","stage-0"] }
添加 npm 命令
"scripts": { "build": "babel src -d lib", }
添加package.json的配置
"bin": { "markdown-clear": "./lib/cli.js" }
cli.js文件第一行添加
#!/usr/bin/env node2.3 測試
寫測試用例 tests 目錄
調(diào)用最終生成的 lib 下面的目錄
可以考慮使用測試框架 mocha, jasmine, karma...
使用npm 安裝本地文件 作為本地包
npm install path/to/markdown-clear
使用npm 安裝本地文件 作為全局包
npm install path/to/markdown-clear -g2.4 文檔輸出
寫文檔 docs 目錄
寫代碼相關(guān)的設(shè)計(jì)和使用文檔,沒有自然可以不用寫
這里的文檔應(yīng)該在README.md 中會(huì)有入口。
3 發(fā)布NPM包npm文檔
如果沒有注冊npm賬戶
npm adduser USERNAME
如果沒有登錄
npm login
登錄后發(fā)布包,在工程目錄下執(zhí)行
npm publish
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/84679.html
摘要:前言前端模塊化,主要是解決兩個(gè)問題命名空間沖突,文件依賴管理。目前解決的方法是模塊化命名空間各個(gè)模塊的命名空間獨(dú)立。模塊化構(gòu)建工具,等是用來組織前端模塊的構(gòu)建工具加載器。 前言 前端模塊化,主要是解決兩個(gè)問題——命名空間沖突,文件依賴管理。 坑___命名空間沖突 我自己測試好的代碼和大家合并后怎么起沖突了? 頁面腳本的變量或函數(shù)覆蓋了公有腳本的。 坑___文件依賴管理 明明項(xiàng)目需...
摘要:原文地址如果您對本系列文章感興趣,歡迎關(guān)注訂閱這里前言本文介紹如何在多項(xiàng)目間共用同一套基礎(chǔ)設(shè)施,又或是某種層次的框架。而以上所述的種種,就構(gòu)成了一套完整的解決方案,也稱基礎(chǔ)設(shè)施。下面就以從到的改造過程來介紹如何實(shí)現(xiàn)多項(xiàng)目共用基礎(chǔ)設(shè)施。 本文首發(fā)于Array_Huang的技術(shù)博客——實(shí)用至上,非經(jīng)作者同意,請勿轉(zhuǎn)載。原文地址:https://segmentfault.com/a/1190...
摘要:多頁面跳轉(zhuǎn)之前看過有相關(guān)朋友了空的多頁面腳手架不過了幾個(gè)都是或者的剛好項(xiàng)目需要用到就在的基礎(chǔ)上進(jìn)行了修改已經(jīng)有直接用即可如果需要修改配置的請到里面修改并且全局引了如果不需要或者不喜歡請到里面修改多頁面空腳手架鏈接如果需要路由版的在的另外一 vue2.* (多頁面跳轉(zhuǎn)) @[vue2.3.3|webpack2.6.1|less|axios] 之前看過有相關(guān)朋友share了空的多頁面腳...
摘要:現(xiàn)在,讓我們創(chuàng)建項(xiàng)目的入口,并使用然后創(chuàng)建我們的配置,文件名為,的配置文件是一個(gè),并且需要成一個(gè)對象在這里,告訴那些文件是你應(yīng)用的入口。代碼分割便是用來解決之前所說的單集成模塊不可維護(hù)的引用的問題。 構(gòu)建工具逐漸成為前端工程必備的工具,Grunt、Gulp、Fis、Webpack等等,譯者有幸使用過Fis、Gulp。前者是百度的集成化方案,提供了一整套前端構(gòu)建方案,優(yōu)點(diǎn)是基本幫你搞定了...
閱讀 1347·2021-09-01 11:40
閱讀 3960·2021-08-05 10:03
閱讀 986·2019-08-30 15:54
閱讀 2830·2019-08-29 12:53
閱讀 3196·2019-08-29 12:23
閱讀 951·2019-08-26 13:45
閱讀 2292·2019-08-26 10:41
閱讀 2548·2019-08-23 16:44