TypeScript - 在代码库中将 npm 包标记为已弃用

Question

我们有一个 TypeScript 代码库，并在其中使用各种 npm 包。该团队现已决定停止使用其中一个软件包。由于需要一段时间才能将其从我们的代码中删除，因此我们希望将其标记为已弃用。

以便开发人员获得诸如标记为已弃用的函数之类的提示。在 VSCode 中，这些函数被划掉了。加上可选注释中的注释： “不要使用 X，而使用 Y。”

这可能吗？

Answer 1

对代码库中使用的库进行强制检查的一个好方法是通过 eslint。

如果您使用

eslint-plugin-deprecate

，正如我在评论中提到的，您可以突出显示已弃用的函数、成员表达式和导入的使用，并决定仅显示警告或抛出错误并强制修复构建。

通过使用 eslint 规则，您可以在 CI 链的某些阶段引入自动检查。甚至为每个开发人员提供 VSCode 中的工具，以查看已弃用、不应使用或应更新的内容的错误/警告。

这里是插件完整文档的链接：