Users/ssantolu/refactor (#26)

* refactor config settings flow

* update version

* ran lint tools

* replace INI with PY

* update version

* removing unnecessary file

* removed old files

---------

Co-authored-by: Salvador Santoluctio <salvador.santolucito@ni.com>

Author: ssantolu

README.md

@@ -41,7 +41,7 @@ def cli(ctx):
 
 
 @cli.command("migrate-clip", help="Migrate CLIP files for FlexRIO custom devices")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def migrate_clip_cmd(ctx, config):
     """Migrate CLIP files for FlexRIO custom devices."""
@@ -58,7 +58,7 @@ def migrate_clip_cmd(ctx, config):
 
 
 @cli.command("install-target", help="Install LabVIEW FPGA target support files")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def install_target_cmd(ctx, config):
     """Install LabVIEW FPGA target support files."""
@@ -75,7 +75,7 @@ def install_target_cmd(ctx, config):
 
 
 @cli.command("get-window", help="Extract window netlist from Vivado project")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def get_window_cmd(ctx, config):
     """Extract window netlist from Vivado project."""
@@ -92,7 +92,7 @@ def get_window_cmd(ctx, config):
 
 
 @cli.command("gen-target", help="Generate LabVIEW FPGA target support files")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def gen_target_cmd(ctx, config):
     """Generate LabVIEW FPGA target support files."""
@@ -109,7 +109,7 @@ def gen_target_cmd(ctx, config):
 
 
 @cli.command("gen-hdl", help="Generate Window VHDL files from CSV/templates")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def gen_hdl_cmd(ctx, config):
     """Generate Window VHDL files only."""
@@ -126,7 +126,7 @@ def gen_hdl_cmd(ctx, config):
 
 
 @cli.command("gen-xdc", help="Generate XDC constraint files from templates")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def gen_xdc_cmd(ctx, config):
     """Generate XDC constraint files from templates."""
@@ -145,7 +145,7 @@ def gen_xdc_cmd(ctx, config):
 @cli.command("create-project", help="Create or update Vivado project")
 @click.option("--overwrite", "-o", is_flag=True, help="Overwrite and create a new project")
 @click.option("--update", "-u", is_flag=True, help="Update files in the existing project")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def create_project_cmd(ctx, overwrite, update, config):
     """Create or update Vivado project."""
@@ -164,7 +164,7 @@ def create_project_cmd(ctx, overwrite, update, config):
 
 
 @cli.command("check-syntax", help="Check Vivado RTL syntax and hierarchy quickly")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def check_syntax_cmd(ctx, config):
     """Check Vivado RTL syntax and hierarchy using RTL elaboration."""
@@ -181,7 +181,7 @@ def check_syntax_cmd(ctx, config):
 
 
 @cli.command("compile-project", help="Compile Vivado project and generate a LabVIEW FPGA bitfile")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def compile_project_cmd(ctx, config):
     """Compile Vivado project and generate a LabVIEW FPGA bitfile."""
@@ -198,7 +198,7 @@ def compile_project_cmd(ctx, config):
 
 
 @cli.command("launch-vivado", help="Launch Vivado with the current project")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def launch_vivado_cmd(ctx, config):
     """Launch Vivado with the current project."""
@@ -218,7 +218,7 @@ def launch_vivado_cmd(ctx, config):
 @click.option("--delete", is_flag=True, help="Automatically delete and re-clone without prompting")
 @click.option("--pre", is_flag=True, help="Include pre-release versions when resolving versions")
 @click.option("--latest", is_flag=True, help="Use latest version for all dependencies")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def install_deps_cmd(ctx, delete, pre, latest, config):
     """Install GitHub dependencies from dependencies.toml."""
@@ -239,7 +239,7 @@ def install_deps_cmd(ctx, delete, pre, latest, config):
 
 @cli.command("create-modelsim", help="Create a ModelSim project for simulation")
 @click.option("--overwrite", "-o", is_flag=True, help="Overwrite existing ModelSim project")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def create_modelsim_cmd(ctx, overwrite, config):
     """Create a ModelSim project for HDL simulation."""
@@ -258,7 +258,7 @@ def create_modelsim_cmd(ctx, overwrite, config):
 
 @cli.command("launch-modelsim", help="Launch ModelSim with the current project")
 @click.option("--batch", is_flag=True, help="Run simulation in batch mode (no GUI)")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def launch_modelsim_cmd(ctx, batch, config):
     """Launch ModelSim with the current project."""
@@ -277,7 +277,7 @@ def launch_modelsim_cmd(ctx, batch, config):
 
 @cli.command("sim-modelsim", help="Run ModelSim simulation in batch mode")
 @click.option("--do-file", default=None, help="Custom .do file to run instead of default")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def sim_modelsim_cmd(ctx, do_file, config):
     """Run ModelSim simulation in batch mode and report results."""
@@ -295,7 +295,7 @@ def sim_modelsim_cmd(ctx, do_file, config):
 
 
 @cli.command("create-lvbitx", help="Create LabVIEW FPGA bitfile from Vivado output")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def create_lvbitx_cmd(ctx, config):
     """Create LabVIEW FPGA bitfile from Vivado output."""
@@ -312,15 +312,15 @@ def create_lvbitx_cmd(ctx, config):
 
 
 @cli.command("gen-guid", help="Generate a new GUID for LabVIEW FPGA target plugins")
-@click.option("--config", default=None, help="Path to nihdlcommandconfig.py")
+@click.option("--config", default=None, help="Path to nihdlsettings.py")
 @click.pass_context
 def gen_guid_cmd(ctx, config):
     """Generate a new GUID for LabVIEW FPGA target plugins."""
 
     def _gen_guid(**kwargs):
         guid = common.generate_guid()
         print("Generated GUID:", guid)
-        print("Copy and paste this GUID into LVTargetGUID in the projectsettings.ini file.")
+        print("Copy and paste this GUID into your nihdlsettings.py file.")
         return 0
 
     try:

labview_fpga_hdl_tools/__main__.py

@@ -116,7 +116,7 @@ def _run_check_syntax(config, generated_tcl_path):
     if not os.path.exists(vivado_abs):
         raise FileNotFoundError(
             f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your --vivado argument or VivadoToolsPath setting in projectsettings.ini"
+            f"Please check your --vivado argument or VivadoToolsPath setting in nihdlsettings.py"
         )
 
     vivado_project_path = os.path.join(os.getcwd(), "VivadoProject")
@@ -184,7 +184,7 @@ def check_syntax(config=None):
         int: 0 for success, 1 for error
     """
     if config is None:
-        config = common.load_config()
+        config = common.FileConfiguration()
 
     try:
         _validate_ini(config)

labview_fpga_hdl_tools/check_syntax.py

@@ -1,6 +1,6 @@
 """Command hook system for nihdl CLI.
 
-Loads a user-provided nihdlcommandconfig.py file that can define pre/post hooks
+Loads a user-provided nihdlsettings.py file that can define pre/post hooks
 for each CLI command, enabling customization and extension of the tool behavior.
 
 The hook execution order for each command is:
@@ -23,10 +23,13 @@ class CommandContext:
     """Shared context passed to all hook functions for a command invocation.
 
     Attributes:
-        config: FileConfiguration loaded from projectsettings.ini (set by pre_all).
+        config: FileConfiguration loaded from nihdlsettings.py (set by pre_all).
         command_name: Name of the command being executed (e.g. "create_project").
         command_kwargs: Dict of keyword arguments that will be passed to the command.
         result: Return value from the command function (available in post hooks).
+        invocation_dir: The working directory from which the nihdl command was
+            invoked. Useful in wrapper settings files that need to load another
+            nihdlsettings.py from the original target directory.
     """
 
     def __init__(self, command_name, command_kwargs):
@@ -35,10 +38,11 @@ def __init__(self, command_name, command_kwargs):
         self.command_name = command_name
         self.command_kwargs = dict(command_kwargs)
         self.result = None
+        self.invocation_dir = os.getcwd()
 
 
 def _load_config_module(command_config_path):
-    """Dynamically load a nihdlcommandconfig.py module.
+    """Dynamically load a nihdlsettings.py module.
 
     Args:
         command_config_path: Absolute path to the Python config file.
@@ -47,10 +51,10 @@ def _load_config_module(command_config_path):
         The loaded module object.
     """
     if not os.path.exists(command_config_path):
-        print(f"Error: Command config file not found: {command_config_path}", file=sys.stderr)
+        print(f"Error: Settings file not found: {command_config_path}", file=sys.stderr)
         sys.exit(1)
 
-    spec = importlib.util.spec_from_file_location("nihdlcommandconfig", command_config_path)
+    spec = importlib.util.spec_from_file_location("nihdlsettings", command_config_path)
     if spec is None or spec.loader is None:
         print(f"Error: Could not load module spec from: {command_config_path}", file=sys.stderr)
         sys.exit(1)
@@ -63,7 +67,7 @@ def _call_hook(module, hook_name, context):
     """Call a hook function on the module if it exists.
 
     Args:
-        module: The loaded nihdlcommandconfig module.
+        module: The loaded nihdlsettings module.
         hook_name: Name of the hook function (e.g. "pre_all", "post_create_project").
         context: CommandContext instance to pass to the hook.
     """
@@ -72,33 +76,80 @@ def _call_hook(module, hook_name, context):
         hook(context)
 
 
+def load_settings(settings_path, context):
+    """Load another nihdlsettings.py file and run its pre_all hook.
+
+    Use this from a wrapper nihdlsettings.py to compose settings — for example,
+    a pipeline config that loads each target's own nihdlsettings.py and then
+    overrides specific values::
+
+        from labview_fpga_hdl_tools.command_hooks import load_settings
+
+        def pre_all(context):
+            # Load the target's settings from the original invocation directory
+            target_settings = os.path.join(context.invocation_dir, "nihdlsettings.py")
+            load_settings(target_settings, context)
+            # Override Vivado path from environment
+            xilinx = os.environ.get("XILINX")
+            if xilinx:
+                context.config.set_vivado_tools_path(xilinx)
+
+    Relative paths are resolved from the loaded file's directory, matching the
+    normal nihdlsettings.py behavior.
+
+    Args:
+        settings_path: Path to the nihdlsettings.py file to load. Relative
+            paths are resolved from the current working directory.
+        context: The CommandContext whose config will be updated.
+    """
+    abs_path = os.path.abspath(settings_path)
+    module = _load_config_module(abs_path)
+    settings_dir = os.path.dirname(abs_path)
+    original_dir = os.getcwd()
+    os.chdir(settings_dir)
+    try:
+        _call_hook(module, "pre_all", context)
+    finally:
+        os.chdir(original_dir)
+
+
 def run_with_hooks(command_name, command_func, command_config_path=None, **command_kwargs):
-    """Execute a command wrapped with pre/post hooks from nihdlcommandconfig.py.
+    """Execute a command wrapped with pre/post hooks from nihdlsettings.py.
 
-    If no command_config_path is given, looks for nihdlcommandconfig.py in cwd.
+    If no command_config_path is given, looks for nihdlsettings.py in cwd.
+    Pre hooks run with the working directory set to the settings file's
+    directory so that relative paths in setter calls resolve correctly.
+    The command and post hooks run from the original working directory.
 
     Args:
         command_name: Underscore-separated command name (e.g. "create_project").
         command_func: The callable command function to execute.
-        command_config_path: Optional path to nihdlcommandconfig.py.
+        command_config_path: Optional path to nihdlsettings.py.
         **command_kwargs: Keyword arguments to pass to the command function.
 
     Returns:
         The return value of the command function.
     """
     # Resolve the config module path
     if command_config_path is None:
-        command_config_path = os.path.join(os.getcwd(), "nihdlcommandconfig.py")
+        command_config_path = os.path.join(os.getcwd(), "nihdlsettings.py")
 
     # Load the config module
     module = _load_config_module(command_config_path)
 
     # Build context
     context = CommandContext(command_name, command_kwargs)
 
-    # Pre hooks
-    _call_hook(module, "pre_all", context)
-    _call_hook(module, f"pre_{command_name}", context)
+    # Pre hooks run from the settings file's directory so relative paths
+    # passed to setters resolve correctly (same as the old INI chdir behavior).
+    config_dir = os.path.dirname(os.path.abspath(command_config_path))
+    original_dir = os.getcwd()
+    os.chdir(config_dir)
+    try:
+        _call_hook(module, "pre_all", context)
+        _call_hook(module, f"pre_{command_name}", context)
+    finally:
+        os.chdir(original_dir)
 
     # Inject pre-loaded config into command kwargs
     command_kwargs["config"] = context.config