#getter #migration #programming #code #rust

app fix-getters-def

通过删除适用情况下的get前缀来修复getter定义

4 个版本

0.3.2 2021年5月31日
0.3.1 2021年5月3日
0.3.0 2021年4月20日
0.2.1 2021年4月11日

2103开发工具

MIT/Apache

120KB
2.5K SLoC

fix-getters-def

此软件包是一个工具,通过删除get前缀来修复getter定义,根据rules规则。它还在必要时插入一个[doc)]属性,以便可以通过搜索旧名称从文档中检索新的getter名称。

有关fix-getters的更多详细信息,请参阅工作区文档

安装

您可以使用cargo安装fix-getters-def,这将允许您将工具作为常规命令调用。

从crates.io安装

cargo install fix-getters-def

从源安装

cargo install --path fix-def

用法

默认调用

警告:默认情况下,fix-getters-def将覆盖现有文件。如果您想在一个单独的目录中检查输出,请参阅以下内容。

这将修复当前目录中的项目

fix-getters-def
cargo fmt

请注意,调用站点不会更改。请使用fix-calls进行更改。

如果您想先测试结果,请运行

fix-getters-def _PROJECT_PATH_ _OUTPUT_PATH_

项目文件不会更改:修改后的文件将在_OUTPUT_PATH_下生成。请注意,但是,只有修改后的文件会被生成,因此您将无法运行cargo fmt

保守的get函数识别

如果您希望采用基于get函数签名的保守方法,请使用--conservative选项(简写-c)。默认情况下,所有get函数都将重命名。

有关保守识别模式的更多详细信息,请参阅工作区文档

文档别名属性

默认情况下,fix-getters-def为重命名的函数添加一个具有原始名称的doc别名属性。

使用--no-doc-aliases选项(简写为-n)如果您不想生成文档别名属性。

在版本0.3.1之前,只有在提供了--doc-alias选项(简写为-d)时才会添加文档别名。此选项现已弃用,将在下一个主要版本中删除。

卸载

要卸载,请使用

cargo uninstall fix-getters-def

许可协议

本仓库根据您的选择受以下其中之一许可协议的约束

依赖

~2–10MB
~90K SLoC