如何自己写一个公用的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 ...
随机推荐
- oracle备份、还原
----第一步:设置空表导出 ----由于Oracle 11G在用EXPORT导出时,空表不能导出.解决方法如下:(11G中有个新特性,当表无数据时,不分配segment,以节省空间) select ...
- 统计dir_path下所有文件类型的文件数量
#!/bin/bash #!文件名为countfile.sh ]; then echo "Usage is $0 basepath"; exit fi path=$ declare ...
- 避免循环做SQL操作
经常犯的错误是把一个SQL 操作放置到一个循环中, 这就导致频繁的访问数据库,更重要的是, 这会直接导致脚本的性能低下.以下的例子, 你能够把一个循环操作重置为一个单一的SQL语句. foreach ...
- apache 基本vhost配置
经常使用Apache虚拟主机进行开发和测试,但每次需要配置虚拟主机时都习惯性的ctrl+c和ctrl+v,这次由于重装系统,需要配置一个新的PHP开发环境虚拟主机,于是总结一下Apaceh配置http ...
- 自己编写的 C++ 超轻量级日志类
[自己编写的 C++ 超轻量级日志类(兼容vc++6.0.vs2010.vs2015)] 先来看效果: [测试文件:test.cpp] /* 作者:闫文山 时间:2017/07/02 介绍: 本日志类 ...
- 使用 sitemesh/decorator装饰器装饰jsp页面(原理及详细配置)
摘要:首先这个Decorator解释一下这个单词:“装饰器”,我觉得其实可以这样理解,他就像我们用到的Frame,他把每个页面共有的东西提炼了出来,也可能我们也会用各种各样的include标签,将我们 ...
- 关于 静态页面布局 中的一些BUG
作为一枚初级程序猿,难免在制作静态页面时会遇到一些BUG,在此,我从网上找了一些资料并且结合自己的项目开发经验,总结了一些在静态页面布局时可能会遇到的问题,希望能对初级程序猿有一定的帮助(资料请参考: ...
- 从一个针对ASP.NET MVC框架的Controller.Action的请求处理顺序来说整个请求过程。
下面引用的所有代码都来自ASP.NET MVC的源码,但是可能只选取每个方法的其中一部分. System.Web.Routing.UrlRoutingModule在管道事件中注册PostResolve ...
- gradle的安装,配置,构建,研究,初体验......(入职一周研究的第一个大知识点)
(1)Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建工具.它使用一种基于Groovy的特定领域语言(DSL)来声明项目设置,抛弃了基于XML的各种繁琐配置.更 ...
- JAVA实用案例之水印开发
写在最前面 上周零零碎碎花了一周的时间研究水印的开发,现在终于写了个入门级的Demo,做下笔记同时分享出来供大家参考. Demo是在我上次写的 JAVA实用案例之文件导入导出(POI方式) 框架基础上 ...