2023-05-23-【服务开发】nestjs

发表于 2023-05-11 | 分类于工程化

一、前言背景

1.1 什么是nestjs

NestJS 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的开发框架。它利用 JavaScript 的渐进增强的能力，结合了 OOP（面向对象编程）、FP（函数式编程）和 FRP（函数响应式编程）等编程范式。NestJS 建立在强大的 HTTP 服务器框架上，例如 Express，并提供了更高层次的抽象，同时仍然向开发者直接暴露了底层框架的 API。

阅读全文 »

2023-03-12-【工程化】脚手架搭建手册

发表于 2023-05-11 | 分类于工程化

https://juejin.cn/post/7148331455323013127

阅读全文 »

2023-03-12-【工程化】脚手架搭建手册

发表于 2023-03-12 | 分类于工程化

项目初始化

初始化 package.json npm init 字段说明

{
"name": "sun-arms",
"version": "1.0.0",
"description": "lint & tools",
// main 字段的值是入口文件,即使不包括在 files 字段里，也会被打包。
"main": "index.js",
// files 字段值的类型是字符串数组,数组里面的字符串填写需要发布到 NPM 的文件名。当然也可以在根目录下创建 .npmignore 文件，把不需要上传到 NPM 的文件名填进去。不过有些文件或者目录比如, README.md 或者 LICENSE.md 是默认就会被打包。也有默认不会被打包的目录或者文件，比如, node_modules 或者 .git。
"files": [
  "dist",
  ...
],
"scripts": { 
  "test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
  "type": "git",
  "url": "git+https://github.com/zhangyingxuan/sun-arms.git"
},
"author": "zhangyingxuan",
"license": "ISC",
"bugs": {
  "url": "https://github.com/zhangyingxuan/sun-arms/issues"
},
"homepage": "https://github.com/zhangyingxuan/sun-arms#readme",
"publishConfig": {
  "access": "public",
  "registry": "https://registry.npmjs.org/"
},
// browser 当需要打包多个版本时，设置 browser 字段，可以根据浏览器的不同环境变量，使用不同的版本
// unpkg 提供一个给 UNPKG, 用于支持 CDN 服务，有点类似 browser
// module 若项目中有封装模块，可以设置 module, 也就是设置一个模块的入口, 该字段目前比较前卫
// typings/types TypeScript 解析文件的入口, 该文件会被发布到 NPM, 并且可以被下载，为用户提供更加好的 IDE 支持。
// bin 若项目中包含一些可执行文件，可以把文件名在 bin 字段下, 当只有一个 Node.js 文件入口时, 可以是 string 值，当有多个的时候,可以用键值对的形式写。不过要执行这些文件，需要在文件头部加上 #!/usr/bin/env node
// man 若需要提供命令行输出文档，可以用 man 字段指明,当只有一个文件时, 可以是一个字符串值, 当有多个文件时, 可以是一个字符串数组。
// peerDependencies NPM v3开始，peerDependencies 字段需要自己配置，用于指定一个兼容项目的依赖，该字段的值是一个对象，对象的 key 是兼容包的名称，对象的值是该包的指定版本。
// optionalDependencies 字段用于设置一些项目中的可选包，这些包不一定要下载，但是却很有用，设置在该字段下后，对应的包只会在需要的时候被下载，比如 fsevents 模块，尽在 mac 下有效。
// bundledDependencies 字段是一个字符串数组，数组元素是需要跟最终包一起打包出去的依赖名称。
}