consync 2.1.0__tar.gz → 2.2.1__tar.gz

{consync-2.1.0 → consync-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: consync
-Version: 2.1.0
+Version: 2.2.1
 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
@@ -70,10 +70,11 @@ Keep a single source of truth for hardware constants (resistor values, timing pa
      │    Parsers      │  │   State     │  │   Renderers    │
      │                 │  │  Tracker    │  │                │
      │ • xlsx          │  │             │  │ • c_header     │
-     │ • csv           │  │ MD5 hashes  │  │ • csharp       │
-     │ • json          │  │ per-mapping │  │ • python       │
-     │ • toml          │  │ in .json    │  │ • rust         │
-     │ • c_header      │  │             │  │ • verilog      │
+     │ • csv           │  │ MD5 hashes  │  │ • c_struct_table│
+     │ • json          │  │ per-mapping │  │ • csharp       │
+     │ • toml          │  │ in .json    │  │ • python       │
+     │ • c_header      │  │             │  │ • rust         │
+     │ • c_struct_table │  │             │  │ • verilog      │
      └────────┬────────┘  └──────┬──────┘  │ • vhdl         │
               │                  │          │ • json          │
               │                  │          │ • csv           │
@@ -152,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
@@ -200,17 +207,19 @@ consync install-hook
 
 | Format | Extension | Notes |
 |--------|-----------|-------|
-| Excel | `.xlsx` | Auto-detects column headers |
+| Excel | `.xlsx` | Auto-detects flat or table layout (multi-variant) |
 | CSV | `.csv`, `.tsv` | Auto-detects delimiter |
-| JSON | `.json` | Flat, array, or nested |
+| JSON | `.json` | Flat, array, nested, or structured (`_meta` + `constants`) |
 | TOML | `.toml` | Flat or table-with-metadata |
 | C Header | `.h` | Parses `const`, `#define`, hex/int/float |
+| C Struct Table | `.c` | Multi-variant `#if`/`#elif` struct arrays (Bosch-style) |
 
 ### Targets (output)
 
 | Format | Extension | Features |
 |--------|-----------|----------|
 | C Header | `.h` | `const` or `#define`, `static`, `stdint.h` types, hex |
+| C Struct Table | `.c` | In-place update of multi-variant struct arrays (minimal diffs) |
 | C# | `.cs` | `namespace`, `public static class`, XML doc comments |
 | Python | `.py` | Type annotations (`float`/`int`), inline comments |
 | Rust | `.rs` | `pub const`, `f64`/`i64`, doc comments |
@@ -218,6 +227,7 @@ consync install-hook
 | VHDL | `.vhd` | Package with `ieee.math_real`, typed constants |
 | JSON | `.json` | Structured with `_meta` header |
 | CSV | `.csv` | Round-trip back to spreadsheet |
+| Excel | `.xlsx` | Multi-sheet table layout (one sheet per variant) |
 
 ---
 
@@ -225,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
@@ -242,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.
 
 ---
 
@@ -407,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)
@@ -581,7 +633,7 @@ Each entry records: timestamp, user, direction, files, all constant names+values
 git clone https://github.com/naveenkumarbaskaran/consync.git
 cd consync
 pip install -e ".[dev]"
-pytest   # 151 tests
+pytest   # 261 tests
 ```
 
 ---

{consync-2.1.0 → consync-2.2.1}/README.md

@@ -35,10 +35,11 @@ Keep a single source of truth for hardware constants (resistor values, timing pa
      │    Parsers      │  │   State     │  │   Renderers    │
      │                 │  │  Tracker    │  │                │
      │ • xlsx          │  │             │  │ • c_header     │
-     │ • csv           │  │ MD5 hashes  │  │ • csharp       │
-     │ • json          │  │ per-mapping │  │ • python       │
-     │ • toml          │  │ in .json    │  │ • rust         │
-     │ • c_header      │  │             │  │ • verilog      │
+     │ • csv           │  │ MD5 hashes  │  │ • c_struct_table│
+     │ • json          │  │ per-mapping │  │ • csharp       │
+     │ • toml          │  │ in .json    │  │ • python       │
+     │ • c_header      │  │             │  │ • rust         │
+     │ • c_struct_table │  │             │  │ • verilog      │
      └────────┬────────┘  └──────┬──────┘  │ • vhdl         │
               │                  │          │ • json          │
               │                  │          │ • csv           │
@@ -117,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
@@ -165,17 +172,19 @@ consync install-hook
 
 | Format | Extension | Notes |
 |--------|-----------|-------|
-| Excel | `.xlsx` | Auto-detects column headers |
+| Excel | `.xlsx` | Auto-detects flat or table layout (multi-variant) |
 | CSV | `.csv`, `.tsv` | Auto-detects delimiter |
-| JSON | `.json` | Flat, array, or nested |
+| JSON | `.json` | Flat, array, nested, or structured (`_meta` + `constants`) |
 | TOML | `.toml` | Flat or table-with-metadata |
 | C Header | `.h` | Parses `const`, `#define`, hex/int/float |
+| C Struct Table | `.c` | Multi-variant `#if`/`#elif` struct arrays (Bosch-style) |
 
 ### Targets (output)
 
 | Format | Extension | Features |
 |--------|-----------|----------|
 | C Header | `.h` | `const` or `#define`, `static`, `stdint.h` types, hex |
+| C Struct Table | `.c` | In-place update of multi-variant struct arrays (minimal diffs) |
 | C# | `.cs` | `namespace`, `public static class`, XML doc comments |
 | Python | `.py` | Type annotations (`float`/`int`), inline comments |
 | Rust | `.rs` | `pub const`, `f64`/`i64`, doc comments |
@@ -183,6 +192,7 @@ consync install-hook
 | VHDL | `.vhd` | Package with `ieee.math_real`, typed constants |
 | JSON | `.json` | Structured with `_meta` header |
 | CSV | `.csv` | Round-trip back to spreadsheet |
+| Excel | `.xlsx` | Multi-sheet table layout (one sheet per variant) |
 
 ---
 
@@ -190,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
@@ -207,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.
 
 ---
 
@@ -372,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)
@@ -546,7 +598,7 @@ Each entry records: timestamp, user, direction, files, all constant names+values
 git clone https://github.com/naveenkumarbaskaran/consync.git
 cd consync
 pip install -e ".[dev]"
-pytest   # 151 tests
+pytest   # 261 tests
 ```
 
 ---

{consync-2.1.0 → consync-2.2.1}/consync/config.py

@@ -80,6 +80,26 @@ def _parse_direction(raw: str) -> SyncDirection:
     return mapping[normalized]
 
 
+def _format_matches_extension(format_name: str, filepath: str) -> bool:
+    """Check if a format name is compatible with a file's extension."""
+    ext = Path(filepath).suffix.lower()
+    # Map format names to compatible extensions
+    FORMAT_COMPATIBLE_EXTENSIONS: dict[str, set[str]] = {
+        "c_header": {".c", ".h", ".hpp", ".hh"},
+        "c_struct_table": {".c", ".h", ".hpp", ".hh"},
+        "xlsx": {".xlsx", ".xls"},
+        "csv": {".csv"},
+        "json": {".json"},
+        "verilog": {".v", ".sv"},
+        "vhdl": {".vhd", ".vhdl"},
+        "python": {".py"},
+        "rust": {".rs"},
+        "csharp": {".cs"},
+    }
+    compatible = FORMAT_COMPATIBLE_EXTENSIONS.get(format_name, set())
+    return ext in compatible
+
+
 def _parse_mapping(raw: dict[str, Any], config_dir: Path) -> MappingConfig:
     """Parse a single mapping entry from YAML."""
     source = raw.get("source", "")
@@ -90,8 +110,19 @@ def _parse_mapping(raw: dict[str, Any], config_dir: Path) -> MappingConfig:
     if not target:
         raise ValueError("Each mapping must have a 'target' field.")
 
+    generic_format = raw.get("format", "")
     source_format = raw.get("source_format", "") or raw.get("format_source", "")
-    target_format = raw.get("target_format", "") or raw.get("format_target", "") or raw.get("format", "")
+    target_format = raw.get("target_format", "") or raw.get("format_target", "")
+
+    # If generic 'format' is specified, assign it to the side whose extension matches
+    if generic_format:
+        if not source_format and _format_matches_extension(generic_format, source):
+            source_format = generic_format
+        elif not target_format and _format_matches_extension(generic_format, target):
+            target_format = generic_format
+        elif not target_format:
+            # Legacy fallback: assign to target_format (backward compat)
+            target_format = generic_format
 
     # Auto-detect formats if not specified
     if not source_format:
@@ -178,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.1.0 → consync-2.2.1}/pyproject.toml

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