从零到一: 创建一个新的 TypeScript 项目

一、初始化 npm 项目

npm:

npm init

Git:

git init

二、安装 TypeScript

npm i typescript -D

查看版本:

npx tsc --version

三、初始化配置文件 tsconfig.json

npx tsc --init

四、编译 .ts

新建 index.ts 文件。

项目目录:

├── package.json
├── tsconfig.json
└── src
    └── index.ts

文件 index.ts:

const ProjectName = "new-typescript-project";

function say(): string {
  return `This project is ${ProjectName}.`;
}

console.log(say());

编译:

npx tsc src/index.ts --outDir dist

结果:

var ProjectName = "new-typescript-project";
function say() {
    return "This project is ".concat(ProjectName, ".");
}
console.log(say());

监听文件变化:

npx tsc --watch src/index.ts --outDir dist

五、使用 webpack 打包

5.1 安装 webpack

npm install webpack webpack-cli -D

5.2 安装 TypeScript 加载器 ts-loader

npm install ts-loader -D

5.3 配置 webpack.config.js

const path = require('path');

module.exports = {
  entry: './src/index.ts',
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist')
  },
  module:{
    rules:[
      {
        test: /\.tsx?$/,
        use: 'ts-loader',
        exclude: /node_modules/
      }
    ]
  },
  resolve: {
    extensions: ['.ts', '.tsx']
  }
};

5.4 打包

npx webpack --config webpack.config.js

结果:

(()=>{"use strict";console.log("This project is new-typescript-project.")})();

六、使用 ESLint 规范代码

6.1 安装依赖

npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-prettier -D

6.2 新增配置文件 eslint.config.cjs

touch eslint.config.cjs

const tsPlugin = require('@typescript-eslint/eslint-plugin');
const tsParser = require('@typescript-eslint/parser');
const prettierPlugin = require('eslint-plugin-prettier');
const tsRecommendedRules =
  tsPlugin && tsPlugin.configs && tsPlugin.configs.recommended
    ? tsPlugin.configs.recommended.rules
    : {};

module.exports = [
  {
    ignores: ['node_modules/**', 'dist/**', 'build/**', '*.min.js', '.git/**']
  },
  {
    files: ['**/*.ts', '**/*.tsx'],
    languageOptions: {
      parser: tsParser,
      parserOptions: {
        ecmaVersion: 'latest',
        sourceType: 'module',
        project: ['./tsconfig.json'],
        tsconfigRootDir: __dirname
      }
    },
    plugins: {
      '@typescript-eslint': tsPlugin,
      prettier: prettierPlugin
    },
    rules: {
      ...tsRecommendedRules,
      'prettier/prettier': 'error',
      'no-console': 'off',
      '@typescript-eslint/no-inferrable-types': 'off'
    }
  },
  {
    files: ['**/*.js', '**/*.jsx'],
    languageOptions: {
      ecmaVersion: 'latest',
      sourceType: 'module'
    },
    rules: {
      'no-unused-vars': 'warn'
    }
  }
];

6.3 package.json 中添加检测脚本

"lint": "eslint src/index.ts --ext .ts"

6.4 运行检测

npm run lint

报错示例:

const ProjectName = "new-typescript-project"

1:45  error  Insert `;`  prettier/prettier

修改相应代码:

- const ProjectName = "new-typescript-project"
+ const ProjectName = "new-typescript-project";

再次运行通过！

6.5 自动修复不规范的代码

脚本添加 --fix 选项:

"lint:fix": "eslint src/index.ts --ext .ts --fix"

6.6 添加更多扩展文件

"lint:fix": "eslint src/index.ts --ext .ts,.tsx --fix"

附录

案例: GitHub: new-typescript-project

本文章首次编辑于 2020-08-18，最近更新于 2025-10-27。项目代码在 Node.js 16.x 上已测试可稳定运行。

版权声明

本文为原创文章，作者保留版权。转载请保留本文完整内容，并以超链接形式注明作者及原文出处。

作者: 除除
原文: http://blog.mazey.net/1685.html

(完)