Use js-beautify via git config to generate readable min.js diffs

bestpractical · Feb 14, 2025 · e5c361b · e5c361b
1 parent 60e15d9
commit e5c361b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,4 @@
 .gitignore export-ignore 
 .gitattributes export-ignore 
 devel/third-party/ export-ignore
+*.min.js diff=minjs
diff --git a/docs/hacking.pod b/docs/hacking.pod
@@ -48,6 +48,16 @@ to, and does not introduce any unwanted behavior in doing so.  Commit
 messages explain the B<why> as much as the B<what> of each commit, and
 not include extraneous changes.
 
+=head2 Git Config Files
+
+The RT repo has a C<.gitattributes> file with a line that looks for a diff
+configuration for minified javascript. To help git generate readable
+diffs, you can use a confguration like this after installing the
+C<js-beautify> utility.
+
+[diff "minjs"]
+    textconv = js-beautify
+    cachetextconv = true
 
 =head1 Code conventions