Node.js TypeScript Boilerplate 使用教程

Node.js TypeScript Boilerplate 使用教程

node-typescript-boilerplateMinimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Jest and type definitions included.项目地址:https://gitcode.com/gh_mirrors/no/node-typescript-boilerplate

1. 项目的目录结构及介绍

node-typescript-boilerplate/
├── src/
│   ├── index.ts
│   └── ...
├── __tests__/
│   └── ...
├── .eslintrc.js
├── .prettierrc
├── jest.config.js
├── tsconfig.json
├── package.json
└── README.md

• src/: 存放项目的主要源代码文件。
• __tests__/: 存放项目的单元测试文件。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• jest.config.js: Jest 配置文件，用于单元测试。
• tsconfig.json: TypeScript 配置文件，用于编译 TypeScript 代码。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.ts。这个文件是整个应用程序的入口点，通常包含初始化逻辑和启动服务的代码。

// src/index.ts
import express from 'express';

const app = express();
const port = process.env.PORT || 3000;

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

3. 项目的配置文件介绍

.eslintrc.js

ESLint 配置文件，用于定义代码风格和规则。

module.exports = {
  parser: '@typescript-eslint/parser',
  extends: [
    'plugin:@typescript-eslint/recommended',
    'prettier',
    'plugin:prettier/recommended',
  ],
  parserOptions: {
    ecmaVersion: 2018,
    sourceType: 'module',
  },
  rules: {
    // 自定义规则
  },
};

.prettierrc

Prettier 配置文件，用于代码格式化。

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80
}

jest.config.js

Jest 配置文件，用于单元测试。

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
};

tsconfig.json

TypeScript 配置文件，用于编译 TypeScript 代码。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

package.json

项目的依赖和脚本配置文件。

{
  "name": "node-typescript-boilerplate",
  "version": "1.0.0",
  "scripts": {
    "start": "node dist/index.js",
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "@types/express": "^4.17.13",
    "@types/jest": "^27.0.1",
    "eslint": "^7.32.0",
    "jest": "^27.2.0",
    "prettier": "^2.4.1",
    "ts-jest": "^27.0.5",
    "typescript": "^4.4.3"
  }
}

以上是 Node.js TypeScript Boilerplate 项目的详细使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息

node-typescript-boilerplateMinimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Jest and type definitions included.项目地址:https://gitcode.com/gh_mirrors/no/node-typescript-boilerplate