在 VSCode 中像写 TypeScript 一样写 JavaScript

这篇文章距离上次修改已过233天，其中的内容可能已经有所变动。

在VSCode中使用JavaScript进行编写时，可以通过以下几种方式来提高代码的可读性和提高生产力：

使用JavaScript的类型注解（只在支持TypeScript语法的VSCode中有效）：

// @ts-check
/** @type {number} */
let a = 10;
a = "Hello World"; // 这会在保存时提示错误

使用JSDoc注释来注释函数和变量：

/**
 * 加法函数
 * @param {number} a 加数
 * @param {number} b 加数
 * @returns {number} 结果
 */
function add(a, b) {
    return a + b;
}

/** @type {number} */
let result = add(5, 3); // result 类型为 number

使用VSCode的智能感知功能：

使用/// <reference lib="dom" />来启用DOM智能感知。
使用/// <reference lib="es2015" />来启用ECMAScript 2015 (ES6)智能感知。

在jsconfig.json文件中配置JavaScript项目：

{
    "compilerOptions": {
        "target": "es6",
        "module": "commonjs",
        "allowSyntheticDefaultImports": true
    },
    "exclude": [
        "node_modules"
    ]
}

使用ESLint进行代码质量检查和格式一致性：

首先安装ESLint：

npm install eslint --save-dev

然后运行ESLint初始化：

./node_modules/.bin/eslint --init

根据提示进行配置，VSCode可以使用ESLint插件来在保存文件时自动格式化代码。

使用Prettier进行代码格式化：

首先安装Prettier：

npm install prettier --save-dev --save-exact

然后在package.json中添加Prettier配置：

{
  "name": "your-package-name",
  "version": "1.0.0",
  "devDependencies": {
    "prettier": "1.19.1"
  },
  "scripts": {
    "format": "prettier --write \"src/**/*.js\""
  }
}

在VSCode中安装Prettier插件，然后可以通过按下Shift + Alt + F（或者通过右键菜单选择“Format Document”）来格式化当前文件。

使用TypeScript编写代码，并将其编译为JavaScript：

首先安装TypeScript：

npm install typescript --save-dev

然后创建一个tsconfig.json文件并配置：

{
    "compilerOptions": {
        "target": "es6",
        "module": "commonjs",
        "outDir": "./dist",
        "allowJs": true
    },
    "include": [
        "./src/**/*"
    ]
}

在VSCode中，可以通过任务：Terminal > Run Task... > tsc: watch - tsconfig.json来启动TypeScript的监视编译。

这些方法可以帮助你在VSCode中更加高效地编写JavaScript代码，提高代码质量和可维护性。

在 VSCode 中像写 TypeScript 一样写 JavaScript

评论已关闭

推荐阅读