Commands

Last updated: Nov 16th, 2017

Introduction

This page lists the various commands that you can use while working with OverrideAudit. These commands are integrated into Sublime Text in a variety of ways to better suit the different work styles that people have.

Although some commands (such as creating a Package Report) are always available, many commands are only present when the current situation warrants them, so that OverrideAudit can stay out of your way.

The list below specifies in what situations and locations each command is presented, along with a description of what the command actually does.

Commands

Package Report

Command Palette
OverrideAudit: Package Report
Menu
Tools > OverrideAudit > Package Report

This will display a list of all packages currently installed in Sublime Text, in a table format. The table lists the packages in roughly the order that they will be loaded by Sublime at startup (top to bottom and left to right).

For each package, an indication is made as to whether this package is [S]hipped, [I]nstalled or [U]npacked (see the terminology page for more information).

Additionally, a package that is currently disabled is displayed in [Square Brackets] while a package that represents a dependency for an installed package is displayed in <Angle Brackets>.

Each package name supports a context menu item which allows you to open a bulk diff report for that package, allowing you to quickly get an overview of the status of any overrides on that package. See the OverrideAudit: Bulk Diff Single Package command for more information.

Override Report

Command Palette
OverrideAudit: Override Report
Menu
Tools > OverrideAudit > Override Report

This will display a list of all packages for which there are overrides of any type, simple or complete, with an indication on any package or override file that is currently expired (see the terminology page for more information on these terms).

For each package displayed, a condensed version of the indicators from the Package Report are displayed, indicating whether the package in question is [S]hipped, [I]nstalled or [U]npacked.

A package which is a complete override is indicated by text to this effect appearing next to it in the output line. If such a package is expired, an additional note to this effect is added to let you know.

All simple overrides for a package are displayed below the package name in the report, and may be prefixed with an [X] mark if they are currently expired.

As with the Package Report, a context menu item is presented on package names to allow a quick bulk diff of overrides in that package. Additionally, override filenames include context commands to allow you to quickly edit, diff or delete that override.

Override Report (Only Expired)

Command Palette
OverrideAudit: Override Report (Only Expired)
Menu
Tools > OverrideAudit > Override Report (Only Expired)

This command operates the same as the standard Override Report command, but constrains its output to only packages which have some form of expired override (either simple or complete).

This allows you to focus solely on those overrides which may require your more immediate attention.

Bulk Diff Report (All Packages)

Command Palette
OverrideAudit: Bulk Diff All Packages
Menu
Tools > OverrideAudit > Bulk Diff: All Packages

This will generate a diff for every simple override that exists for all packages into a single output report, allowing for a quick overview of all overrides at once.

As for the Override Report command, each package listed has a condensed version of the indicators from the Package Report indicating whether the package in question is [S]hipped, [I]nstalled or [U]npacked as well as an indication if the package is a complete override or not. Additionally, expired complete and simple overrides are also indicated in the bulk diff report.

Each section of the report is progressively indented so that it is possible to use Sublime code folding to hide away parts of the report as you work.

As in the Override Report, the name of each package and the filenames of each override support context menus that allows you to quickly bulk diff, open or diff them in their own distinct view.

Bulk Diff Report (Single Package) Contextual

Command Palette
OverrideAudit: Bulk Diff Single Package
Menu
Tools > OverrideAudit > Bulk Diff: Single Package...
Context Menu
OverrideAudit: Bulk Diff Package (on a package name in a report)

This command operates identically to the Bulk Diff All Packages command, with the exception that instead of calculating a diff for all overrides in all packages you are instead prompted via a quick panel for a single package to diff instead.

You can also access a bulk diff of a single package via a context menu on the name of a package in a Package Report, Override Report or Bulk Diff Report.

In these cases the command is directly applied to the package named without prompting you first.

Refresh Report Contextual

Command Palette
OverrideAudit: Refresh Report
Menu
Tools > OverrideAudit > Refresh Current Report
Context Menu
OverrideAudit: Refresh Report (anywhere in a report view)
Keyboard
F5 (All Platforms)

This command is available from within all OverrideAudit report views (Package Report, Override Report, or Bulk Diff Report) via the Command Palette, context menu or main menu, and allows you to quickly re-run the same report.

When a report is refreshed, OverrideAudit ignores the current values of the reuse_views and clear_existing options and operates as if they are both set to true so that the existing report will be replaced.

This command is also available as a context menu entry from within a report view or its associated editor tab and via the F5 key, although you can change this binding to a key of your liking.

Diff Single Override Contextual

Command Palette
OverrideAudit: Diff Single Override
Menu
Tools > OverrideAudit > Diff Single Override...
Context Menu
OverrideAudit: Diff Override (on an override name in a report, in an override view)

This will display a quick panel that lists all packages with at least one simple override, and allows you to compare the differences between the base file and your override to see what is different between the two.

When the content of the file is different, the output is displayed in a Unified Diff format in a new buffer, allowing you to inspect the changes.

As a shortcut, you can directly diff an override file from the context menu on any Override Report, Bulk Diff Report or directly in an override while you're editing it. In these cases the command is directly applied to the override file without prompting you first.

The option diff_unchanged allows you to specify the result of performing a diff when the override is identical to the underlying file.

Swap Diff/Edit View Contextual

Command Palette
OverrideAudit: Swap Diff/Edit View
Context Menu
OverrideAudit: Diff Override (while editing an override, on an override name in a report)
OverrideAudit: Edit Override (while viewing an override diff, on an override name in a report)
Keyboard
Alt+O (Windows/Linux)
⌘+Alt+Up (MacOS)

This command is only available while the current file is either an edit session for an override or a diff of an override or in the context menu on an override name in a report.

Although this command does not appear in the top level Tools > OverrideAudit menu, it does appear within command palette and in the context menu of an appropriate file view, as well as on the context menu of an override file from within an Override Report or Bulk Diff Report.

In the command palette the command is named as Swap Diff/Edit View, while in context menus it appears with a name that tells you which of the two options it's going to take.

Additionally, OverrideAudit contains a key binding to the standard Sublime key for swapping between associated files (Alt+O on Windows/Linux or ⌘+Alt+Up on MacOS) that operates from within an appropriate file view.

Regardless of how you trigger the command, any existing edit or diff view for this override will be switched to directly. In the case of a diff view, the diff will be recalculated, allowing any saved changes to be immediately reflected. The configuration option save_on_diff can be enabled to ensure that unsaved changes in the file are persisted first, if desired.

This command ignores the current values of the reuse_view, clear_existing and diff_unchanged settings and operates as if they are set to true, true and diff respectively in order to ensure that you don't end up with a large number of duplicate views.

Delete Override Contextual

Command Palette
OverrideAudit: Delete Override
Context Menu
OverrideAudit: Delete Override (while editing an override, viewing an override diff, or on an override name in a report)

This command is only available while the current file is either an edit session for an override or a diff of an override or in the context menu on an override name in a report.

Like the Swap Diff/Override View command, this command does not appear in the top level Tools > OverrideAudit menu but does appear within the context menu of an appropriate file view and on the context menu of an override file from within an Override Report or Bulk Diff Report.

This command will delete the current override after prompting you to verify that you really mean to delete this file. OverrideAudit attempts to send the override to the trash using the same internal mechanism that Sublime Text uses to delete files.

When an override is deleted, any existing edit sessions of the override will remain open, and Sublime will indicate that they have unsaved changes because the file is missing.

The configuration setting confirm_delete can be set to false if you want to be able to delete overrides without being prompted first.

Freshen Expired Overrides Contextual

Context Menu
OverrideAudit: Freshen Expired Overrides in Package (on a package name in a report)
OverrideAudit: Freshen Override (on an override name in a report)

This command is only available from within the context menu of an Override Report or Diff Report for overrides that are expired or for packages that contain at least one expired override.

When used, the last modification time stamp of the selected expired overrides is modified to be more recent than the underlying file after pormpting you to verify that you meant to perform the freshen operation.

This stops OverrideAudit from reporting that override as being expired and also modifies the report to indicate that the overrides freshened are now no longer expired.

Freshening a package is a shortcut for freshening all of the expired overrides that it contains all in one operation, which may be handy in cases where package files have been updated in the sublime-package file without their content changing.

The configuration setting confirm_freshen can be set to false if you want to be able to freshen overrides without being prompted first.