使用typescript開發(fā)angular模塊并發(fā)布npm包
更新時間：2018年04月19日 09:38:07 作者：易兒善
本篇文章主要介紹了使用typescript開發(fā)angular模塊并發(fā)布npm包，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
本文介紹了使用typescript開發(fā)angular模塊并發(fā)布npm包，分享給大家，具體如下：
創(chuàng)建模塊
初始化package.json文件
執(zhí)行命名
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" # 開源授權協(xié)議名 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包發(fā)布測試項目 ## License 請查看 [MIT license](./LICENSE).
添加一個開源協(xié)議文件
做事情還是要做的有鼻子有眼的嘛。
MIT License Copyright (c) 2017 MZC 本項目為測試項目，完全免費。
添加源碼
創(chuàng)建一個src目錄并添加一個Index.ts文件
export class MzcNgApi{
private name: string;
constructor() {
this.name = "MzcNgApi";
}
}
創(chuàng)建一個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文件
發(fā)布
雖然什么都沒有，但是什么都有了。
修改package.json文件
{
"name": "mzc-ng-api", // 這個名字要小寫且不能重復，有大寫字母會報錯
"version": "1.0.2",
"description": "個人博客系統(tǒng)，從后臺api取數(shù)據(jù)的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
如果沒有賬號就去注冊一個吧
發(fā)布
npm publish
發(fā)布完成立即生效，去npm就能查到并可以下載
使用
新建一個項目安裝包
npm i mzc-ng-api
發(fā)現(xiàn)很多東西都發(fā)布上去了。
而且在開發(fā)工作沒有智能提示。
完善優(yōu)化
編譯時生成頭文件，*.d.ts。
解決編譯器提示功能
在tsconfig.json種設置
"declaration": true,
關于tsconfig.json的更多配置可以好好研究研究
指定發(fā)布文件
修改
{
"name": "mzc-ng-api",
"version": "1.0.2",
"description": "個人博客系統(tǒng)，從后臺api取數(shù)據(jù)的angular封裝",
"main": "index.js",
"types": "./index.d.ts", // 添加這個
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"files": [ // 指定發(fā)布文件
"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 <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 版本的第一個預發(fā)布版本。 npm version prepatch # 版本號從 1.2.4-0 變成 1.3.0-0，就是 1.3.0 版本的第一個預發(fā)布版本。 npm version preminor # 版本號從 1.2.3 變成 2.0.0-0，就是 2.0.0 版本的第一個預發(fā)布版本。 npm version premajor # 版本號從 2.0.0-0 變成 2.0.0-1，就是使預發(fā)布版本號加一。 npm version prerelease 更新 npm publish
下載下來看看就好多了
封裝些腳本。
可以根據(jù)自己需求編寫更多快捷腳本
"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"
},
至此基本的流程算是走通了。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
AngularJS基礎 ng-mousemove 指令簡單示例
本文主要介紹AngularJS ng-mousemove 指令,這里幫大家整理了ng-mousemove 指令的詳細資料,并附有示例代碼,有需要的朋友參考下2016-08-08
Angular.js項目中使用gulp實現(xiàn)自動化構建以及壓縮打包詳解
基于流的前端自動化構建工具，利用gulp可以提高前端開發(fā)效率，特別是在前后端分離的項目中。下面這篇文章主要給大家介紹了關于在Angular.js項目中使用gulp實現(xiàn)自動化構建以及壓縮打包的相關資料，需要的朋友可以參考下。2017-07-07
這篇文章主要介紹了Angular實現(xiàn)下拉框模糊查詢功能,涉及AngularJS事件響應及字符串查詢等相關操作技巧,需要的朋友可以參考下2018-01-01
Ionic + Angular.js實現(xiàn)圖片輪播的方法示例
圖片輪播在我們日常開發(fā)中是再熟悉不過的了，下面這篇文章主要給大家介紹了Ionic + Angular實現(xiàn)圖片輪播的方法，文中給出了詳細的示例代碼供大家參考學習，需要的朋友們下面來一起看看吧。2017-05-05
Angular2應用程序實際上是有很多父子組價組成的組件樹，因此，了解組件之間如何通信，特別是父子組件之間，對編寫Angular2應用程序具有十分重要的意義。下面通過本文給大家介紹Angular2 組件交互知識，感興趣的朋友一起看看吧2017-08-08
這篇文章主要介紹了發(fā)布Angular應用至生產環(huán)境的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-12-12
這篇文章主要為大家詳細介紹了angular分頁指令操作的相關資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-01-01
這篇文章主要介紹了Angular短信模板校驗代碼,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-09-09
Angular @HostBinding()和@HostListener()用法
本篇文章主要介紹了Angular @HostBinding()和@HostListener()用法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-03-03
本篇文章給大家分享了angularjs結合html5實現(xiàn)拖拽功能的方法以及代碼實例，有興趣的朋友參考下。2018-06-06