关于 jsconfig.json 文件在导入文件路径提示方面

前文:以前我弄不清 jsconfig.json 文件的作用是什么,只觉得 tsconfig.json 文件是用来 ts 编译的配置项,js 又不用编译为什么会需要 jsconfig.json 文件。搬了这么久的砖,也算是有所心得,今日记下以备不时之需。

jsconfig.json 文件是用于配置 JavaScript 项目的 Visual Studio Code 设置的文件。它类似于 TypeScript 项目中的 tsconfig.json 文件,但是用于纯 JavaScript 项目。以下是关于 jsconfig.json 文件的一些说明,重点放在文件导入提示和与 tsconfig.json 文件的共性,以及与 Path Autocomplete 插件的对比:

1. 文件导入提示(Path Intellisense)

  • 基础设置

    • jsconfig.json 可以包含基础的配置信息,例如 compilerOptionsincludeexclude 等,以帮助 Visual Studio Code 更好地理解项目结构。
    • 示例:
      {
        "compilerOptions": {
          "baseUrl": "./src"
        },
        "include": ["src/**/*.js"]
      }
      
  • 路径提示

    • 使用 baseUrl 配置根路径,可以让你使用相对路径或者基于根路径的绝对路径进行导入。
    • 示例:
      // 使用相对路径
      import { someFunction } from './utils/helper';
      
      // 使用根路径
      import { someFunction } from 'utils/helper';
      

2. tsconfig.json 的共性

  • 基本结构

    • jsconfig.json 的结构和 tsconfig.json 类似,都包含了 compilerOptions 等配置项,但 jsconfig.json 针对 JavaScript 项目。
  • 路径配置

    • baseUrlpathsjsconfig.json 中同样可以用于配置根路径和路径别名,使得导入语句更加清晰。
    • 示例:
      {
        "compilerOptions": {
          "baseUrl": "./src",
          "paths": {
            "@/*": ["*"]
          }
        },
        "include": ["src/**/*.js"]
      }
      

3. 与 Path Autocomplete 插件的对比

  • 内置支持

    • jsconfig.json 提供了一些内置的支持,而不需要额外的插件。它允许你在导入语句中获得基本的路径提示。
  • 全局导入提示

    • Path Autocomplete 插件可能提供更强大的全局导入提示,因为它专注于路径自动补全功能,而不仅限于 JavaScript 或 TypeScript 项目。
  • 个性化配置

    • 插件可能提供更多个性化的配置选项,以适应特定的需求。如果你需要更高度定制的路径提示,插件可能是更好的选择。

总的来说,jsconfig.json 文件是一种在 JavaScript 项目中配置文件导入提示的简便方式,尤其是在项目结构较为简单的情况下。如果你需要更高度定制的路径提示功能,可能需要考虑使用 Path Autocomplete 插件。

你可能感兴趣的:(json)