WixCop

WixCop is a WiX v3 command-line tool that serves two main purposes:

• To upgrade WiX authoring to the current schema
• To format WiX authoring according to a set of common formatting

WixCop's command-line syntax is:

WixCop.exe [options] sourceFile [sourceFile ...]

WixCop takes any number of WiX source files as command-line arguments. Wildcards are permitted. WixCop supports response files containing options and source files, using @responseFile syntax.

WixCop returns the following exit codes:

• 0, when no errors are reported.
• 1, when a fatal error occurs.
• 2, when WixCop violations occur.

The following table describes the switches that WixCop supports.

WixCop settings files

WixCop supports two settings files. Generally, the primary settings file is your “global” settings and the alternate settings file lets you override the global settings for a particular project.

Settings files are XML with the following structure:

<Settings>
  <IgnoreErrors>
    <Test Id="testId" />
  </IgnoreErrors> 
  <ErrorsAsWarnings>
    <Test Id="testId" />
  </ErrorsAsWarnings> 
  <ExemptFiles>
    <File Name="foo.wxs" />
  </ExemptFiles>
</Settings>

The IgnoreErrors element lists test IDs that should be ignored. The ErrorsAsWarnings element lists test IDs that should be demoted from errors to warnings. The ExemptFiles element lists files that should be skipped.

The following table describes the tests that WixCop supports.