|0.3.2||May 31, 2021|
|0.3.1||May 3, 2021|
|0.3.0||Apr 20, 2021|
|0.2.1||Apr 11, 2021|
#1146 in Development tools
This package is a tool to fix getters definitions by removing the
It also inserts a
[doc(alias = "get_field")] attribute where necessary so that
the new name for the getter can be retrieved from the documentations by searching
for previous name.
See the workspace documentation
for more details on
You can install
cargo, which allows invoking the tool
as a regular command.
cargo install fix-getters-def
cargo install --path fix-def
Warning: by default,
fix-getters-def will overwrite existing files.
See below if you want to check the output in a separate directory.
This will fix the project in current directory:
fix-getters-def cargo fmt
Note that the call sites won't be changed. Use fix-calls for that.
If you wish to test the result first, run:
fix-getters-def _PROJECT_PATH_ _OUTPUT_PATH_
The project files won't be changed: modified files will be generated under
_OUTPUT_PATH_. Note however that only the modified files are generated, so
you won't be able to run
Conservative get function identification
--conservative option (short
-c) if you prefer applying a
conservative approach based on the
get function signature. By default, all
get functions are renamed.
See the workspace documentation for more details on the conservative identification mode.
doc alias attributes
fix-getters-def adds a doc alias attribute with the original name
for the renamed functions.
--no-doc-aliases option (short
-n) if you don't want to generate the
doc alias attributes.
Prior to version
0.3.1, doc aliases were added only if the
-d) was provided. This option is now deprecated and will be
removed in the next major version.
To uninstall, use:
cargo uninstall fix-getters-def
This crate is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.