这个 rimraf 参数 --tsconfig 是关于什么的

what is this rimraf argument --tsconfig about

我是 Node 的新手,在这个 package.json 的 React Typescript 项目中,我了解 rimraf 的作用,但 [=12= 是什么] 最后在做什么?

当我 运行 prebuild 脚本时,我看到文件 typedoc.json 被删除。但是为什么这个 --tsconfig?有一个 tsconfig.json 文件,但我看不到 rimraf 正在做任何事情

"scripts": {
    "build": "tsdx build --transpileOnly --entry ./src/index.js",
    "prebuild": "npm run docs",
    "prepublishOnly": "npm run build",
    "docs": "rimraf typedoc.json && typedoc --tsconfig",
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
},

此代码的来源是 notistack package.json

首先,rimraf 不会对 tsconfig.json 文件做任何事情。重要的是要了解 package.json 文件中的 docs 脚本,即这部分;

"docs": "rimraf typedoc.json && typedoc --tsconfig",

由两个独立的命令组成,它们一起被称为“复合命令”

typedoc --tsconfig 部分是第二个命令,它不是 rimraf 命令的一部分,因为它位于 && 运算符的右侧。 --tsconfig 部分实际上是 typedoc 命令的参数(...它 不是 rimraf 命令的参数)。

本质上,typedoc 命令及其关联的 --tsconfig 参数(位于 && 运算符的右侧)仅在左侧的命令被调用 -它的手边(即第一个命令 rimraf typedoc.json)成功完成,退出代码为零。

typedoc 命令用于为 TypeScript 项目生成文档。

typedoc 命令的 --tsconfig 参数在 documentation

中描述如下

--tsconfig <path/to/tsconfig.json>

Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.

注意:在您使用 --tsconfig 参数时,它没有指定 tsconfig.json 文件的自定义文件路径,因此它使用当前目录中的路径。