npm 发布一个简单的 TypeScript 模块

首先去npm官网注册一个npm 账号，注册成功之后，邮箱里点一下认证即可。注册地址：https://www.npmjs.com/signup。

新建仓库

然后去github新建一个仓库，clone下来。

clone 下来之后执行npm init -f，会生成一个package.json文件，文件里面包含入口，依赖等字段。
然后将main字段改成入口文件dist/index.js，script字段加一个build命令tsc，安装typescript依赖，package.json文件内容如下

//package.json
{
  "name": "npm-publish-ts-demo",
  "version": "1.0.1",
  "description": "",
  "main": "dist/index.js",
  "dependencies": {},
  "devDependencies": {
    "typescript": "^3.5.3"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "tsc"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/mxcz213/npm-publish-ts-demo.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/mxcz213/npm-publish-ts-demo/issues"
  },
  "homepage": "https://github.com/mxcz213/npm-publish-ts-demo#readme"
}

新建资源文件夹src，在src下新建index.ts文件，写入如下代码：

export const Hello = (ts: string) => 'hello' + ts;

现在安装typescript依赖，npm install typescript --save-dev，新建一个tsconfig.json配置文件，写入如下配置：

//tsconfig.json
{
    "compilerOptions": {
        "outDir": "./dist/",
        "noImplicitAny": true,
        "module": "commonjs",
        "target": "es6",
        "allowJs": true
    },
    "include": ["src"],
    "exclude": ["node_modules", "dist"]
}

接着执行命令npm run build，生成的dist目录下的 index.js文件如下所示，这个文件就是供别人使用的。

//dist/index.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Hello = (ts) => 'hello' + ts;

最后新建一个.gitignore文件，忽略node_modules，以及编辑器的设置。

//.gitignore
/node_modules
/.idea
/.vscode

最后将代码全部提交到github上，写好readme即可。提交的时候如果是公司，一定要设置好用户名邮箱，切忌泄露公司账号，可以直接设置

git config user.name 'your name'
git config user.email 'your email'

发布到npm

将本地代码发布到npm，需要先登录npm 账号，执行如下命令之后，按照提示输入用户名，密码，邮箱

npm login

登录成功之后直接npm publish即可。如果下次有改动，要修改package.json的version字段，然后再npm publish就行了。

注意：github 和 npm 是独立的，没有关系的，npm是存包的地方，供使用者安装使用模块，github是存源码的地方，每次有修改直接提交即可。npm会用readme文件，这个文件里面写如何使用包即可。

测试包是否可用

直接到npm官网搜索，是否可以搜到包名，然后可以下载下来试用一下，比如我发的包是https://www.npmjs.com/package/npm-publish-ts-demo，直接下载npm install npm-publish-ts-demo --save-dev，然后在package.json文件的devDependencies可以看到npm-publish-ts-demo这个包。
然后项目中使用一下：

import { Hello } from 'npm-publish-ts-demo'
console.log(Hello('TypeScript'))

这样就完成的包的发布。

地址：https://github.com/mxcz213/npm-publish-ts-demo

最后编辑于：2019.08.05 15:11:57