如何自己写一个公用的NPM包

markdown-clear,创建过程为例,讲解整个NPM包创建和发布流程

1 如何创建一个包

1.1 创建并使用一个工程

  • 在GitHub上新建一个仓库,其名markdown-clear
  • clone 这个工程到本地

1.2 添加LICENCELICENSE文件, 说明对应的开源协议

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 文件,忽略不需要提交的文件变更

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 转换代码
{
  "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 adduser USERNAME
  • 如果没有登录
npm login
  • 登录后发布包,在工程目录下执行
npm publish

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏c#开发者

ASP.NET MVC 5 Authentication Breakdown

In my previous post, "ASP.NET MVC 5 Authentication Breakdown", I broke down all ...

33710
来自专栏小白安全

渗透测试单行化工具One-Lin3r

One-Lin3r One-Lin3r是一款简单的轻量级框架,而该工具的灵感来自于Metasploit的web-delivery模块。该工具提供...

2785
来自专栏coding

将vagrant的centos镜像扩容到800G准备阶段虚拟机内扩容大功告成

能做得了什么?这点容量撑不了几周就爆满。也许官方是出于轻便化的考量,但作为要在vagrant上搭建各种开发环境的开发人员,8G的容量只能让vagrant沦为鸡肋...

833
来自专栏10km的专栏

powershell:Join-Path连接多级子目录的方法

我们知道Join-Path可以用来创建路径,比如 Join-Path 'C:\Program Files' WindowsPowerShell 会把C:\Pr...

2017
来自专栏运维小白

10.10 linux下抓包

监控系统状态 抓包工具 tcpdump 用法:tcpdump -nn tcpdump -nn -i ens33 tcpdump -nn port 80 tcpd...

3205
来自专栏北京马哥教育

史上最全Linux命令科普 | 常见命令的名称是怎么来的?

1 目录缩写 缩写 | 全称 | 说明 --- | --- | --- | /bin | BINaries | 二进制可执行命令 /dev | DEVices...

2664
来自专栏晓晨的专栏

CentOS 7 源码编译安装 Nginx

https://www.cnblogs.com/visec479/p/5145624.html

923
来自专栏惨绿少年

Linux中常见问题(磁盘 定时任务)

第1章 linux无法上网 1) 第一步,先ping域名. ping www.baidu.com 2)再ping一个公网ip , ping 223.5.5.5...

1790
来自专栏张善友的专栏

codeproject 几篇asp.net文章

Best Practices in ASP.NET for writing User Control In MultiView And Wizard using...

1766
来自专栏Albert陈凯

VMware workstation网络NAT模式修改虚拟网络子网网段

安装wm ware 时,系统默认添加两个网卡,网段是随机的,如果想修改,需要在软件里面设置一下 在菜单中选择:编辑-->虚拟网络编辑器 ? VMware虚拟机设...

3444

扫码关注云+社区