如何自己写一个公用的NPM包
以markdown-clear,创建过程为例,讲解整个NPM包创建和发布流程
1 如何创建一个包
1.1 创建并使用一个工程
- 在GitHub上新建一个仓库,其名
markdown-clear
clone
这个工程到本地
1.2 添加LICENCE
或LICENSE
文件, 说明对应的开源协议
- 到SPDX License List 或者Open Source Initiative,下载相应协议的模板,我们这里选用MIT
- 修改必要的协议时间和作者
MIT License
Copyright (c) <year> <copyright holders>
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.
1.3 添加README
或者ReadMe.md
或者README.md
文件
- 说明项目的一些信息
- 给出详细参考资料的链接
- 给读者一个整体的导航内容
1.4 添加.gitignore
文件,忽略不需要提交的文件变更
- 可以去github gitignore 下载一个最相近的模板然后改改
- 可以去gitignore.io生成一个,然后把内容拿下了
- 可以参考gitignore.io 文档,自己配命令行工具,以便随时可以玩
- 我们这里生成了一个Node + IntellJ-all 的结果
- 内容语法参考gitignore doc
1.5 初始化NPM包
- 使用
npm init
初始化工程 - 按照提示填入相应的内容
1.6 到这里的目录结构
- 工程三大件以及npm包配置文件都有了
markdown-clear
------------- .gitignore
------------- LICENCE
------------- README.md
------------- package.json
1.7 EditorConfig
跨编辑器的编辑器设置,网站挂了,EditorConfig
1.8 ESLint
新一代JavaScript代码质量检测工具ESLint
2 代码结构组织
2.1 加入代码相关的目录
markdown-clear
-------------- src // 源代码目录 比如coffee,typescript,es6+等代码的目录
-------------- lib // 转义生成的代码目录,比如babel转义后的es5代码的目录
-------------- docs // 代码相关的设计和使用文档
-------------- tests // 相关的测试目录
2.2 代码实现
- 写代码 src 目录
- 转换后的代码 lib 目录
2.2.1 使用babel 转换代码
- babel官网
- babel 配置文件
.babelrc
{
"presets":["es2015","stage-0"]
}
- 添加 npm 命令
"scripts": {
"build": "babel src -d lib",
}
2.2.2 实现一个可以全局安装的npm包
- 添加
package.json
的配置
"bin": {
"markdown-clear": "./lib/cli.js"
}
cli.js
文件第一行添加
#!/usr/bin/env node
2.3 测试
- 写测试用例 tests 目录
- 调用最终生成的 lib 下面的目录
- 可以考虑使用测试框架 mocha, jasmine, karma...
2.3.1 安装测试
- 使用npm 安装本地文件 作为本地包
npm install path/to/markdown-clear
- 使用npm 安装本地文件 作为全局包
npm install path/to/markdown-clear -g
2.4 文档输出
- 写文档 docs 目录
- 写代码相关的设计和使用文档,没有自然可以不用写
- 这里的文档应该在README.md 中会有入口。
3 发布NPM包
- npm文档
- 如果没有注册npm账户
npm adduser USERNAME
- 如果没有登录
npm login
- 登录后发布包,在工程目录下执行
npm publish
如何自己写一个公用的NPM包的更多相关文章
- 开发一个健壮的npm包
项目地址:loan-calculate-utils npm包的发布.更新查看上一篇文章 开发一个基础的npm包 目前我们的目录是这个样子: . ├── source 源代码目录 │ └── ind ...
- 开发一个基础的npm包
初始化项目 # 新建文件夹 mkdir whosmeya-npm-package-test # 进入 cd whosmeya-npm-package-test/ # 初始化 package.json, ...
- 从0写一个Golang日志处理包
WHY 日志概述 日志几乎是每个实际的软件项目从开发到最后实际运行过程中都必不可少的东西.它对于查看代码运行流程,记录发生的事情等方面都是很重要的. 一个好的日志系统应当能准确地记录需要记录的信息,同 ...
- 发布一个简单的npm包
本文简单地记录了发布一个简单npm包的过程,以便后续参考使用. 初始化npm init 通过npm init创建一个package.json文件 D:\robin\lib\weapp-utils> ...
- npkill 一个方便的npm 包清理工具
npm 包很好用,但是占用空间太多了,npkill 提供了一个方便的工具,可以帮助我们查找安装的npm 包,以及进行清理 安装 npm install -g npkill 简单使用 命令 npkill ...
- 如何开发一个自己的npm包
目录 一.初始化npm包 二.新建自己的工具类 三.新建入口文件index.js 四.编写单元测试 五.登录仓库 六.发布包 七.安装使用 八.删除包 一.初始化npm包 npm init 运行输入包 ...
- React Native学习(四)—— 写一个公用组件(头部)
本文基于React Native 0.52 Demo上传到Git了,有需要可以看看,写了新内容会上传的.Git地址 https://github.com/gingerJY/React-Native-D ...
- npm_一个有意思的npm包
$ npm install yosay const yosay = require('yosay'); console.log(yosay('Hello, and welcome to my fant ...
- 从0到1发布一个npm包
从0到1发布一个npm包 author: @TiffanysBear 最近在项目业务中有遇到一些问题,一些通用的方法或者封装的模块在PC.WAP甚至是APP中都需要使用,但是对于业务的PC.WAP.A ...
随机推荐
- R语言重要数据集分析研究——搞清数据的由来
搞清数据的由来 作者:李雪丽 资料来源:百度百科
- ecshop商品页增加编辑器fckeditor
最近在做ecshop的项目,需要在商品单页中增加一项FCKEditor的文本编辑器,但在ecshop的论坛和百度里搜出的方法,试了好几个都没有用,终于找到一个可以正确使用的,和大家分享. ecshop ...
- POJ 1459-Power Network(网络流-最大流-ISAP)C++
Power Network 时间限制: 1 Sec 内存限制: 128 MB 题目描述 A power network consists of nodes (power stations, cons ...
- 手动整合实现SSH项目开发01
内容简介:本文主要介绍SSH项目开发的配置以及简单登录功能的实现. 1. 新建一个Dynamic Web Project. 2.导入需要 的Jar包,此项目是Struts.Hibernate.Spri ...
- java 父类构造器
当创建任何java对象时,程序总会首先调用系统的父类非静态初始化块(隐式执行)和父类构造器(从object开始(java程序中所有类的最终父类都是java.lang.Object类,使用语句super ...
- 如何成为一名JAVAEE软件工程师?(前言)
笔者将会整理出一整套成为一个JAVAEE工程师的学习路线和资料.欢迎同行和网友们订阅或指正.不定期更新. 笔者在软件工作做了7年java开发,开发过ERP,CRM等应用系统并担任过项目 ...
- Example002定时打开窗口
<!--实例002定时打开窗口--> <script> // 3秒后弹出窗口: function time() { window.open("index.html&q ...
- Sublime Text 3 注册码
最近觉得Sublime Text3比Notepad++好使,可惜需要购买,于是网上搜了一下,屌丝的福音啊: Sublime Text Build 3065 License key复制如下三个任意一个正 ...
- Configure: error: freetype.h not found. 的解决办法
出现 Configure: error: freetype.h not found. 的解决办法 CentOS yum install freetype-devel Debian apt-get in ...
- App Extensions篇之Sticker Pack Extension
转载请标明原文链接:http://www.cnblogs.com/zhanggui/p/7151795.html 前言 上一篇文章对App Extension做了简单介绍以及对Share Extens ...