Bulk Property Editor

An interactive console application that simplifies and significantly hastens the process of changing a specific property value in many property or env files at once with just a few keystrokes.

Table of Contents

• Description
• Terminology
• Step-by-Step Guide
• License
• Disclaimer

Terminology

• Property File: In the context of this application, a property file is a test file containing key-value pairs that are used to configure a program.
  • Key value pairs are written in the format of key=value, and are listed one per line.
• Deep search: A type of search that looks for a file in a folder and all of its sub-folders.

Step-by-Step Guide

This has only been tested using a Java SDK of 17 and above
The application has informative prompts to guide you through using it, but if you are unsure of something you can always refer to this section.

• Upon opening, you are prompted to specify a folder (ex: C:\someFolder) to do a deep search for property files in.

  • If you input an invalid directory path, you will be warned of an error and prompted to enter a valid directory.
  • Warning: This application is designed to work on Windows, this means all directory paths must be specified using backslashes (\) instead of forward slashes (/). Application behavior with forward slashes is undefined and may result in errors.

• You will then be prompted to enter the common name shared between the property files you want to modify (ex: aft.properties).

  • Supports regex entry such as: .*\.properties (to match any file ending in .properties) or aft.properties (to match any file with exact name 'aft.properties')

• Then you will be prompted to decide the file modification mode. There are two options:

  • Setting the value of a given key. This option means you must specify a key and a value. For example, you could specify a key 'db.password' and a value 'myDbPassword', then each property file containing the key 'db.password' would have its value set to 'myDbPassword'.
  • Setting a value given the old value. This option means you must specify an old value and a new value. For example, you could specify an old value 'myOldDbPassword' and a new value 'myNewDbPassword', then each property file containing the old value 'myOldDbPassword' would have that value replaced with 'myNewDbPassword'.
    • Warning: a property file can have multiple keys with the same value. This option changes all instances of the old value to the new value. Be cautious with this.

• Then, depending on which option you selected in the last step, you will be prompted to enter either a key or an old value.

• Lastly, you will be prompted to enter the new value you wish to set in the property files.

• The application will then perform a deep search for property files that match the name you specified in the directory you specified. It will then modify the property files according to the mode you specified, and output the name and path of each modified file as well as how many files were modified.

• After the modification has completed, you will be prompted to double check that the changes were made correctly. If they were issues, you can undo all changes made.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details.

Disclaimer

This repository is provided as-is and is intended for informational and reference purposes only. The author assumes no responsibility for any errors or omissions in the content or for any consequences that may arise from the use of the information provided. Always exercise caution and seek professional advice if necessary.