forumkit-tsconfig v1.0.0

Forumkit Typescript Config

tsconfig.json用于 Forumkit 扩展的标准化产品。

用法

您需要配置一个 tsconfig.json 文件，以确保 IDE 正确设置 Typescript 支持。

您需要将此包安装为扩展 JS 的开发依赖项：

npm install --save-dev forumkit-tsconfig
yarn add --dev forumkit-tsconfig

下面提供了一个基线，您可以根据需要对其进行修改。需要将此 tsconfig.json 文件复制到扩展的文件夹中，IDE 才能应用正确的设置。

{
  // 使用 Forumkit 的 tsconfig 作为起点
  "extends": "forumkit-tsconfig",
  // 这将匹配您 `src` 文件夹中的所有 .ts, .tsx, .d.ts, .js, .jsx 文件 ，
  // 并且还告诉您的 TypeScript 服务器读取核心的全局类型定义
  // 以在全局命名空间中访问 `dayjs` 和 `$` 
  "include": ["src/**/*", "../vendor/forumkit/core/js/dist-typings/@types/**/*"],
  "compilerOptions": {
    // 这将输出类型定义到 `dist-typings`
    "declarationDir": "./dist-typings",
    "paths": {
      "forumkit/*": ["../vendor/forumkit/core/js/dist-typings/*"]
    }
  }
}

您还需要确保在您的扩展程序的根目录中运行 composer update 以确保将 Forumkit 核心的一份副本下载到您的 vendor 文件夹中。请记住，不要 将 vendor 提交到 Git 仓库中。