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

glumes 发布于2019-08-20 18:33 / 1776人阅读

摘要：发布包文档如果没有注册账户如果没有登录登录后发布包，在工程目录下执行

以 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)  

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

GPU云服务器云服务器每周数百万下载量!NPM包修复了一个远程如何搭建一个自己的服务器如何搞一个自己的hyp加速专线如何写一个爬虫

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/84679.html

前端模块化——技术选型

摘要：前言前端模块化，主要是解决两个问题命名空间冲突，文件依赖管理。目前解决的方法是模块化命名空间各个模块的命名空间独立。模块化构建工具，等是用来组织前端模块的构建工具加载器。前言前端模块化，主要是解决两个问题——命名空间冲突，文件依赖管理。坑___命名空间冲突我自己测试好的代码和大家合并后怎么起冲突了？页面脚本的变量或函数覆盖了公有脚本的。坑___文件依赖管理明明项目需...

Doyle 2019-08-20 11:10 评论0 收藏0
webpack多页应用架构系列（十四）：No复制粘贴！多项目共用基础设施

摘要：原文地址如果您对本系列文章感兴趣，欢迎关注订阅这里前言本文介绍如何在多项目间共用同一套基础设施，又或是某种层次的框架。而以上所述的种种，就构成了一套完整的解决方案，也称基础设施。下面就以从到的改造过程来介绍如何实现多项目共用基础设施。本文首发于Array_Huang的技术博客——实用至上，非经作者同意，请勿转载。原文地址：https://segmentfault.com/a/1190...

cyrils 2019-08-22 10:42 评论0 收藏0
基于vue-cli搭了一个多页面应用的空脚手架

摘要：多页面跳转之前看过有相关朋友了空的多页面脚手架不过了几个都是或者的刚好项目需要用到就在的基础上进行了修改已经有直接用即可如果需要修改配置的请到里面修改并且全局引了如果不需要或者不喜欢请到里面修改多页面空脚手架链接如果需要路由版的在的另外一 vue2.* (多页面跳转) @[vue2.3.3|webpack2.6.1|less|axios] 之前看过有相关朋友share了空的多页面脚...

qingshanli1988 2019-08-01 17:11 评论0 收藏0
[译] Webpack 前端构建集成方案

摘要：现在，让我们创建项目的入口，并使用然后创建我们的配置，文件名为，的配置文件是一个，并且需要成一个对象在这里，告诉那些文件是你应用的入口。代码分割便是用来解决之前所说的单集成模块不可维护的引用的问题。构建工具逐渐成为前端工程必备的工具，Grunt、Gulp、Fis、Webpack等等，译者有幸使用过Fis、Gulp。前者是百度的集成化方案，提供了一整套前端构建方案，优点是基本帮你搞定了...

lewif 2019-08-21 10:52 评论0 收藏0