Skip to content

Commit 1091789

Browse files
author
Kapil Borle
committed
Link ToC from each heading
1 parent 6ba3146 commit 1091789

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Table of Contents
3232

3333
<!-- tocstop -->
3434

35-
Introduction
35+
Introduction [&uarr;](#table-of-contents)
3636
============
3737
PSScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts. PSScriptAnalyzer checks the quality of Windows PowerShell code by running a set of rules.
3838
The rules are based on PowerShell best practices identified by PowerShell Team and the community. It generates DiagnosticResults (errors and warnings) to inform users about potential
@@ -41,15 +41,16 @@ code defects and suggests possible solutions for improvements.
4141
PSScriptAnalyzer is shipped with a collection of built-in rules that checks various aspects of PowerShell code such as presence of uninitialized variables, usage of PSCredential Type,
4242
usage of Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also supported.
4343

44-
Usage
44+
45+
Usage [&uarr;](#table-of-contents)
4546
======================
4647
``` PowerShell
4748
Get-ScriptAnalyzerRule [-CustomizedRulePath <string[]>] [-Name <string[]>] [<CommonParameters>] [-Severity <string[]>]
4849
4950
Invoke-ScriptAnalyzer [-Path] <string> [-CustomizedRulePath <string[]>] [-ExcludeRule <string[]>] [-IncludeRule <string[]>] [-Severity <string[]>] [-Recurse] [<CommonParameters>]
5051
```
5152

52-
Installation
53+
Installation [&uarr;](#table-of-contents)
5354
============
5455

5556
### From PowerShell Gallery
@@ -134,7 +135,7 @@ cd /path/to/PSScriptAnalyzer/Tests/Rules
134135
Invoke-Pester
135136
```
136137

137-
Suppressing Rules
138+
Suppressing Rules [&uarr;](#table-of-contents)
138139
=================
139140

140141
You can suppress a rule by decorating a script/function or script/function parameter with .NET's [SuppressMessageAttribute](https://msdn.microsoft.com/en-us/library/system.diagnostics.codeanalysis.suppressmessageattribute.aspx).
@@ -219,7 +220,7 @@ Param()
219220

220221
**Note**: Rule suppression is currently supported only for built-in rules.
221222

222-
Settings Support in ScriptAnalyzer
223+
Settings Support in ScriptAnalyzer [&uarr;](#table-of-contents)
223224
========================================
224225
Settings that describe ScriptAnalyzer rules to include/exclude based on `Severity` can be created and supplied to
225226
`Invoke-ScriptAnalyzer` using the `Setting` parameter. This enables a user to create a custom configuration for a specific environment. We support the following modes for specifying the settings file.
@@ -268,7 +269,7 @@ Invoke-ScriptAnalyzer -Path "C:\path\to\project" -Recurse
268269

269270
Note that providing settings explicitly takes higher precedence over this implicit mode. Sample settings files are provided [here](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Engine/Settings).
270271

271-
ScriptAnalyzer as a .NET library
272+
ScriptAnalyzer as a .NET library [&uarr;](#table-of-contents)
272273
================================
273274

274275
ScriptAnalyzer engine and functionality can now be directly consumed as a library.
@@ -292,7 +293,7 @@ public System.Collections.Generic.IEnumerable<DiagnosticRecord> AnalyzePath(stri
292293
public System.Collections.Generic.IEnumerable<IRule> GetRule(string[] moduleNames, string[] ruleNames)
293294
```
294295

295-
Violation Correction
296+
Violation Correction [&uarr;](#table-of-contents)
296297
====================
297298
Most violations can be fixed by replacing the violation causing content with the correct alternative.
298299

@@ -338,7 +339,7 @@ The main motivation behind having `SuggestedCorrections` is to enable quick-fix
338339
* MissingModuleManifestField.cs
339340
* UseToExportFieldsInManifest.cs
340341

341-
Project Management Dashboard
342+
Project Management Dashboard [&uarr;](#table-of-contents)
342343
==============================
343344
You can track issues, pull requests, backlog items here:
344345

@@ -352,7 +353,7 @@ Throughput Graph
352353

353354
[![Throughput Graph](https://graphs.waffle.io/powershell/psscriptanalyzer/throughput.svg)](https://waffle.io/powershell/psscriptanalyzer/metrics)
354355

355-
Contributing to ScriptAnalyzer
356+
Contributing to ScriptAnalyzer [&uarr;](#table-of-contents)
356357
==============================
357358
You are welcome to contribute to this project. There are many ways to contribute:
358359

@@ -373,6 +374,6 @@ You might also read these two blog posts about contributing code: [Open Source C
373374

374375
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via [Issues](https://github.com/PowerShell/PSScriptAnalyzer/issues), and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.
375376

376-
Code of Conduct
377+
Code of Conduct [&uarr;](#table-of-contents)
377378
===============
378379
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 commit comments

Comments
 (0)