https://github.com/mbrukman/easyfix

Make simple fixes easily and safely at scale.
https://github.com/mbrukman/easyfix

cleanup cleanups fixes

Last synced: 24 days ago
JSON representation

Make simple fixes easily and safely at scale.

• Host: GitHub
• URL: https://github.com/mbrukman/easyfix
• Owner: mbrukman
• License: apache-2.0
• Created: 2018-07-02T18:19:38.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T01:26:03.000Z (3 months ago)
• Last Synced: 2024-08-28T02:37:46.401Z (3 months ago)
• Topics: cleanup, cleanups, fixes
• Language: Shell
• Homepage:
• Size: 15.6 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Easyfix

[![Easyfix build Status][easyfix-ci-badge]][easyfix-ci-url]

[easyfix-ci-badge]: https://github.com/mbrukman/easyfix/actions/workflows/main.yml/badge.svg?query=branch%3Amain

[easyfix-ci-url]: https://github.com/mbrukman/easyfix/actions/workflows/main.yml?query=branch%3Amain

Easyfix is a tool for making easy fixes to text files, enabling simple

large-scale cleanups of your code, documentation, or any other files.

Unlike other language-specific frameworks, Easyfix is language-agnostic and is

thus applicable to type of files, such as shell scripts, documentation, etc. Of

course, it can also be used with C++ and Java code, but since it is

language-agnostic, it does not parse the files and hence cannot do

language-semantics-aware editing.

At its core, Easyfix is a simple in-place rewriter using regular expressions,

which may be easier and faster to use for simple cleanups than getting out the

heavy machinery.

It also provides a very simple-to-use testing mechanism so you can verify that

your cleanup will affect exactly what you want to change and neither over-apply

nor under-apply the rewrite, before running the modification script on a large

tree of files.

## Usage

To use easyfix, simply create two files:

* **`.sh`** to make the changes, and

* **`_test.sh`** to verify the changes

See the [`examples`](examples) directory for samples of both types of files.

## Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more details.

## License

Apache 2.0; see [`LICENSE`](LICENSE) for more details.

## Disclaimer

This is not an official Google project. It is not supported by Google and Google

specifically disclaims all warranties as to its quality, merchantability, or

fitness for a particular purpose.