Skip to content

Commit e9fc372

Browse files
authored
Merge pull request #214 from SamErde/sde-megalinter-01
Lint Remover
2 parents 0d1eac9 + 3bf6859 commit e9fc372

11 files changed

+159
-156
lines changed

.cspell.json

+28-45
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,34 @@
33
"@cspell/dict-powershell/cspell-ext.json",
44
"@cspell/dict-csharp/cspell-ext.json"
55
],
6-
76
"version": "0.2",
87
"language": "en",
9-
10-
"words": [
11-
"RSAT",
12-
"Artefacts",
13-
"NTDS",
14-
"Hildreth"
15-
],
16-
17-
"ignoreWords": [
18-
"malconfiguration",
19-
"sarif",
20-
"psscriptanalyzer",
21-
"DEVSKIM",
22-
"KICS",
23-
"pscustomobject",
24-
"certutil",
25-
"certsvc",
26-
"setreg",
27-
"contoso",
28-
"SCHANNEL",
29-
"RSATAD",
30-
"Dism",
31-
"getreg",
32-
"Dacl",
33-
"Calver"
34-
],
35-
36-
"flagWords": [
37-
],
38-
39-
"patterns": [
40-
{
41-
"name": "ALL-CAPS-WORDS",
42-
"pattern": "/\b[A-Z0-9]+\b/g",
43-
"description": "Any word in ALL CAPS."
44-
}
45-
],
46-
47-
"ignoreRegExpList": [
48-
"ALL-CAPS-WORDS",
49-
"Email",
50-
"github.com/",
51-
"@"
52-
]
8+
"words": ["Artefacts", "Hildreth", "NTDS", "remediations", "RSAT"],
9+
"ignoreWords": [
10+
"malconfiguration",
11+
"sarif",
12+
"psscriptanalyzer",
13+
"DEVSKIM",
14+
"KICS",
15+
"pscustomobject",
16+
"certutil",
17+
"certsvc",
18+
"setreg",
19+
"contoso",
20+
"SCHANNEL",
21+
"RSATAD",
22+
"Dism",
23+
"getreg",
24+
"Dacl",
25+
"Calver"
26+
],
27+
"flagWords": [],
28+
"patterns": [
29+
{
30+
"name": "ALL-CAPS-WORDS",
31+
"pattern": "/\b[A-Z0-9]+\b/g",
32+
"description": "Any word in ALL CAPS."
33+
}
34+
],
35+
"ignoreRegExpList": ["ALL-CAPS-WORDS", "Email", "github.com/", "@"]
5336
}

.github/workflows/Create External Help.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
# Create external help ZIP and CAB files for PowerShell.
2+
# Requires Windows to use the makecab command.
3+
---
14
name: 📚 Create External Help
25

36
on:
47
pull_request:
5-
#push:
8+
# push:
69
workflow_dispatch:
710

811
jobs:

.github/workflows/Deploy MkDocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Deploy MkDocs and push to GitHub Pages
2+
---
13
name: 📖 Deploy MkDocs to GitHub
24
# Install, build, and deploy MkDocs to GitHub Pages using content from the Docs folder.
35

.github/workflows/mega-linter.yml

+76-73
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,94 @@
11
# MegaLinter GitHub Action configuration file
22
# More info at https://megalinter.io
33
---
4-
name: MegaLinter
4+
name: MegaLinter
55

6-
# Trigger mega-linter at every pull request.
7-
on:
8-
pull_request:
9-
# branches:
10-
# - main
11-
# - testing
12-
# - dev
13-
# - experimental
6+
# Trigger mega-linter at every pull request.
7+
on:
8+
pull_request:
9+
# branches:
10+
# - main
11+
# - testing
12+
# push:
13+
# branches:
14+
# - main
15+
# - testing
16+
# workflow_dispatch:
1417

15-
concurrency:
16-
group: ${{ github.ref }}-${{ github.workflow }}
17-
cancel-in-progress: true
18+
concurrency:
19+
group: ${{ github.ref }}-${{ github.workflow }}
20+
cancel-in-progress: true
1821

19-
jobs:
20-
megalinter:
21-
name: MegaLinter
22-
runs-on: ubuntu-latest
23-
permissions:
24-
contents: read
25-
issues: read
26-
pull-requests: read
22+
jobs:
23+
megalinter:
24+
name: MegaLinter
25+
runs-on: ubuntu-latest
26+
permissions:
27+
contents: read
28+
issues: read
29+
pull-requests: read
2730

28-
steps:
31+
steps:
2932

30-
# Git Checkout
31-
- name: Checkout Code
32-
uses: actions/checkout@v4
33-
with:
34-
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
33+
# Git Checkout
34+
- name: Checkout Code
35+
uses: actions/checkout@v4
36+
with:
37+
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
3538

36-
# If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performance
37-
# fetch-depth: 0
39+
# If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performance
40+
# fetch-depth: 0
3841

39-
# MegaLinter
40-
- name: MegaLinter
42+
# MegaLinter
43+
- name: MegaLinter
4144

42-
# You can override MegaLinter flavor used to have faster performances
43-
# More info at https://megalinter.io/flavors/
44-
# The dotnet flavor includes PowerShell, MD, YAML, JSON, spelling, and more.
45-
uses: oxsecurity/megalinter/flavors/dotnet@v8.3.0
45+
# You can override MegaLinter flavor used to have faster performances
46+
# More info at https://megalinter.io/flavors/
47+
# The dotnet flavor includes PowerShell, MD, YAML, JSON, spelling, and more.
48+
uses: oxsecurity/megalinter/flavors/dotnet@v8.3.0
4649

47-
id: ml
50+
id: ml
4851

49-
# All available variables are described in documentation
50-
# https://megalinter.io/configuration/
51-
env:
52+
# All available variables are described in documentation
53+
# https://megalinter.io/configuration/
54+
env:
5255

53-
# Validates all source when push on main, else just the git diff with
54-
# main. Override with true if you always want to lint all sources
55-
#
56-
# To validate the entire codebase, set to:
57-
VALIDATE_ALL_CODEBASE: true
58-
#
59-
# To validate only diff with main, set to:
60-
# VALIDATE_ALL_CODEBASE: >-
61-
# ${{
62-
# github.event_name == 'push' &&
63-
# contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
64-
# }}
65-
# VALIDATE_ALL_CODEBASE: >-
66-
# ${{
67-
# github.event_name == 'push' &&
68-
# contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
69-
# }}
56+
# Validates all source when push on main, else just the git diff with
57+
# main. Override with true if you always want to lint all sources
58+
#
59+
# To validate the entire codebase, set to:
60+
VALIDATE_ALL_CODEBASE: true
61+
#
62+
# To validate only diff with main, set to:
63+
# VALIDATE_ALL_CODEBASE: >-
64+
# ${{
65+
# github.event_name == 'push' &&
66+
# contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
67+
# }}
68+
# VALIDATE_ALL_CODEBASE: >-
69+
# ${{
70+
# github.event_name == 'push' &&
71+
# contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
72+
# }}
7073

71-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
74+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7275

73-
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE
74-
# .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
76+
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE
77+
# .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
7578

76-
# Uncomment to disable copy-paste and spell checks
77-
# DISABLE: COPYPASTE,SPELL
78-
DISABLE_ERRORS: true
79-
DISABLE_LINTERS: EDITORCONFIG_EDITORCONFIG_CHECKER, SPELL_LYCHEE
80-
# Uncomment DISABLE_ERRORS_LINTERS if you want to turn errors back on selectively.
81-
# DISABLE_ERRORS_LINTERS: REPOSITORY_DEVSKIM,REPOSITORY_KICS,REPOSITORY_CHECKOV,POWERSHELL_POWERSHELL,SPELL_CSPELL
79+
# Uncomment to disable copy-paste and spell checks
80+
# DISABLE: COPYPASTE,SPELL
81+
DISABLE_ERRORS: true
82+
DISABLE_LINTERS: EDITORCONFIG_EDITORCONFIG_CHECKER, SPELL_LYCHEE
83+
# Uncomment DISABLE_ERRORS_LINTERS if you want to turn errors back on selectively.
84+
# DISABLE_ERRORS_LINTERS: REPOSITORY_DEVSKIM,REPOSITORY_KICS,REPOSITORY_CHECKOV,POWERSHELL_POWERSHELL,SPELL_CSPELL
8285

83-
# Upload MegaLinter artifacts
84-
- name: Archive production artifacts
85-
uses: actions/upload-artifact@v4
86-
if: success() || failure()
87-
with:
88-
name: MegaLinter reports
89-
path: |
90-
megalinter-reports
91-
mega-linter.log
86+
# Upload MegaLinter artifacts
87+
- name: Archive production artifacts
88+
uses: actions/upload-artifact@v4
89+
if: success() || failure()
90+
with:
91+
name: MegaLinter reports
92+
path: |
93+
megalinter-reports
94+
mega-linter.log

.github/workflows/powershell.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
# https://github.com/microsoft/action-psscriptanalyzer
77
# For more information on PSScriptAnalyzer in general, see
88
# https://github.com/PowerShell/PSScriptAnalyzer
9-
9+
---
1010
name: PSScriptAnalyzer
1111

1212
on:
1313
push:
14-
branches: [ "testing" ]
14+
branches: ["testing", "main"]
1515
pull_request:
1616
schedule:
1717
- cron: '41 14 * * 4'

.mega-linter.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Mega-Linter Configuration File
2+
# This must be separate from the GitHub workflow configuration file.
3+
---
4+
linters:
5+
POWERSHELL_POWERSHELL:
6+
DISABLE_RULES:
7+
- Write-Host
8+
9+
# Enable/disable linters
10+
DISABLE_LINTERS:
11+
- COPYPASTE_JSCPD
12+
- SPELL_CSPELL
13+
- EDITORCONFIG_EDITORCONFIG_CHECKER

.readthedocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# .readthedocs.yaml
44
# Read the Docs configuration file
55
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
6-
6+
---
77
# Required
88
version: 2
99

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ representative at an online or offline event.
5656
## Enforcement
5757

5858
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported to the community leaders responsible for enforcement at coc@dotdot.horse.
59+
reported to the community leaders responsible for enforcement at <coc@dotdot.horse>.
6060
All complaints will be reviewed and investigated promptly and fairly.
6161

6262
All community leaders are obligated to respect the privacy and security of the

0 commit comments

Comments
 (0)