使用typescript開發angular模組(釋出npm包)
阿新 • • 發佈：2019-01-06
建立模組
初始化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 在此基礎上可以設定預設生成值
npm config set init-author-name "yiershan" # 你的名稱
npm config set init-author-email "[email protected]" # 你的郵箱
npm config set init-author-url "https://www.jianshu.com/u/8afb7e623b70" # 你的個人網頁
npm config set init-license "MIT" # 開源授權協議名
npm config set 刪掉重新來一遍
{
"name": "MZC-Ng-Api",
"version": "0.0.1",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "yiershan <[email protected] 然後新增一個 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 <[email protected]> (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 <[email protected]> (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"
},至此基本的流程算是走通了。