overspend1/PathOfBuilding
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "stat order diff stripping"

Browse Source 
This reverts commit c73eeb5798.
This commit is contained in:
LocalIdentity
2025-11-14 18:42:53 +11:00
parent c73eeb5798
commit 0561312c7e
3 changed files with 1 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.gitattributes vendored
View File

@@ -66,17 +66,4 @@
# Executable files - preserve execution permissions on Unix systems
# (https://git-scm.com/docs/gitattributes#_executable)
###############################################################################
runtime/*.exe binary
###############################################################################
# Hide statOrder churn inside specific exported data files when diffing
###############################################################################
src/Data/Mod*.lua diff=nostatorder
src/Data/Crucible.lua diff=nostatorder
src/Data/Uniques/Special/*.lua diff=nostatorder
src/Data/ClusterJewels.lua diff=nostatorder
src/Data/TattooPassives.lua diff=nostatorder
src/Data/TimelessJewelData/LegionPassives.lua diff=nostatorder
src/Data/StatDescriptions/*.lua diff=nostatorder
src/Data/BeastCraft.lua diff=nostatorder
src/Data/StatDescriptions/*/*.lua diff=nostatorder
runtime/*.exe binary

12
CONTRIBUTING.md
View File

@@ -53,18 +53,6 @@ Feature requests are always welcome. Note that not all requests will receive an
`-- This file is automatically generated, do not edit!`. To change these, instead change the scripts in the `./src/Export` directory and rerun the exporter.
For your PR, please include all relevant changes to both the scripts and data files.
### Keeping mod diffs readable (Fork, CLI, etc.)
The exporter stores `statOrder` values in every generated mod entry so we can reference them at runtime, but those numbers churn between game updates and make diffs noisy.
Hook Git’s textconv into the repo after cloning so any diff-capable client that respects `.gitattributes` (the CLI, Fork, Sourcetree, etc.) hides that churn automatically:
```
git config diff.nostatorder.textconv "python tools/strip_statorder_for_diff.py"
git config diff.nostatorder.cachetextconv true
```
Git now runs the helper in `tools/strip_statorder_for_diff.py` whenever you diff the noisy exporter outputs (`src/Data/Mod*.lua`, `src/Data/Crucible.lua`, `src/Data/Uniques/Special/*.lua`, `src/Data/TattooPassives.lua`, `src/Data/TimelessJewelData/LegionPassives.lua`, `src/Data/ClusterJewels.lua`), replacing every `statOrder` payload with a stable placeholder before diffing.
Fork.dev, Sourcetree and other GUIs that honor textconv immediately pick up the cleaner diff without extra per-file ignore settings.
## Setting up a development installation
Note: This tutorial assumes that you are already familiar with Git.

61
tools/strip_statorder_for_diff.py
View File

@@ -1,61 +0,0 @@
#!/usr/bin/env python3
"""Text conversion helper that hides statOrder churn in diffs."""
from __future__ import annotations
import io
import re
import sys
from pathlib import Path
from typing import Final
_RE_TABLE: Final = re.compile(r"(statOrder\s*=\s*\{)([^}]*)(\})", re.MULTILINE)
_RE_SCALAR: Final = re.compile(r"(statOrder\s*=\s*)(?!\{)([^,\s}]+)", re.MULTILINE)
_RE_BRACKET_KEY: Final = re.compile(r'(\["statOrder"\]\s*=\s*)([^,\s}]+)', re.MULTILINE)
_RE_NOTABLE_ENTRY: Final = re.compile(r'(\["[^"]+"\]\s*=\s*)(\d+)', re.MULTILINE)
_RE_STATDESC_BLOCK: Final = re.compile(r"(?m)(^\t)\[(\d+)\](\s*=\s*\{)")
_RE_STATDESC_TAIL: Final = re.compile(r'(\["[^"]+"\]\s*=\s*)(\d+)(,?)$', re.MULTILINE)
_STATDESC_SUFFIX = "_stat_descriptions.lua"
_PLACEHOLDER: Final = "0"
def _replace_scalar(match: re.Match[str]) -> str:
return f"{match.group(1)}{_PLACEHOLDER}"
def _replace_table(match: re.Match[str]) -> str:
return f"{match.group(1)} {_PLACEHOLDER} {match.group(3)}"
def _normalize(contents: str, file_hint: str | None) -> str:
contents = _RE_TABLE.sub(_replace_table, contents)
contents = _RE_SCALAR.sub(_replace_scalar, contents)
contents = _RE_BRACKET_KEY.sub(_replace_scalar, contents)
file_name = Path(file_hint).name if file_hint else ""
if file_name == "ClusterJewels.lua" or "NotableSortOrder" in contents:
contents = _RE_NOTABLE_ENTRY.sub(_replace_scalar, contents)
if file_hint and "LegionPassives.lua" in file_hint:
contents = re.sub(r'(\["oidx"\]\s*=\s*)(\d+)', _replace_scalar, contents)
if file_name == "stat_descriptions.lua" or file_name.endswith(_STATDESC_SUFFIX):
contents = _RE_STATDESC_BLOCK.sub(lambda m: f"{m.group(1)}[0]{m.group(3)}", contents)
contents = _RE_STATDESC_TAIL.sub(lambda m: f'{m.group(1)}{_PLACEHOLDER}{m.group(3)}', contents)
return contents
def _read_source(path: str | None) -> str:
if path:
with io.open(path, "r", encoding="utf-8", errors="ignore") as handle:
return handle.read()
return sys.stdin.read()
def main() -> None:
path = sys.argv[1] if len(sys.argv) > 1 else None
sys.stdout.write(_normalize(_read_source(path), path))
if __name__ == "__main__":
main()