1.0.0 • Published 1 year ago

cmf-tsconfig v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

PHPCmf Typescript Config

用于PHPCmf扩展的标准化 tsconfig.json

用法

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

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

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

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

{
  // 使用 PHPCmf 的 tsconfig 作为起点
  "extends": "cmf-tsconfig",
  // 这将匹配“src”文件夹中的所有.ts,.tsx,.d.ts,.js,.jsx文件r
  // 并告诉您的 Typescript 服务器读取 core 的全局类型
  // 访问全局命名空间中的“DayJS”和“$”。
  "include": ["src/**/*", "../vendor/cmf/core/js/dist-typings/@types/**/*"],
  "compilerOptions": {
    // 这会将键入输出到“dist-typing”
    "declarationDir": "./dist-typings",
    "baseUrl": ".",
    "paths": {
      "cmf/*": ["../vendor/cmf/core/js/dist-typings/*"]
    }
  }
}

您还需要确保在扩展的根目录中运行 composer update 以确保将 PHPCmf 核心的副本下载到您的 vendor 文件夹中。请记住, vendor 应提交到 Git 存储库。