TypeScript文件命名规范

Question

我正在寻找TypeScript文件命名约定，特别是存储类型和接口的文件。

现在，我在GitHub上找到了一些TypeScript编码约定项目，它们甚至提到了文件命名约定这里和这里。但是它们都没有提到我感兴趣的特定文件，即仅存储类型和接口的文件。

就所有事情而言，在我的项目中，此文件用于内部使用和外部API。

- goodvibration

---

不太确定文件名应该是什么（如果适用，我会建议遵循项目的约定），但如果文件只包含类型信息，则给它一个.d.ts扩展名将表示它。 - CRice

@CRice：谢谢，但这就是rimraf（构建项目）在（一些）输出文件中所做的。因此，我不确定以类似的方式命名我的某个源文件是否是一个好主意。我错了吗？ - goodvibration

当涉及到编程时，没有对错之分。如果你喜欢像驼峰式这样的命名方式，请确保打开 --forceConsistentCasingInFileNames，例如，如果你在 Linux 和 Windows 上工作。此外，如果类型是公共 API 的一部分，请选择 .ts 而不是 .d.ts，否则你需要额外的构建步骤。 - ford04

Answer 1

有时候我会厌倦花费时间研究这样的事情，因此我决定采取以下做法。

在“interfaces”文件夹中放置包含接口的文件， 文件命名规则为：file.interface.ts

在“types”文件夹中放置包含类型的文件， 文件命名规则为：file.type.ts

- BrunoElo

Answer 2

我们通常选择“index.d.ts”，并在整个项目中多次使用。

- gatsby

---

谢谢，但这正是rimraf（构建项目）在（某些）输出文件中所做的。因此，我不确定以类似的方式命名我的某个源文件是否是一个好主意。我错了吗？ - goodvibration

Answer 3

一般来说，我遵循谷歌的风格指南。 模块命名空间导入使用小驼峰式，而文件则使用蛇形命名法。

https://google.github.io/styleguide/tsguide.html

- Antonio Roberto