You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
Introduction
2
2
============
3
3
4
-
ScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts. ScriptAnalyzer checks the quality of Windows PowerShell code by running a set of rules. 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 code defects and suggests possible solutions for improvements.
4
+
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. 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 code defects and suggests possible solutions for improvements.
5
5
6
-
ScriptAnalyzer 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, usage of Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also supported.
6
+
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, usage of Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also supported.
@@ -21,7 +21,7 @@ WS2012R2 / Windows 8.1 / Windows OS running PowerShell v5.0 which can be obtaine
21
21
Installation
22
22
============
23
23
24
-
1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/ScriptAnalyzer``]
24
+
1. Build the Code using Visual Studio [solution part of the repo] and navigate to the binplace location [``~/ProjectRoot/PSScriptAnalyzer``]
25
25
26
26
2. In PowerShell Console:
27
27
```powershell
@@ -33,12 +33,12 @@ To confirm installation: run ```Get-ScriptAnalyzerRule``` in the PowerShell cons
33
33
Building the Code
34
34
=================
35
35
36
-
Use Visual Studio to build "ScriptAnalyzer.sln". Use ~/ScriptAnalyzer/ folder to load PSScriptAnalyzer.psd1
36
+
Use Visual Studio to build "ScriptAnalyzer.sln". Use ~/PSScriptAnalyzer/ folder to load PSScriptAnalyzer.psd1
37
37
38
38
Running Tests
39
39
=============
40
40
41
-
Pester-based ScriptAnalyzer Tests are located in ```<branch>/ScriptAnalyzer/Tests``` folder
41
+
Pester-based ScriptAnalyzer Tests are located in ```<branch>/PSScriptAnalyzer/Tests``` folder
42
42
43
43
* Ensure Pester is installed on the machine
44
44
* Go the Tests folder in your local repository
@@ -53,7 +53,7 @@ Contributing to ScriptAnalyzer
53
53
54
54
You are welcome to contribute to this project. There are many ways to contribute:
55
55
56
-
1. Submit a bug report via [Issues](https://github.com/PowerShell/ScriptAnalyzer/issues). For a guide to submitting good bug reports, please read [Painless Bug Tracking](http://www.joelonsoftware.com/articles/fog0000000029.html).
56
+
1. Submit a bug report via [Issues](https://github.com/PowerShell/PSScriptAnalyzer/issues). For a guide to submitting good bug reports, please read [Painless Bug Tracking](http://www.joelonsoftware.com/articles/fog0000000029.html).
57
57
2. Verify fixes for bugs.
58
58
3. Submit your fixes for a bug. Before submitting, please make sure you have:
59
59
* Performed code reviews of your own
@@ -68,4 +68,4 @@ You are welcome to contribute to this project. There are many ways to contribute
68
68
69
69
You might also read these two blog posts about contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza, and [Don’t “Push” Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
70
70
71
-
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via [Issues](https://github.com/PowerShell/ScriptAnalyzer/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.
71
+
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.
0 commit comments