Changed --init to create .config.jsonc file, added more file types/names supported

Author: adamlui

…ate-messages/.translate-msgs.config.json …te-messages/.translate-msgs.config.jsonctranslate-messages/.translate-msgs.config.json renamed to translate-messages/.translate-msgs.config.jsonc translate-messages/.translate-msgs.config.json renamed to translate-messages/.translate-msgs.config.jsonc

@@ -46,7 +46,7 @@ Options can be set by using command-line arguments:
 | `--exclude-langs`      | Comma-separated list of languages to exclude                                                         | `--exclude-langs=en,es`
 | `-k`, `--keys`         | Comma-separated list of keys to translate                                                            | `--keys=appDesc,err_notFound`
 | `--exclude-keys`       | Comma-separated list of keys to ignore                                                               | `--exclude-keys=appName,author`
-| `-i`, `--init`         | Create .translate-msgs.config.json in project root to store defaults                                 |
+| `-i`, `--init`         | Create .translate-msgs.config.jsonc in project root to store defaults                                |
 | `-f`, `--force`        | Force overwrite of existing config file when using `--init`                                          |
 | `-W`, `--no-wizard`    | Skip interactive prompts during start-up                                                             |
 | `-h`, `--help`         | Show help screen                                                                                     |
@@ -69,11 +69,11 @@ translate-msgs -k appDesc,err_notFound -d _msgs -W
 
 ## Config file
 
-Use `--init` to create `.translate-msgs.config.json` in your project root to set default options.
+Use `--init` to create `.translate-msgs.config.jsonc` in your project root to set default options.
 
 Example defaults:
 
-```json
+```jsonc
 {
   "locales_dir": "_locales",
   "target_langs": "",

translate-messages/docs/README.md

@@ -72,6 +72,7 @@ translate-messages = "translate_messages.__main__:main"
 
 [project.optional-dependencies]
 dev = [
+    "json5>=0.9.0",
     "tomli>=2.0.0,<3.0.0",
     "tomli-w>=0.1.0,<2.0.0",
 ]

translate-messages/pyproject.toml

@@ -1,8 +1,9 @@
 import json, os
+import json5
 
-def read(json_path):
-    if not os.path.exists(json_path) : return {}
-    with open(json_path, 'r', encoding='utf-8') as file : return json.load(file)
+def read(file_path):
+    with open(file_path, 'r') as file:
+        return json5.load(file)
 
 def write(src_data, target_path):
     os.makedirs(os.path.dirname(target_path), exist_ok=True)

translate-messages/src/translate_messages/lib/data/json.py

@@ -14,7 +14,7 @@ def config_file(cli):
             log.warn(f'Config already exists at {cli.config_filepath}. Skipping --init.')
             log.tip('Pass --force to overwrite.')
             return
-    cli.config_filename = '.translate-msgs.config.json'
+    cli.config_filename = '.translate-msgs.config.jsonc'
     cli.config_filepath = os.path.join(cli.project_root, cli.config_filename)
     try:
         jsd_url = f'{cli.urls.jsdelivr}/{cli.name}/{cli.config_filename}'

translate-messages/src/translate_messages/lib/init.py

@@ -26,7 +26,7 @@
     ),
     init=sns(
         args=['-i', '--init'],
-        action='store_true', help='Create .translate-msgs.config.json file to store defaults'
+        action='store_true', help='Create .translate-msgs.config.jsonc file to store defaults'
     ),
     force=sns(
         args=['-f', '--force', '--overwrite'],
@@ -48,15 +48,21 @@ def load(cli, caller_file):
     cli.config = sns()
     cli.project_root = path.join(path.dirname(caller_file),
         f"../../{ '' if 'src' in path.dirname(caller_file) else '../../' }")
+    if not getattr(cli, 'short_name', None) : cli.short_name = cli.name.replace('messages', 'msgs')
     possile_config_filenames = [
-         '.translate-msgs.config.json', 'translate-msgs.config.json',
-        f'.{cli.name}.config.json', f'{cli.name}.config.json'
+        f'.{cli.short_name}.config.json', f'{cli.short_name}.config.json',
+        f'.{cli.short_name}.config.jsonc', f'{cli.short_name}.config.json',
+        f'.{cli.short_name}.config.json5', f'{cli.short_name}.config.json',
+        f'.{cli.name}.config.json', f'{cli.name}.config.json',
+        f'.{cli.name}.config.jsonc', f'{cli.name}.config.jsonc',
+        f'.{cli.name}.config.json5', f'{cli.name}.config.json5',
     ]
     for filename in possile_config_filenames:
         cli.config_filepath = path.join(cli.project_root, filename)
         if path.exists(cli.config_filepath):
             cli.config = data.sns.from_dict(data.json.read(cli.config_filepath))
             cli.config_filename = filename
+            print(cli.config) ; exit()
             break
 
     # Parse CLI args