Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.79 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.79 KB
Raw

comby-rust

Rewrite rules for Rust code using the comby refactoring tool.

Overview

This structural find-and-replace tool allows implementing rules with different purposes:

  • templates.toml: refactorings that are non-controversial and will require minimal manual supervision a posteriori. They should not change code semantics.
  • experimental-templates.toml: refactorings that are a matter of style, or will require modifications in a large number of cases, but may still be useful.
  • nopanic.toml: refactorings that remove panics (and therefore change semantics).

Requirements and installation

Please refer to the comby installation and usage instructions.

Running

  • comby -config templates.toml -f .rs finds matches
  • comby -config templates.toml -f .rs -i replaces file contents
  • You may want to run cargo clean before running the above
  • You should run cargo fmt after running the above

Exclude target directory with:

  • comby -config template.toml -f .rs -i -exclude-dir target

Testing

See the test/run.sh script for templates and expected results.

See also

go-patterns, a similar pattern repo for the Go language, which inspired this.

Licence

Copyright 2021 François Garillot

This software is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.