diff --git a/README.md b/README.md index 327f6ee..cba23b0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ Java properties files can get messy. With **props_check.py** script you can check the properties files. The script might be useful for: -- checking local config files for new/obsolete keys - ie when upgrading to a new version +- checking for duplicate keys, comparing keys and values, locating keys in a local repository +- checking local config files for new/obsolete keys - ie when upgrading a SW instance to a new version - checking messages*.properties for new/obsolete keys - -dtto- ## Installation @@ -33,21 +34,32 @@ There are 3 commands/actions available: $ py props_check.py sort --indir /messy_project/configs --output merged_configs.properties -### Compare two props files to check +### Compare two props files -- for differing keys: +- to check for differing keys: $ py props_check.py compare messages_en.properties messages_cs.properties -- for differing keys and values: +- to check for differing keys and values: $ py props_check.py compare new/config.properties old/config.properties --values -### Locate keys from a props file in a git repository +### Locate keys from a props file - $ py props_check.py locate config.properties /messy_project/repo --branch main --subdir src --filext java,jsp,vm +- in a git repository tree + + $ py props_check.py locate config.properties /messy_project/repo --branch main --subdir src --filext java,jsp,vm + +- in a git repository tree - include untracked files + + $ py props_check.py locate config.properties /messy_project/repo --untracked + +- in any directory + + $ py props_check.py locate config.properties /messy_project/mydir --noindex > A key is currently being located using **git grep** command - ie: - $ git grep -c "" -- *.java *.vm - $ git grep -c "" -- *.java *.vm + $ git grep -c [--untracked | --no-index] + $ git grep -c -- *.java *.vm + $ git grep -c -- *.java *.vm