一、基础环境搭建

1. 安装Node.js

TypeScript是基于JavaScript的超集，因此首先需要安装Node.js环境。可以从Node.js官网下载适合自己操作系统的安装包，进行安装。

2. 安装TypeScript

安装TypeScript可以通过npm（Node.js的包管理器）来完成。在命令行中执行以下命令：

npm install -g typescript

3. 初始化TypeScript项目

创建一个新目录，用于存放你的TypeScript项目。进入该目录，然后执行以下命令来初始化项目：

npm init -y

这会生成一个名为package.json的文件，其中包含了项目的各种配置信息。

二、配置TypeScript编译选项

1. 创建tsconfig.json文件

在项目根目录下，创建一个名为tsconfig.json的文件。这个文件包含了TypeScript编译器的各种配置选项。

以下是一个简单的tsconfig.json示例：

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

2. 配置编译选项

在tsconfig.json文件中，你可以配置以下选项：

  • target: 设置编译后的JavaScript版本。
  • module: 设置模块代码生成方式。
  • outDir: 设置编译后的输出目录。
  • rootDir: 设置编译前的源码目录。
  • strict: 启用所有严格类型检查选项。
  • esModuleInterop: 允许默认导入非ES模块。

三、代码编写与组织

1. 文件组织

按照tsconfig.json中的rootDir和outDir设置，将你的源码放在src目录下，编译后的代码将放在dist目录下。

2. 代码编写规范

遵循JavaScript和TypeScript的编码规范，例如：

  • 使用一致的命名规范。
  • 尽量使用TypeScript的类型系统来提高代码的可读性和可维护性。
  • 避免使用魔法数字，使用常量来替代。
  • 使用注释来解释复杂的逻辑。

四、代码管理

1. 使用版本控制系统

为了更好地管理代码，建议使用Git进行版本控制。在项目根目录下，通过以下命令初始化Git仓库：

git init

2. 提交代码

在编写代码时，要定期将更改提交到Git仓库。使用以下命令提交代码：

git add .
git commit -m "Commit message"

3. 推送代码到远程仓库

将本地仓库中的代码推送至远程仓库，可以使用以下命令：

git push origin main

4. 使用GitHub Actions

为了实现自动化构建和部署，可以使用GitHub Actions。在GitHub仓库中创建一个.github/workflows目录，并添加一个名为typescript.yml的文件。以下是一个简单的自动化构建和部署的示例：

name: TypeScript CI/CD

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'
    - run: npm install
    - run: npm run build
    - name: Deploy to Heroku
      uses: akhileshns/heroku-deploy-action@v3
      with:
        heroku_api_key: ${{ secrets.HEROKU_API_KEY }}
        heroku_app_name: 'your-app-name'

通过以上步骤，你就可以完成一个TypeScript项目的搭建，从基础环境配置到代码管理。希望这份攻略对你有所帮助！