本文介绍了使用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 "511176294@qq.com" # 你的邮箱 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 <511176294@qq.com> (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": {
"target": "es5",
"module": "commonjs",
// "lib": [],
// "allowJs": true,
// "checkJs": true,
// "jsx": "preserve",
//"declaration": true,
// "sourceMap": true,
// "outFile": "./",
// "outDir": "dist",
// "rootDir": "./",
// "removeComments": true,
// "noEmit": true,
// "importHelpers": true,
// "downlevelIteration": true,
// "isolatedModules": true,
"strict": true,
// "noImplicitAny": true,
// "strictNullChecks": true,
// "strictFunctionTypes": true,
// "strictPropertyInitialization": true,
// "noImplicitThis": true,
// "alwaysStrict": true,
// "noUnusedLocals": true,
// "noUnusedParameters": true,
// "noImplicitReturns": true,
// "noFallthroughCasesInSwitch": true,
// "moduleResolution": "node",
// "baseUrl": "./",
// "paths": {},
// "rootDirs": [],
// "typeRoots": [],
// "types": [],
// "allowSyntheticDefaultimports": true,
"esModuleInterop": true
// "preserveSymlinks": true,
// "sourceRoot": "./",
// "mapRoot": "./",
// "inlineSourceMap": true,
// "inlineSources": true,
// "experimentalDecorators": true,
// "emitDecoratormetadata": true,
}
}
编译
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 <511176294@qq.com> (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",
"README.md",
"LICENSE",
"package.json"
],
"repository": {
"type": "git",
"url": "git+https://github.com/yiershan/MZC-Ng-Api.git"
},
"keywords": [],
"author": "yiershan <511176294@qq.com> (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"
},
至此基本的流程算是走通了。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持考高分网。
