Skip to content

Commit d0fe1bd

Browse files
MariusStorhaugMariusStorhaug
authored
🩹 [Patch]: Add linter config and update license year (#68)
## Description This pull request includes several updates to the linter configurations and a minor update to the LICENSE file. The most important changes are the addition of a new `.jscpd.json` configuration file, updates to the PowerShell PSScriptAnalyzer settings, and modifications to the GitHub Actions workflow for linting. Linter configuration updates: * Added a new `.jscpd.json` configuration file to set up code duplication detection with specific settings. * Updated the `.powershell-psscriptanalyzer.psd1` file to enable and configure various PowerShell script analysis rules, including alignment, line length, and indentation settings. GitHub Actions workflow updates: * Modified the `.github/workflows/Linter.yml` file to change the linter action from `github/super-linter` to `super-linter/super-linter` and added configurations to disable Prettier validation for JSON, Markdown, and YAML files. Other changes: * Updated the `LICENSE` file to reflect the year 2025. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 6cea6ab commit d0fe1bd

6 files changed

Lines changed: 590 additions & 21 deletions

File tree

‎.github/linters/.jscpd.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"threshold": 0,
3+
"reporters": [
4+
"consoleFull"
5+
],
6+
"ignore": [
7+
"**/tests/*"
8+
],
9+
"absolute": true
10+
}

‎.github/linters/.powershell-psscriptanalyzer.psd1‎

Lines changed: 54 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,57 @@
1-
#Documentation: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-settings
2-
@{
3-
#CustomRulePath='path\to\CustomRuleModule.psm1'
4-
#RecurseCustomRulePath='path\of\customrules'
5-
#Severity = @(
6-
# 'Error'
7-
# 'Warning'
8-
#)
9-
#IncludeDefaultRules=${true}
1+
@{
2+
Rules = @{
3+
PSAlignAssignmentStatement = @{
4+
Enable = $true
5+
CheckHashtable = $true
6+
}
7+
PSAvoidLongLines = @{
8+
Enable = $true
9+
MaximumLineLength = 150
10+
}
11+
PSAvoidSemicolonsAsLineTerminators = @{
12+
Enable = $true
13+
}
14+
PSPlaceCloseBrace = @{
15+
Enable = $true
16+
NewLineAfter = $false
17+
IgnoreOneLineBlock = $true
18+
NoEmptyLineBefore = $false
19+
}
20+
PSPlaceOpenBrace = @{
21+
Enable = $true
22+
OnSameLine = $true
23+
NewLineAfter = $true
24+
IgnoreOneLineBlock = $true
25+
}
26+
PSProvideCommentHelp = @{
27+
Enable = $true
28+
ExportedOnly = $false
29+
BlockComment = $true
30+
VSCodeSnippetCorrection = $false
31+
Placement = 'begin'
32+
}
33+
PSUseConsistentIndentation = @{
34+
Enable = $true
35+
IndentationSize = 4
36+
PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
37+
Kind = 'space'
38+
}
39+
PSUseConsistentWhitespace = @{
40+
Enable = $true
41+
CheckInnerBrace = $true
42+
CheckOpenBrace = $true
43+
CheckOpenParen = $true
44+
CheckOperator = $true
45+
CheckPipe = $true
46+
CheckPipeForRedundantWhitespace = $true
47+
CheckSeparator = $true
48+
CheckParameter = $true
49+
IgnoreAssignmentOperatorInsideHashTable = $true
50+
}
51+
}
1052
ExcludeRules = @(
11-
'PSAvoidUsingWriteHost'
53+
'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
54+
'PSAvoidUsingCmdletAliases',
55+
'PSUseToExportFieldsInManifest'
1256
)
13-
#IncludeRules = @(
14-
# 'PSAvoidUsingWriteHost',
15-
# 'MyCustomRuleName'
16-
#)
1757
}

0 commit comments

Comments
 (0)