PowerShell script for comparing user.js (or prefs.js) files.
Branch: master
Clone or download
Latest commit a8b5d8d Dec 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig update dotfiles Dec 8, 2018
.gitattributes update dotfiles Dec 8, 2018
.gitignore update dotfiles Dec 8, 2018
Compare-UserJS.bat fix error when calling ps1 with spaces in the path Dec 2, 2018
Compare-UserJS.ps1 Update Compare-UserJS.ps1 Dec 6, 2018
LICENSE Initial commit Jul 7, 2018
README.md Update README.md Dec 8, 2018
prefs_exporter.js add note about GeckoPrefsExporter Nov 7, 2018

README.md

Compare-UserJS


This script parses user.js files and compares them, logging the results to userJS_diff.log.

Information provided by this script:

  • matching prefs, both value and state.
  • prefs with different values but matching state.
  • prefs declared in file A but not in file B, and vice versa.
  • inactive in A but active in B, and vice versa.
  • duplicates in each of the two source files.

Additionally, it can catch one type of syntax error (for now), and includes that information in the report.

You can see an example of what the output looks like here.

🔹 Requirements

PowerShell version 2 (or newer) and .NET 3.5 (or newer), both of which come as standard components of Windows 7, but the script also runs fine on Unix-like systems. You can download the latest version of PowerShell and its dependencies from the official PowerShell repository.

🔹 Instructions

Compare-UserJS requires two parameters: the paths of the two files to be compared. You can pass them directly from the console/terminal, but that is not strictly necessary because the script will prompt you to enter them during execution if you don't.

If you're on *nix you can just skip to the examples.

On Windows you can:

  1. Download copies of both Compare-UserJS.bat and Compare-UserJS.ps1.
  2. Place them in the same folder.
  3. Drag and drop the two files that you want to compare on the Compare-UserJS.bat, simultaneously.

The Compare-UserJS.bat works as a launcher that makes it easier to run the PowerShell script. If you don't want to use said batchfile, you will first have to either:

...relax the execution policy:

# pick one or the other
Set-ExecutionPolicy RemoteSigned
Set-ExecutionPolicy Unrestricted

...or call the script like this:

PowerShell -ExecutionPolicy Bypass -File Compare-UserJS.ps1 <params>

🔝

🔹 Parameters

Index Name Required? Default Description
0 filePath_A Yes Path to the first file to compare. (1)
1 filePath_B Yes Path to the second file to compare.
2 ouputFile No userJS_diff.log Path to the file where the report will be dumped.
3 append No false Append the report to the end of the file if it already exists.
4 noCommentsA No false Parse JS comments in file A as code. (deprecated)
5 noCommentsB No false Parse JS comments in file B as code.
6 hideMask No 0 Bitmask value for hiding parts of the report selectively. (2)
7 inJS No false Get the report written in JavaScript. (3)

1 - All path parameters can be absolute or relative.
2 - See the embedded help info for details.
3 - It will be written to userJS_diff.js unless the -outputFile parameter is also specified.

🔝

🔹 Examples and tips

See the embedded help info:

Get-Help .\Compare-UserJS -full

Or just read it from the file, but that's less thrilling.

If you encounter any sort of issues with this script in a version of PowerShell higher than v2, try forcing the use of PSv2 like this:

PowerShell -Version 2 -File Compare-UserJS.ps1 <params>
# if you have PowerShell Core, use "pwsh" instead of "PowerShell", like this:
pwsh -Version 2 -File Compare-UserJS.ps1 <params>

Comparing fileA to fileB:

.\Compare-UserJS.ps1 "C:\absolute\path\to\fileA" "..\relative\path\to\fileB"

Comparing fileA.js to fileB.js, and saving the report to report.txt, appending to the end of the file:

.\Compare-UserJS.ps1 "fileA.js" "fileB.js" -outputFile "report.txt" -append

This tool can help you make manual cleanups of your prefs.js too!

.\Compare-UserJS.ps1 prefs.js user.js -hideMask 502 -inJS

Passing any parameters to the BAT is the same, except that you don't need the .\

Compare-UserJS.bat "fileA.js" "fileB.js" -outputFile diff.txt

🔝

🔹 Acknowledgments

Thanks to Thorin-Oakenpants and earthlng for their valuable feedback on the initial stages of this little project.

🔹 Glossary

  • State: Whether a pref was declared within the context of a JavaScript comment (inactive) or not (active).
  • user.js: Configuration file used by Firefox. You can find more information here and here. In the context of this project, this refers (to a limited extent) to all configuration files sharing the same syntax, including prefs.js and all.js. I recommend you to check out the ghacks user.js if you haven't already.