Added config file support

Author: adamlui

find-project-root/.project-root.json5

@@ -0,0 +1,5 @@
+{
+  "path": "",     // starting dir to search for project root (default: CWD)
+  "max_depth": 9, // max levels to traverse up
+  "markers": ""   // custom marker files to look for
+}

find-project-root/docs/README.md

@@ -130,6 +130,24 @@ find-project-root --path=src --max-depth=5 --markers=.manifest.json
 
 <hr>
 
+## Config file
+
+Run `find-project-root --init` to create `.project-root.config.json5` in your project root to set default options.
+
+Example defaults:
+
+```json5
+{
+  "path": "",     // starting dir to search for project root (default: CWD)
+  "max_depth": 9, // max levels to traverse up
+  "markers": ""   // custom marker files to look for
+}
+```
+
+_Note: CLI arguments always override config file._
+
+<hr>
+
 
 ## MIT License
 

find-project-root/src/find_project_root/cli/lib/init.py

@@ -3,7 +3,7 @@
 
 from sys_lang import get_sys_lang
 
-from . import data
+from . import data, log
 
 def cli() -> sn:
     from . import env, language, settings
@@ -12,3 +12,62 @@ def cli() -> sn:
         language.generate_random_lang(excludes=['en']) if env.is_debug_mode() else get_sys_lang())
     settings.load(cli)
     return cli
+
+def config_file(cli: sn) -> None: # for --init
+
+    # Init target_path
+    import find_project_root
+    project_root = find_project_root(max_depth=20) # type: ignore
+    if project_root:
+        config_dir, in_project_root = Path(project_root), True
+    else:
+        log.warn(cli.msgs.warn_NO_PROJECT_ROOT_FOUND)
+        user_resp = input(f'{cli.msgs.prompt_INIT_CONFIG_HERE_ANYWAY}? (y/N): ').strip().lower()
+        if not user_resp.startswith('y') : return
+        config_dir, in_project_root = Path.cwd(), False
+    target_path = config_dir / f'.{ cli.short_name or cli.name }.config.json5'
+
+    # Handle existing file
+    if target_path.exists():
+        if cli.config.force:
+            log.info(f'{cli.msgs.log_OVERWRITING_CONFIG_AT} {target_path}...\n')
+        else:
+            log.warn(f'{cli.msgs.warn_CONFIG_EXISTS_AT} {target_path}. {cli.msgs.log_SKIPPING} init...')
+            log.tip(f'{cli.msgs.tip_PASS_FORCE_TO_OVERWRITE}.')
+            return
+
+    # Fetch/write from jsDelivr
+    if not getattr(config_file, 'cached_default', None):
+        from . import jsdelivr, url
+        jsd_url = f'{jsdelivr.create_pkg_ver_url(cli)}/{target_path.name}'
+        log.debug(f'{log.colors.bw}{jsd_url}')
+        config_file.cached_default = url.get(jsd_url)
+    data.file.write(str(target_path), config_file.cached_default)
+    log.success(f'{cli.msgs.log_DEFAULT_CONFIG_CREATED_AT} {target_path}')
+    if not in_project_root : log.tip(f'{cli.msgs.tip_MOVE_CONFIG_TO_ROOT}.')
+
+def config_filepath(cli: sn) -> None: # for settings.load()
+
+    # Check --config <path>
+    if getattr(cli.config, 'config', ''):
+        cli.config_filepath = Path(cli.config.config).resolve()
+        if cli.config_filepath.exists():
+            log.debug(f'Config file found: {cli.config_filepath}')
+            return
+        else:
+            log.warn(f'{cli.msgs.warn_SPECIFIED_CONFIG} {cli.config_filepath} {cli.msgs.warn_NOT_FOUND}')
+
+    # Search upwards
+    possible_config_filenames = [
+        f'{prefix}{name}.config.json{suffix}'
+            for prefix in ['.', ''] for name in [cli.short_name, cli.name] for suffix in ['5', '', 'c']
+    ]
+    current_dir = Path.cwd().resolve()
+    for parent in [current_dir, *current_dir.parents]:
+        for filename in possible_config_filenames:
+            possible_config_filepath = parent / filename
+            if possible_config_filepath.exists():
+                cli.config_filepath = possible_config_filepath
+                return
+
+    cli.config_filepath = None

find-project-root/src/find_project_root/cli/lib/log.py

@@ -22,6 +22,8 @@ def error(msg: str, *args, **kwargs) -> None : print(f'\n{colors.br}ERROR: {msg.
 def help_cmd(cli: sn) -> None : info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --help' {cli.msgs.log_FOR_AVAIL_OPTIONS}\n")
 def info(msg: str, *args, end: str = '', **kwargs) -> None:
     print(f'\n{colors.by}{msg.format(*args, **kwargs)}{colors.nc}', end=end)
+def init_cmd(cli: sn) -> None:
+    info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --init' {cli.msgs.log_TO_CREATE_DEFAULT_CONFIG}\n")
 def line_break() : print()
 def overwrite_print(msg: str, *args, **kwargs) -> None:
     sys.stdout.write('\r' + msg.format(*args, **kwargs).ljust(terminal_width)[:terminal_width])

find-project-root/src/find_project_root/cli/lib/settings.py

@@ -2,7 +2,7 @@
 from types import SimpleNamespace as sn
 from typing import Optional
 
-from . import log, string, url
+from . import init, log, string, url
 
 controls = sn(
     path=sn(
@@ -11,6 +11,12 @@
         args=['-d', '--max-depth'], action='store', type=int, default_val=9, metavar='N'),
     markers=sn(
         args=['-m', '--markers'], metavar='MARKER', type=str, parser='csv'),
+    config=sn(
+        args=['--config'], type=str),
+    init=sn(
+        args=['-i', '--init'],
+        action='store_true', subcmd='true', exit=True, handler=lambda cli: init.config_file(cli)
+    ),
     help=sn(
         args=['-h', '--help'], action='help'),
     version=sn(
@@ -49,6 +55,28 @@ def load(cli: sn) -> None:
         if ctrl_key.startswith('legacy_') : continue
         if not hasattr(ctrl, 'help') : ctrl.help = getattr(cli.msgs, f'help_{ctrl_key.upper()}')
 
+    # Load from config file
+    init.config_filepath(cli)
+    if getattr(cli, 'config_filepath', None):
+        config_data = data.json.read(cli.config_filepath)
+        for config_key in config_data:
+            if not get_canonical_key(config_key):
+                log.cmd_docs_url_exit(cli,
+                    f'{cli.msgs.err_INVALID_KEY} {config_key!r} {cli.msgs.err_FOUND_IN}'
+                    f'\n{log.colors.gry}{cli.config_filepath}',
+                    cmd='init')
+        for config_key, config_val in config_data.items():
+            canonical_key = get_canonical_key(config_key)
+            if canonical_key and config_key != canonical_key: # re-map config_key -> canonical_key
+                log.warn_legacy_option(cli, config_key, source='config')
+                if is_neg_key(config_key) != is_neg_key(canonical_key):
+                    config_val = not config_val # flip bool val of opposite keys first
+                config_key = canonical_key
+            setattr(cli.config, config_key, config_val)
+        log.debug(f'Config file loaded! {log.colors.dg}{len(config_data)} keys processed', cli)
+    else:
+        log.debug('No config file found.')
+
     # Parse CLI args (overriding config file loads)
     argp = argparse.ArgumentParser(description=cli.description, add_help=False)
     valid_argparse_kwargs = {