支持 TypeScript | Quasar 框架

Quasar CLI 与 Webpack - @quasar/app-webpack

支持 TypeScript

@quasar/app-webpack v4+

默认情况下，TypeScript 支持不会添加到您的项目中（除非您在创建项目文件夹时选择了 TS），但可以通过遵循此页面上的指南轻松集成。

提示

以下步骤仅在您**未**选择 TypeScript 支持创建新的 Quasar 项目时才需要。如果您在项目创建时选择了 TS 选项，则 TypeScript 支持已启用。

TypeScript 支持的安装

为了支持 TypeScript，您需要更改 quasar.config 文件的扩展名：/quasar.config 文件

import { configure } from "quasar/wrappers";

module.exports = configure((ctx) => {
  return {
    supportTS: true,
    // ...
  }
});

然后在项目的根目录下创建 /tsconfig.json 文件，内容如下

{
  "extends": "@quasar/app-webpack/tsconfig-preset",
  "compilerOptions": {
    // `baseUrl` should be set to the current folder to allow Quasar TypeScript preset to manage paths on your behalf
    "baseUrl": "."
  },
  "exclude": [
    "./dist",
    "./.quasar",
    "./node_modules",
    "./src-capacitor",
    "./src-cordova",
    "./quasar.config.*.temporary.compiled*"
  ]
}

现在您可以开始在项目中使用 TypeScript 了。

提示

请记住，您必须将 JavaScript 文件的扩展名更改为 .ts 才能在其中编写 TypeScript 代码。要将 TS 代码写入您的组件，请更改脚本打开标签，如下所示 <script lang="ts">。

警告

如果您未能添加 tsconfig.json 文件，应用程序将在编译时中断！

处理 TS Webpack 加载器
@quasar/app-webpack =v3

在幕后，Quasar 使用 ts-loader 和 fork-ts-checker-webpack-plugin（由 @quasar/app-webpack 包提供）来管理 TS 文件。如果您需要为这些库提供自定义配置，可以通过如下方式创建 build 属性

module.exports = function (ctx) {
  return {
    supportTS: {
      tsLoaderConfig: {
        // `appendTsSuffixTo: [/\.vue$/]` and `transpileOnly: true` are added by default and cannot be overridden
        ...
      },
      tsCheckerConfig: {
        // `vue: true` is added by default and cannot be overridden
        ...
      }
    },
    ....
  }
}

代码风格检查设置

首先添加所需的依赖项

Yarn

NPM

PNPM

Bun

$ yarn add --dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
# you might also want to install the `eslint-plugin-vue` package.

然后根据以下示例相应地更新您的 ESLint 配置

const { resolve } = require('node:path');

module.exports = {
  // https://eslint.org.cn/docs/user-guide/configuring#configuration-cascading-and-hierarchy
  // This option interrupts the configuration hierarchy at this file
  // Remove this if you have an higher level ESLint config file (it usually happens into a monorepos)
  root: true,

  // https://eslint.vuejs.ac.cn/user-guide/#how-to-use-custom-parser
  // Must use parserOptions instead of "parser" to allow vue-eslint-parser to keep working
  // `parser: 'vue-eslint-parser'` is already included with any 'plugin:vue/**' config and should be omitted
  parserOptions: {
    // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#configuration
    // https://github.com/TypeStrong/fork-ts-checker-webpack-plugin#eslint
    // Needed to make the parser take into account 'vue' files
    extraFileExtensions: ['.vue'],
    parser: '@typescript-eslint/parser',
    project: resolve(__dirname, './tsconfig.json'),
    tsconfigRootDir: __dirname,
    ecmaVersion: 2021, // Allows for the parsing of modern ECMAScript features
    sourceType: 'module', // Allows for the use of imports
  },

  // Rules order is important, please avoid shuffling them
  extends: [
    // Base ESLint recommended rules
    'eslint:recommended',

    // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage
    // ESLint typescript rules
    'plugin:@typescript-eslint/eslint-recommended',
    'plugin:@typescript-eslint/recommended',
    // consider disabling this class of rules if linting takes too long
    'plugin:@typescript-eslint/recommended-requiring-type-checking',

    // https://eslint.vuejs.ac.cn/rules/#priority-a-essential-error-prevention
    // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules
    'plugin:vue/essential',

    // --- ONLY WHEN USING PRETTIER ---
    // https://github.com/prettier/eslint-config-prettier#installation
    // usage with Prettier, provided by 'eslint-config-prettier'.
    'prettier',
    'prettier/@typescript-eslint',
    'prettier/vue',
  ],

  plugins: [
    // required to apply rules which need type information
    '@typescript-eslint',

    // https://eslint.vuejs.ac.cn/user-guide/#why-doesn-t-it-work-on-vue-file
    // required to lint *.vue files
    'vue',
  ],

  // add your custom rules here
  rules: {
    // others rules...

    // TypeScript
    'quotes': ['warn', 'single'],
    '@typescript-eslint/explicit-function-return-type': 'off',
  }
}

如果出现任何问题，请阅读 typescript-eslint 指南，此示例基于该指南。

作为最后一步，更新您的 yarn lint 命令以同时检查 .ts 文件。

提示

由于类型检查开销，TypeScript 代码风格检查非常慢，我们建议您在 /quasar.config 文件中禁用开发构建的 Webpack 代码风格检查扩展。

如果您设置了 TypeScript 代码风格检查并希望 fork-ts-checker-webpack-plugin（由 @quasar/app-webpack 包提供）考虑它，则应使用 tsCheckerConfig 属性

module.exports = function (ctx) {
  return {
    supportTS: {
      tsCheckerConfig: {
        eslint: {
          enabled: true,
          files: './src/**/*.{ts,tsx,js,jsx,vue}'
        }
      }
    },
    ....
  }
}

发现错误？在浏览器中编辑此页面

1. 简介

2. TypeScript 支持的安装

3. 处理 TS Webpack 加载器

3.1. 代码风格检查设置

TypeScript 支持的安装

处理 TS Webpack 加载器@quasar/app-webpack =v3

代码风格检查设置

处理 TS Webpack 加载器
@quasar/app-webpack =v3