consync 2.2.0__tar.gz → 2.2.2__tar.gz

{consync-2.2.0 → consync-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: consync
-Version: 2.2.0
+Version: 2.2.2
 Summary: Bidirectional sync between spreadsheets and source code constants — with full decimal precision.
 Project-URL: Homepage, https://github.com/naveenkumarbaskaran/consync
 Project-URL: Repository, https://github.com/naveenkumarbaskaran/consync
@@ -153,6 +153,12 @@ mappings:
     direction: both
     precision: 17
     header_guard: HW_CONSTANTS_H
+
+  # Or for C struct tables → Excel:
+  # - source: MotorParams.c
+  #   target: MotorParams.xlsx
+  #   direction: both
+  #   format: c_struct_table
 ```
 
 ### 2. Sync
@@ -229,7 +235,36 @@ consync install-hook
 
 **Don't have a spreadsheet yet?** consync can create one from your existing source files.
 
-If you already have a C header with constants and want to start tracking it:
+### C Struct Table → Excel (multi-variant motor parameters)
+
+Have a complex C file with `#if`/`#elif` struct arrays and want an Excel for your team to review/edit?
+
+```yaml
+# .consync.yaml
+mappings:
+  - source: RBPSC_HWVariantParameter.c    # Existing C file with struct arrays
+    target: RBPSC_HWVariantParameter.xlsx  # Excel will be created on first sync
+    direction: both                        # Edit C or Excel — both stay in sync
+    format: c_struct_table                 # Parses #if/#elif multi-variant tables
+    precision: 17
+```
+
+```bash
+consync sync
+# ✅ RBPSC_HWVariantParameter.c ↔ RBPSC_HWVariantParameter.xlsx: 160 constants synced (source → target)
+```
+
+consync parses the C file — handling nested `{{...}}` initializers, `#if`/`#elif` variant blocks, float suffixes (`1.0F`), hex (`0xFF`), expressions — and generates a multi-sheet Excel with one sheet per variant (BWA, EMB, DPB, etc.).
+
+After that, edit either side:
+- **Edit Excel** → values sync back into the C file (in-place, minimal diffs)
+- **Edit C file** → Excel updates on next `consync sync`
+
+> **Note:** The `format: c_struct_table` field tells consync to use the struct-table parser for the `.c` file instead of the default `c_header` parser. The `.xlsx` target format is auto-detected.
+
+### C Header → CSV/JSON (simple constants)
+
+If you have a simpler C header with `const`/`#define` declarations:
 
 ```yaml
 # .consync.yaml
@@ -246,7 +281,7 @@ consync sync
 
 consync parses the existing `.h` file, extracts all constants (name, value, unit, description from comments), and writes a fresh CSV. From that point forward, you have a spreadsheet to share with your EE team.
 
-**Works with any parseable target:** `.h`, `.json`, `.csv`, `.toml` — anything consync has a parser for can bootstrap a new source.
+**Works with any parseable format:** `.h`, `.c`, `.json`, `.csv`, `.toml` — anything consync has a parser for can bootstrap a new source.
 
 ---
 
@@ -411,17 +446,30 @@ consync tracks file hashes in `.consync.state.json` to detect which side changed
 ```yaml
 # .consync.yaml
 mappings:
-  - source: constants.xlsx        # source file path (xlsx/csv/json/toml/h)
-    target: hw_constants.h        # target file path (h/cs/py/rs/v/vhd/json/csv)
+  - source: constants.xlsx        # source file path (xlsx/csv/json/toml/h/c)
+    target: hw_constants.h        # target file path (h/cs/py/rs/v/vhd/json/csv/xlsx)
     direction: both               # source_to_target | target_to_source | both
     precision: 17                 # significant digits (1-17, default: 17)
 
+    # ─── Format override ───
+    # format: c_struct_table      # Override auto-detected format for the matching side.
+    #                             # Useful when .c needs c_struct_table instead of c_header.
+    #                             # Auto-assigned to whichever side's extension matches.
+    # source_format: xlsx         # Explicit source format (overrides auto-detect)
+    # target_format: c_header     # Explicit target format (overrides auto-detect)
+
     # ─── C Header options ───
     header_guard: HW_CONSTANTS_H  # #ifndef guard name
     output_style: const           # const (default) | define
     static_const: true            # adds 'static' keyword (default: false)
     typed_ints: true              # use stdint.h types (default: false)
 
+    # ─── C Struct Table options ───
+    # parser_options:
+    #   variant: DPB              # Select specific #elif variant (or "all")
+    #   table_var: PSC_HWVarParLUT  # Struct array variable name (auto-detected)
+    #   fields: [R_Phase, L_d, L_q, Psi, J, Imax, Tmax]  # Field names (auto-detected)
+
     # ─── C# options ───
     namespace: MyCompany.Firmware # C# namespace
     class_name: EcuConstants      # C# class name (default: Constants)

{consync-2.2.0 → consync-2.2.2}/README.md

@@ -118,6 +118,12 @@ mappings:
     direction: both
     precision: 17
     header_guard: HW_CONSTANTS_H
+
+  # Or for C struct tables → Excel:
+  # - source: MotorParams.c
+  #   target: MotorParams.xlsx
+  #   direction: both
+  #   format: c_struct_table
 ```
 
 ### 2. Sync
@@ -194,7 +200,36 @@ consync install-hook
 
 **Don't have a spreadsheet yet?** consync can create one from your existing source files.
 
-If you already have a C header with constants and want to start tracking it:
+### C Struct Table → Excel (multi-variant motor parameters)
+
+Have a complex C file with `#if`/`#elif` struct arrays and want an Excel for your team to review/edit?
+
+```yaml
+# .consync.yaml
+mappings:
+  - source: RBPSC_HWVariantParameter.c    # Existing C file with struct arrays
+    target: RBPSC_HWVariantParameter.xlsx  # Excel will be created on first sync
+    direction: both                        # Edit C or Excel — both stay in sync
+    format: c_struct_table                 # Parses #if/#elif multi-variant tables
+    precision: 17
+```
+
+```bash
+consync sync
+# ✅ RBPSC_HWVariantParameter.c ↔ RBPSC_HWVariantParameter.xlsx: 160 constants synced (source → target)
+```
+
+consync parses the C file — handling nested `{{...}}` initializers, `#if`/`#elif` variant blocks, float suffixes (`1.0F`), hex (`0xFF`), expressions — and generates a multi-sheet Excel with one sheet per variant (BWA, EMB, DPB, etc.).
+
+After that, edit either side:
+- **Edit Excel** → values sync back into the C file (in-place, minimal diffs)
+- **Edit C file** → Excel updates on next `consync sync`
+
+> **Note:** The `format: c_struct_table` field tells consync to use the struct-table parser for the `.c` file instead of the default `c_header` parser. The `.xlsx` target format is auto-detected.
+
+### C Header → CSV/JSON (simple constants)
+
+If you have a simpler C header with `const`/`#define` declarations:
 
 ```yaml
 # .consync.yaml
@@ -211,7 +246,7 @@ consync sync
 
 consync parses the existing `.h` file, extracts all constants (name, value, unit, description from comments), and writes a fresh CSV. From that point forward, you have a spreadsheet to share with your EE team.
 
-**Works with any parseable target:** `.h`, `.json`, `.csv`, `.toml` — anything consync has a parser for can bootstrap a new source.
+**Works with any parseable format:** `.h`, `.c`, `.json`, `.csv`, `.toml` — anything consync has a parser for can bootstrap a new source.
 
 ---
 
@@ -376,17 +411,30 @@ consync tracks file hashes in `.consync.state.json` to detect which side changed
 ```yaml
 # .consync.yaml
 mappings:
-  - source: constants.xlsx        # source file path (xlsx/csv/json/toml/h)
-    target: hw_constants.h        # target file path (h/cs/py/rs/v/vhd/json/csv)
+  - source: constants.xlsx        # source file path (xlsx/csv/json/toml/h/c)
+    target: hw_constants.h        # target file path (h/cs/py/rs/v/vhd/json/csv/xlsx)
     direction: both               # source_to_target | target_to_source | both
     precision: 17                 # significant digits (1-17, default: 17)
 
+    # ─── Format override ───
+    # format: c_struct_table      # Override auto-detected format for the matching side.
+    #                             # Useful when .c needs c_struct_table instead of c_header.
+    #                             # Auto-assigned to whichever side's extension matches.
+    # source_format: xlsx         # Explicit source format (overrides auto-detect)
+    # target_format: c_header     # Explicit target format (overrides auto-detect)
+
     # ─── C Header options ───
     header_guard: HW_CONSTANTS_H  # #ifndef guard name
     output_style: const           # const (default) | define
     static_const: true            # adds 'static' keyword (default: false)
     typed_ints: true              # use stdint.h types (default: false)
 
+    # ─── C Struct Table options ───
+    # parser_options:
+    #   variant: DPB              # Select specific #elif variant (or "all")
+    #   table_var: PSC_HWVarParLUT  # Struct array variable name (auto-detected)
+    #   fields: [R_Phase, L_d, L_q, Psi, J, Imax, Tmax]  # Field names (auto-detected)
+
     # ─── C# options ───
     namespace: MyCompany.Firmware # C# namespace
     class_name: EcuConstants      # C# class name (default: Constants)

{consync-2.2.0 → consync-2.2.2}/consync/cli.py

@@ -46,7 +46,7 @@ def init(path: str):
         click.echo(f"⚠️  {target} already exists. Delete it first to regenerate.")
         sys.exit(1)
 
-    target.write_text(generate_default_config())
+    target.write_text(generate_default_config(), encoding="utf-8")
     click.echo(f"✅ Created {target}")
     click.echo("   Edit it to configure your source ↔ target mappings.")
     click.echo("   Then run: consync sync")
@@ -329,13 +329,13 @@ def diff_cmd(config_path: str | None, from_side: str | None, color: bool):
 
         try:
             _render_file(constants, tmp_path, mapping.target_format if direction == "source" else mapping.source_format, mapping)
-            new_content = tmp_path.read_text().splitlines(keepends=True)
+            new_content = tmp_path.read_text(encoding="utf-8").splitlines(keepends=True)
         finally:
             tmp_path.unlink(missing_ok=True)
 
         # Get current content
         if dest_path.exists():
-            old_content = dest_path.read_text().splitlines(keepends=True)
+            old_content = dest_path.read_text(encoding="utf-8").splitlines(keepends=True)
         else:
             old_content = []
 

{consync-2.2.0 → consync-2.2.2}/consync/config.py

@@ -209,23 +209,31 @@ def generate_default_config() -> str:
 # Sync constants between spreadsheets and source code with full decimal precision.
 
 mappings:
+  # ─── Pattern 1: Spreadsheet → Code ───
+  # Excel is the source of truth, code is generated from it.
   - source: constants.xlsx          # Where constants are defined (spreadsheet)
     target: include/constants.h     # Generated code file
     direction: both                 # source_to_target | target_to_source | both
     precision: 17                   # Significant digits (17 = full IEEE 754 double)
     header_guard: HW_CONSTANTS_H   # C header include guard
 
+  # ─── Pattern 2: C struct table → Excel ───
+  # Existing C file with struct arrays — generate Excel for review/editing.
+  # - source: MotorParams.c           # Existing C file with struct array
+  #   target: MotorParams.xlsx        # Excel generated from C (created if missing)
+  #   direction: both                 # Edit either side, sync keeps them matched
+  #   format: c_struct_table          # Parser for #if/#elif struct arrays
+  #   precision: 17
+
+  # ─── Pattern 3: Code → Spreadsheet (bootstrap) ───
+  # - source: params.csv              # Will be created from your existing code
+  #   target: legacy/params.h         # Already exists
+  #   direction: target_to_source     # First sync creates the CSV from the .h
+
     # Optional:
     # prefix: ""                    # Prefix all constant names (e.g., "HW_")
     # uppercase_names: true         # Force UPPER_CASE names in output
 
-  # Add more mappings as needed:
-  # - source: parameters.xlsx
-  #   target: src/params.v
-  #   direction: source_to_target
-  #   precision: 12
-  #   module_name: design_params
-
 # Global settings:
 # state_file: .consync.state.json   # Track sync state (gitignore this)
 # watch_debounce: 2.0               # Seconds to wait before re-syncing

{consync-2.2.0 → consync-2.2.2}/consync/hooks.py

@@ -49,7 +49,7 @@ def install_git_hook(hook_type: str = "pre-commit"):
 
     # Check for existing hook
     if hook_file.exists():
-        existing = hook_file.read_text()
+        existing = hook_file.read_text(encoding="utf-8")
         if "consync" in existing:
             click.echo(f"✔️  consync hook already installed in .git/hooks/{hook_type}")
             return
@@ -61,7 +61,7 @@ def install_git_hook(hook_type: str = "pre-commit"):
             f.write(HOOK_TEMPLATE.format(hook_type=hook_type, git_cmd=git_cmd))
     else:
         # Create new hook
-        hook_file.write_text(HOOK_TEMPLATE.format(hook_type=hook_type, git_cmd=git_cmd))
+        hook_file.write_text(HOOK_TEMPLATE.format(hook_type=hook_type, git_cmd=git_cmd), encoding="utf-8")
 
     hook_file.chmod(0o755)
     click.echo(f"✅ Installed consync check in .git/hooks/{hook_type}")

{consync-2.2.0 → consync-2.2.2}/consync/lock.py

@@ -66,7 +66,7 @@ class SyncLock:
             "created": datetime.now(timezone.utc).isoformat(timespec="seconds"),
             "hostname": platform.node(),
         }
-        self.lock_path.write_text(json.dumps(lock_info, indent=2))
+        self.lock_path.write_text(json.dumps(lock_info, indent=2), encoding="utf-8")
         self._acquired = True
         logger.debug("Lock acquired: %s", self.lock_path)
 
@@ -80,7 +80,7 @@ class SyncLock:
     def _read_lock(self) -> dict | None:
         """Read lock file contents."""
         try:
-            return json.loads(self.lock_path.read_text())
+            return json.loads(self.lock_path.read_text(encoding="utf-8"))
         except (json.JSONDecodeError, OSError):
             return None
 

{consync-2.2.0 → consync-2.2.2}/consync/state.py

@@ -43,14 +43,14 @@ class SyncState:
     def _load(self):
         if self.state_file.exists():
             try:
-                self._data = json.loads(self.state_file.read_text())
+                self._data = json.loads(self.state_file.read_text(encoding="utf-8"))
             except (json.JSONDecodeError, OSError):
                 self._data = {}
         else:
             self._data = {}
 
     def _save(self):
-        self.state_file.write_text(json.dumps(self._data, indent=2) + "\n")
+        self.state_file.write_text(json.dumps(self._data, indent=2) + "\n", encoding="utf-8")
 
     def get_hash(self, mapping_key: str, side: str) -> str | None:
         """Get the stored hash for a mapping side ('source' or 'target')."""

{consync-2.2.0 → consync-2.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "consync"
-version = "2.2.0"
+version = "2.2.2"
 description = "Bidirectional sync between spreadsheets and source code constants — with full decimal precision."
 readme = "README.md"
 license = {text = "MIT"}