TypeScript 中的代码样式辅助
ReSharper 提供了许多功能来保持您的代码整洁清晰。 这些功能与大多数其他 ReSharper 的功能紧密结合,帮助您根据特定的代码样式生成代码并更改现有的代码库。 代码样式包括命名标准、格式规则以及许多其他细微方面,可以配置到非常详细的级别,并在团队中共享。
与其他语言类似,所有 TypeScript 代码样式偏好都可以通过单个命令在所需范围内应用,使用 在范围内修复 或 代码清理。
ReSharper 在 TypeScript 中提供以下代码样式辅助功能:
命名样式
ReSharper 帮助您定义、控制并应用代码中符号的所需命名样式。 有一组规则,每条规则都针对具有特定约束条件的标识符。 每条规则可以有一个或多个关联样式,这些样式定义了复合词的大小写、下划线、后缀、前缀等。
当 ReSharper 使用 代码补全和 代码生成功能生成新代码时,应用 代码模板或执行 重构时,这些规则都会被考虑在内。 ReSharper 还可以帮助您 检测并修复命名规则的违规情况。 如果需要,可以 配置或禁用命名规则的自动检查。
有关配置和应用命名样式的更多信息,请参阅 命名样式
管理和应用代码格式规则
代码样式的一个重要方面是如何格式化代码,即如何使用空格、制表符和换行符来排列代码元素,是否以及如何使用制表符进行缩进,是否以及如何换行长行代码等。
ReSharper 的广泛代码格式规则集具有默认配置,该配置考虑了默认的 Visual Studio 格式选项以及众多最佳实践。 您可以 配置 格式规则的每个细节,并在代码中强制执行这些规则。 当 ReSharper 使用 代码补全 和 代码生成 功能生成新代码时,应用 代码模板 或执行 重构 时,这些规则都会被应用。 格式规则也可以 应用于现有代码 ,从当前选择、当前文件到更大范围,直至整个解决方案。
ReSharper 使用 共享设置 机制存储格式偏好。 您可以在 组下的选项页面中 配置格式规则。 您还可以在 EditorConfig 和 Clang-Format 文件中 存储和共享格式化设置。
引号样式
TypeScript 规范允许使用单引号 (') 和双引号 (") 来处理字符串字面量。 在项目或解决方案中保持一致的引号样式是一个好主意。 为此,您可以配置您的偏好以及在 ReSharper 选项的 页面上相应代码检查的 严重性级别。 ReSharper 将检测并高亮显示与您的偏好不一致的代码。 要在现有代码库中强制执行此偏好,可以使用内置配置文件之一 完全清理 或 重新格式化并应用语法样式 运行 代码清理 ,或者创建并运行选择了相应选项的 自定义配置文件。
此偏好与 JavaScript 的相同偏好共享,因此当您在一种语言中更改它时,另一种语言中的偏好也会更改。
模块导入样式
从其他模块导入类型有不同的方法:您可以添加模块别名或使用完全限定的类型名称。 ReSharper 帮助您在所需范围内应用首选的类型导入方式。
应用首选的模块导入样式
使用 ReSharper 选项的 页面上的 在导入类型时,优先添加模块别名而不是限定 复选框来指定您的偏好。
在所需范围内使用“完全清理”配置文件 运行代码清理。
如果需要,您可以使用自定义配置文件来应用模块导入样式。 为此,请 创建自定义清理配置文件 并在 TypeScript 特定 配置文件设置中勾选 优化 'import' 语句 复选框。
优化引用注释
ReSharper 帮助您检测并删除未使用的引用注释。 要优化引用注释,请在所需范围内使用“完全清理”配置文件 运行代码清理 ,或 创建自定义清理配置文件 并在 TypeScript 特定 配置文件设置中勾选 优化引用注释 复选框。
语句终止
JavaScript/TypeScript 不要求语句在以换行符结束或括号中只有一个语句时使用分号终止。 然而,通常建议在每个语句后使用分号(例如,请参阅 此 StackOverflow 线程)。 ReSharper 可以帮助您自动添加分号。
要在特定文件、项目或解决方案中终止语句,请在所需范围内使用“完全清理”配置文件或选择了 终止语句 的 JavaScript/TypeScript 部分的 自定义配置文件 运行 代码清理。
排列修饰符
如果您倾向于使用或不使用显式的 'public' 修饰符,您可以在 ReSharper 选项的 页面上配置您的偏好以及相应代码检查的 严重级别。 ReSharper 将检测并高亮显示与您的偏好不一致的代码。 要在现有代码库中强制执行此偏好,可以使用内置配置文件之一 完全清理 或 重新格式化并应用语法样式 运行 代码清理 ,或者创建并运行选择了相应选项的 自定义配置文件。
隐式/显式类型
TypeScript 规范允许隐式或显式指定类型,也允许使用 'any' 关键字表示类型。 使用 ReSharper 的代码样式辅助功能,您可以定义是否以及何时应显式指定类型,以及是否允许隐式 'any'。
使用 ReSharper 选项的 页面上的 类型规范 组中的控件来指定您的偏好。
使用隐式 'any' 的首选项也可以在项目设置中配置。 如果项目设置中不允许隐式 'any' 类型,则无论您的代码样式首选项如何,它们始终会被高亮为错误。
要在特定文件、项目或解决方案中应用您的隐式/显式类型偏好,请在所需范围内使用“完全清理”配置文件 运行代码清理 ,或使用 自定义配置文件 ,其中在 TypeScript 特定 部分选择了 将类型注解状态与代码样式同步 和 根据需要添加显式 'any' 类型注解 复选框。
您的隐式/显式类型偏好也会被 ReSharper 的 代码检查 考虑在内。