使用typescript开发angular模块并发布npm包

本文介绍了使用typescript开发angular模块并发布npm包，分享给大家，具体如下：

创建模块

初始化package.json文件

执行命名

npm init -y

会自动生成package.json文件如下，name默认为文件夹名称

{
 "name": "mzc-ng-api",
 "version": "1.0.0",
 "description": "",
 "main": "index.js",
 "scripts": {
  "test": "echo \"error: no test specified\" && exit 1"
 },
 "keywords": [],
 "author": "",
 "license": "isc"
}

在此基础上可以设置默认生成值

npm config set init-author-name "yiershan"       # 你的名称
npm config set init-author-email "[e-mail]" # 你的邮箱
npm config set init-author-url "https://www.jianshu.com/u/8afb7e623b70" # 你的个人网页
npm config set init-license "mit"          # 开源授权协议名
npm config set init-version "0.0.1"             # 版本号

删掉重新来一遍

{
 "name": "mzc-ng-api",
 "version": "0.0.1",
 "description": "",
 "main": "index.js",
 "scripts": {
  "test": "echo \"error: no test specified\" && exit 1"
 },
 "keywords": [],
 "author": "yiershan <[e-mail]> (https://www.jianshu.com/u/8afb7e623b70)",
 "license": "mit"
}

然后添加一个 readme.md 文件

简单介绍下项目

# mzc-ng-api

这是一个npm包发布测试项目

## license

请查看 [mit license](./license).

添加一个开源协议文件

做事情还是要做的有鼻子有眼的嘛。

mit license

copyright (c) 2017 mzc

本项目为测试项目，完全免费。

添加源码

创建一个src目录并添加一个index.ts文件

export class mzcngapi{
  private name: string;
  constructor() {
    this.name = "mzcngapi";
  }
}

创建一个index.ts文件

export * from './src/index'

使用typescript编译

没有安装typescript就先安装

npm i -g typescript

初始化tsconfig.json文件

tsc --init

自动生成文件,很全很强大，还有解释

{
 "compileroptions": {
  /* basic options */
  "target": "es5",             /* specify ecmascript target version: 'es3' (default), 'es5', 'es2015', 'es2016', 'es2017','es2018' or 'esnext'. */
  "module": "commonjs",           /* specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'esnext'. */
  // "lib": [],               /* specify library files to be included in the compilation. */
  // "allowjs": true,            /* allow javascript files to be compiled. */
  // "checkjs": true,            /* report errors in .js files. */
  // "jsx": "preserve",           /* specify jsx code generation: 'preserve', 'react-native', or 'react'. */
  //"declaration": true,          /* generates corresponding '.d.ts' file. */
  // "sourcemap": true,           /* generates corresponding '.map' file. */
  // "outfile": "./",            /* concatenate and emit output to single file. */
  // "outdir": "dist",            /* redirect output structure to the directory. */
  // "rootdir": "./",            /* specify the root directory of input files. use to control the output directory structure with --outdir. */
  // "removecomments": true,        /* do not emit comments to output. */
  // "noemit": true,            /* do not emit outputs. */
  // "importhelpers": true,         /* import emit helpers from 'tslib'. */
  // "downleveliteration": true,      /* provide full support for iterables in 'for-of', spread, and destructuring when targeting 'es5' or 'es3'. */
  // "isolatedmodules": true,        /* transpile each file as a separate module (similar to 'ts.transpilemodule'). */

  /* strict type-checking options */
  "strict": true,              /* enable all strict type-checking options. */
  // "noimplicitany": true,         /* raise error on expressions and declarations with an implied 'any' type. */
  // "strictnullchecks": true,       /* enable strict null checks. */
  // "strictfunctiontypes": true,      /* enable strict checking of function types. */
  // "strictpropertyinitialization": true, /* enable strict checking of property initialization in classes. */
  // "noimplicitthis": true,        /* raise error on 'this' expressions with an implied 'any' type. */
  // "alwaysstrict": true,         /* parse in strict mode and emit "use strict" for each source file. */

  /* additional checks */
  // "nounusedlocals": true,        /* report errors on unused locals. */
  // "nounusedparameters": true,      /* report errors on unused parameters. */
  // "noimplicitreturns": true,       /* report error when not all code paths in function return a value. */
  // "nofallthroughcasesinswitch": true,  /* report errors for fallthrough cases in switch statement. */

  /* module resolution options */
  // "moduleresolution": "node",      /* specify module resolution strategy: 'node' (node.js) or 'classic' (typescript pre-1.6). */
  // "baseurl": "./",            /* base directory to resolve non-absolute module names. */
  // "paths": {},              /* a series of entries which re-map imports to lookup locations relative to the 'baseurl'. */
  // "rootdirs": [],            /* list of root folders whose combined content represents the structure of the project at runtime. */
  // "typeroots": [],            /* list of folders to include type definitions from. */
  // "types": [],              /* type declaration files to be included in compilation. */
  // "allowsyntheticdefaultimports": true, /* allow default imports from modules with no default export. this does not affect code emit, just typechecking. */
  "esmoduleinterop": true          /* enables emit interoperability between commonjs and es modules via creation of namespace objects for all imports. implies 'allowsyntheticdefaultimports'. */
  // "preservesymlinks": true,       /* do not resolve the real path of symlinks. */

  /* source map options */
  // "sourceroot": "./",          /* specify the location where debugger should locate typescript files instead of source locations. */
  // "maproot": "./",            /* specify the location where debugger should locate map files instead of generated locations. */
  // "inlinesourcemap": true,        /* emit a single file with source maps instead of having a separate file. */
  // "inlinesources": true,         /* emit the source alongside the sourcemaps within a single file; requires '--inlinesourcemap' or '--sourcemap' to be set. */

  /* experimental options */
  // "experimentaldecorators": true,    /* enables experimental support for es7 decorators. */
  // "emitdecoratormetadata": true,     /* enables experimental support for emitting type metadata for decorators. */
 }
}

编译

tsc -p .

编译成功会生成了js文件

发布

虽然什么都没有，但是什么都有了。

修改package.json文件

{
 "name": "mzc-ng-api", // 这个名字要小写且不能重复，有大写字母会报错
 "version": "1.0.2",
 "description": "个人博客系统，从后台api取数据的angular封装",
 "main": "index.js",
 "scripts": {
  "test": "echo \"error: no test specified\" && exit 1"
 },
 "repository": {
  "type": "git",
  "url": "git+https://github.com/yiershan/mzc-ng-api.git"
 },
 "keywords": [],
 "author": "yiershan <[e-mail]> (https://www.jianshu.com/u/8afb7e623b70)",
 "license": "mit",
 "bugs": {
  "url": "https://github.com/yiershan/mzc-ng-api/issues"
 },
 "homepage": "https://github.com/yiershan/mzc-ng-api#readme"
}

修正下载源

npm config set registry https://registry.npmjs.org/

登录

npm login

如果没有账号就去注册一个吧

发布

npm publish

发布完成立即生效，去npm就能查到并可以下载

使用

新建一个项目安装包

npm i mzc-ng-api

发现很多东西都发布上去了。

而且在开发工作没有智能提示。

完善优化

编译时生成头文件，*.d.ts。

解决编译器提示功能

在tsconfig.json种设置

"declaration": true,

关于tsconfig.json的更多配置可以好好研究研究

指定发布文件

修改

{
 "name": "mzc-ng-api",
 "version": "1.0.2",
 "description": "个人博客系统，从后台api取数据的angular封装",
 "main": "index.js",
 "types": "./index.d.ts", // 添加这个
 "scripts": {
  "test": "echo \"error: no test specified\" && exit 1"
 },
 "files": [ // 指定发布文件
  "index.js",
  "index.d.ts",
  "src/*.js",
  "src/*.d.ts",
  "src/**/*.js",
  "src/**/*.d.ts",
  "readme.md",
  "license",
  "package.json"
 ],
 "repository": {
  "type": "git",
  "url": "git+https://github.com/yiershan/mzc-ng-api.git"
 },
 "keywords": [],
 "author": "yiershan <[e-mail]> (https://www.jianshu.com/u/8afb7e623b70)",
 "license": "mit",
 "bugs": {
  "url": "https://github.com/yiershan/mzc-ng-api/issues"
 },
 "homepage": "https://github.com/yiershan/mzc-ng-api#readme"
}

更新版本

npm version prepatch

更多操作

# 版本号从 1.2.3 变成 1.2.4-0，就是 1.2.4 版本的第一个预发布版本。
npm version prepatch

# 版本号从 1.2.4-0 变成 1.3.0-0，就是 1.3.0 版本的第一个预发布版本。
npm version preminor

# 版本号从 1.2.3 变成 2.0.0-0，就是 2.0.0 版本的第一个预发布版本。
npm version premajor

# 版本号从 2.0.0-0 变成 2.0.0-1，就是使预发布版本号加一。
npm version prerelease
更新

npm publish

下载下来看看就好多了

封装些脚本。

可以根据自己需求编写更多快捷脚本

 "scripts": {
  "build": "tsc -p .",
  "b":"npm run build",
  "version": "npm version prerelease",
  "v":"mpm run v",
  "publish": "npm run b && npm publish",
  "p":"npm run publish"
 },

至此基本的流程算是走通了。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。