开发npm包

1、创建项目,使用npm init

name:填写你这个包的名字,默认是你这个文件夹的名字。
      注:最好先去npm上找一下有没有同名的包。也可以在命令行里面输入npm install 你要取的名字,如果报错,npm上没有跟你同名的包。
version:你这个包的版本,默认是1.0.0
description:包描述
entry point:入口文件,默认是index.js
test command:测试命令,这个直接回车就好了
git repository:这个是git仓库地址,如果你的包是先放到github上或者其他git仓库里,这时候你的文件夹里面会存在一个隐藏的.git目录,npm会读到这个目录作为这一项的默认值。如果没有的话,直接回车继续。
keyword:这个是一个重点,这个关系到有多少人会搜到你的npm包。尽量使用贴切的关键字作为这个包的索引。
author:写你的账号或者你的github账号
license:直接回车

若不想输入这些,也可以直接使用 npm init -y

2、创建目录

  

├── bin           // 命令配置
├── README.md     // 说明文档
├── index.js      // 主入口
├── lib           // 目录下存放业务逻辑文件
├── package.json  // 包信息
└── test          // 目录下存放单元测试用例

3、开发模块

  3.1 局部安装
    所有的函数功能接口都由index.js暴露给外部

  入口文件index的开发:

‘use strict‘;

module.exports = function () {
    console.log(‘hello world‘);
};

  3.2.全局安装

    包全局安装的情况,一般是做自动化工具,关键在于配置全局命令,与index.js无关
    通过bin目录下与全局命令相同的js文件,写丰富的命令行可以引入commander

实例:

mallcopy.js文件,在js文件顶部加上#!/usr/bin/env node

#!/usr/bin/env node

console.log(‘mallcopy‘);

在package.json文件中添加bin配置:

"bin": {
    "mallcopy": "./bin/mallcopy.js"
  },

全局安装包文件,执行mallcopy即可

4、发布npm包

  1. 申请个npm账号
  2. npm login
  3. npm publish
时间: 2024-11-04 11:48:27

开发npm包的相关文章

如何开发NPM包

创建包目录 D:\>mkdir mypackage && cd mypackage D:\mypackage>npm init --yes 进入mypackage目录,你会看到一个package.json文件,其内容如下: { "name": "mypackage", "version": "1.0.0", "description": "", "m

怎么开发一个npm包

一.注册npm账号* 怎么将代码提到github,大家都知道需要一个github账号* 同样,开发一个npm包,当然也需要一个npm账号,将npm包发布到npm的托管服务器* 注册地址:[http://npmjs.org](http://npmjs.org)* 该实例包含了模块的局部调用和全局调用两种方式 二.开发npm包 1.目录构建* npm init* 项目结构:```javascript.├── bin //命令配置├── README.md //说明文档├── index.js //主

Angular 开发NPM第三方包

步骤: 创建第三方包 > 开发第三方包 > 测试第三方包 > 发布第三方包 > 使用第三方包 实例: 第一步:创建第三方包;; (创建项目,项目下创建第三方库) 1. 新建项目 ng new zerolibrary 2. 创建第三方库 // 目录切换至新创建的项目 cd zerolibrary // 创建第三方库 (--prefix: 前缀:在用命令行新建组件/指令时,selector的属性值的前缀) ng g library zero --prefix zm === >目录

在2018年如何优雅的开发一个typescript语言的npm包?

欢迎大家前往腾讯云+社区,获取更多腾讯海量技术实践干货哦~ 本文由小明plus发表 很多时候,我们可能想要用 typescript 语言来创建一些模块,并提交到 npm 供别人使用, 那么在 2018 年,如果我想要初始化这样的一个模块,我需要做哪些步骤呢?: 答案是:创建一个优雅的,对开发者友好的模块,至少需要以下 15 个步骤 初始化文件夹,初始化 git 仓库,初始化 npm,初始化 tsc 修改 tsconfig.js 配置 添加 npm 脚本 添加 tslint 校验代码规则以及 ed

开发一个健壮的npm包

项目地址:loan-calculate-utils npm包的发布.更新查看上一篇文章 开发一个基础的npm包 目前我们的目录是这个样子: . ├── source 源代码目录 │?? └── index.js ├── package.json └── README.md 接下来给项目添加 打包,忽视文件,ts声明文件,单元测试,eslint,README.md添加徽标. 打包 参考 ramda 打包思路,我们将要编译成三种包,以及它们的压缩版. 打包目标 umi: babel source -

(转)前端开发-发布一个NPM包之最简单易懂流程

原文地址:https://www.cnblogs.com/sghy/p/6829747.html 1.npm官网创建npm账户 npm网站地址:https://www.npmjs.com/ npm网站注册地址:https://www.npmjs.com/signup 2.命令行工具登录npm npm login 验证登录是否成功 npm who am i 3.创建npm库 npm init 按照提示输入相应内容: 以下为package.json内容: { "name": "z

npm包的更新说明,你还敢不看吗

npm包的更新说明,你还敢不看吗 前言 平时工作少不了依赖一些第三方的npm包,站在各位大牛的肩膀上来更好的写bug,此外还可以学习各位大佬们的各种设计思路和优雅实现.不过npm包虽好,但使用之前也要多加甄别,特别是相同包的不同版本之间的差别,可能一不小心,原本用的飞起的轮子就会让我们笑不出来.下面用两次惨痛的线上问题来给大家提个醒. 版本依赖符号 在描述问题之前,先谈一下npm的包管理控制. 假设我们依赖一个npm包 a 常见的依赖符号有下面这么几种 { "dependencies"

每日质量NPM包复制_copy-to-clipboard

一.copy-to-clipboard 官方定义: Simple module exposing copy function 理解: 一个超级简单的复制功能,并且这种方法适用于通过别的事件触发复制功能 什么意思呢?比如:我想设计一个在Select选择项改变的时候复制该选择项,这时候一般无法插入组件(等会会介绍一个react复制组件的npm),这时候用copy-to-clipboard就非常合适. 当然为了简单而使用也是非常合理的 用法 import copy from 'copy-to-clip

编写一个供浏览器端使用的NPM包

此文已由作者吴维伟授权网易云社区发布. 欢迎访问网易云社区,了解更多网易技术产品运营经验. 在编写程序时,总会有一些代码是我们不愿意一遍又一遍重复地去写的,比如一些UI或交互相似组件,或是一些相似的流程或逻辑.以前,面对这样的情况,我会将可以复用的部分抽象出来,做成可以复用的模块,放在专门存放公用模块的文件夹中,便于查找和引用.但是这样只能解决单个项目中公用模块复用的问题,如果你的模块需要被多个项目复用,那么就需要另寻它法了.本文讨论的是通过发布npm包来实现模块复用时有哪些注意事项. 新建一个