@@ -28,7 +28,7 @@ See the [Build and install](#build-and-install) section below for how to build a
2828- [ ** Audited Files** ] ( #audited-files ) - Mark an entire file as reviewed.
2929- [ ** Partially Audited Files** ] ( #partially-audited-files ) - Mark a region of code as reviewed.
3030- [ ** Detailed Findings** ] ( #detailed-findings ) - Fill detailed information about a finding.
31- - [ ** GitHub/Gitlab Issues** ] ( #github -issues ) - Create formatted GitHub or Gitlab issues with the Detailed Findings information.
31+ - [ ** GitHub/Gitlab Issues** ] ( #githubgitlab -issues ) - Create formatted GitHub or Gitlab issues with the Detailed Findings information.
3232- [ ** Multi-region Findings** ] ( #multi-region-findings ) - Group multiple locations under a single finding.
3333- [ ** Resolve and Restore** ] ( #resolve-and-restore ) - Resolved findings will not be highlighted in the editor but are still visible in the sidebar.
3434- [ ** Copy Permalinks** ] ( #copy-permalinks ) - Copy GitHub permalinks to findings, or to a selected code region.
@@ -39,7 +39,7 @@ See the [Build and install](#build-and-install) section below for how to build a
3939- [ ** Search & Filter Findings** ] ( #search--filter-findings ) - Search and filter the findings in the _ List of Findings_ panel.
4040- [ ** Export Findings** ] ( #export-findings ) - Export findings to a markdown file.
4141- [ ** Drag & drop Findings and Locations** ] ( #drag--drop-findings-and-locations ) - Drag and drop findings and locations in the _ List of Findings_ panel.
42- - [ ** Settings** ] ( #settings ) - Customize colors.
42+ - [ ** Settings** ] ( #settings ) - Customize colors and general preferences .
4343
4444---
4545
@@ -167,12 +167,19 @@ You can drag and drop findings and locations in the _List of Findings_ panel to:
167167
168168### Settings
169169
170+ #### General settings
171+
172+ - ` weAudit.general.treeViewMode ` : The List of Findings display mode ("list" or "byFile")
173+ - ` weAudit.general.githubOrganizationName ` : Organization name for audit repository (enhances permalink heuristic)
174+ - ` weAudit.general.username ` : Username to use as finding's author (defaults to system username if empty)
175+ - ` weAudit.general.permalinkSeparator ` : Separator to use in permalinks (\\ n is interpreted as newline)
176+
170177#### Background colors
171178
172179Each background color is customizable via the VSCode settings page. Write as #RGB, #RGBA, #RRGGBB or #RRGGBBAA:
173180
174181- ` weAudit.auditedColor ` : Background color for files marked as audited
175- - ` wAudit .{other,own}findingColor` : Background color for findings
182+ - ` weAudit .{other,own}findingColor` : Background color for findings
176183- ` weAudit.{other,own}noteColor ` : Background color for notes
177184
178185#### Keybindings
@@ -186,6 +193,7 @@ You can configure the keybindings to any of the extension's commands in the VSCo
186193- ` weAudit.toggleAudited ` : Mark Current File As Reviewed: ` cmd + 7 `
187194- ` weAudit.addPartiallyAudited ` : Mark Region As Reviewed: ` cmd + shift + 7 `
188195- ` weAudit.copySelectedCodePermalink ` : Copy Permalink (for the Selected Code Region): ` cmd + 8 `
196+ - ` weAudit.copySelectedCodeClientPermalink ` : Copy Client Permalink (for the Selected Code Region): ` cmd + 9 `
189197- ` weAudit.navigateToNextPartiallyAuditedRegion ` : Navigate to Next Partially Audited Region: ` cmd + 0 `
190198
191199## WeAudit Concepts
0 commit comments