Skip to content

Commit 35bca0b

Browse files
rnetserrnetser
authored
Merge pull request #3 from RedHatQE/linter
Linter
2 parents 42477af + 25387f3 commit 35bca0b

File tree

4 files changed

+321
-34
lines changed

4 files changed

+321
-34
lines changed

‎.gitignore‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Claude Code configuration directory
2+
.claude/
3+
4+
# Python
5+
__pycache__/
6+
*.py[cod]
7+
*$py.class
8+
*.so
9+
.Python
10+
*.egg-info/
11+
dist/
12+
build/
13+
14+
# Virtual environments
15+
.venv/
16+
venv/
17+
ENV/
18+
env/
19+
20+
# IDEs
21+
.vscode/
22+
.idea/
23+
*.swp
24+
*.swo
25+
*~
26+
27+
# OS
28+
.DS_Store
29+
Thumbs.db
30+
31+
# Logs
32+
*.log

‎.markdownlint.yaml‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Markdownlint configuration for OpenShift Virtualization test documentation
2+
# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for rule details
3+
4+
# Enable all rules by default, then override specific ones below
5+
default: true
6+
7+
# MD001 - Heading levels should only increment by one level at a time
8+
MD001: true
9+
10+
# MD003 - Heading style consistency (atx, atx_closed, setext)
11+
MD003: true
12+
13+
# MD004 - Unordered list style consistency
14+
MD004: true
15+
16+
# MD005 - Consistent indentation for list items at the same level
17+
MD005: true
18+
19+
# MD007 - Unordered list indentation (how many spaces for nested items)
20+
MD007: true
21+
22+
# MD009 - Trailing spaces (allows 2 spaces for hard line breaks in markdown)
23+
MD009: true
24+
25+
# MD010 - Hard tabs - DISABLED: Code examples may use hard tabs
26+
MD010: false
27+
28+
# MD012 - Multiple consecutive blank lines
29+
MD012: true
30+
31+
# MD013 - Line length - DISABLED: No line length restrictions for flexibility
32+
MD013: false
33+
34+
# MD014 - Dollar signs used before commands without showing output
35+
MD014: true
36+
37+
# MD018 - No space after hash on atx style heading
38+
MD018: true
39+
40+
# MD019 - Multiple spaces after hash on atx style heading
41+
MD019: true
42+
43+
# MD020 - No space inside hashes on closed atx style heading
44+
MD020: true
45+
46+
# MD021 - Multiple spaces inside hashes on closed atx style heading
47+
MD021: true
48+
49+
# MD022 - Headings should be surrounded by blank lines - DISABLED: Flexible spacing
50+
MD022: false
51+
52+
# MD023 - Headings must start at the beginning of the line
53+
MD023: true
54+
55+
# MD024 - Multiple headings with the same content
56+
MD024: false
57+
58+
# MD025 - Multiple top-level headings - DISABLED: Allows multiple H1 headings in the same document
59+
MD025: false
60+
61+
# MD026 - Trailing punctuation in heading
62+
MD026: true
63+
64+
# MD027 - Multiple spaces after blockquote symbol
65+
MD027: true
66+
67+
# MD028 - Blank line inside blockquote
68+
MD028: true
69+
70+
# MD029 - Ordered list item prefix (ordered, one, zero)
71+
MD029: true
72+
73+
# MD030 - Spaces after list markers
74+
MD030: true
75+
76+
# MD031 - Fenced code blocks surrounded by blank lines - DISABLED: Flexible spacing
77+
MD031: true
78+
79+
# MD032 - Lists surrounded by blank lines - DISABLED: Flexible spacing
80+
MD032: false
81+
82+
# MD033 - Inline HTML - DISABLED: Allows HTML for complex tables and formatting
83+
MD033: false
84+
85+
# MD034 - Bare URL used - DISABLED: Allows URLs without angle brackets or link text
86+
MD034: false
87+
88+
# MD035 - Horizontal rule style
89+
MD035: true
90+
91+
# MD036 - Emphasis used instead of a heading - DISABLED: Allows emphasized text that looks like headings
92+
MD036: false
93+
94+
# MD037 - Spaces inside emphasis markers
95+
MD037: true
96+
97+
# MD038 - Spaces inside code span elements
98+
MD038: true
99+
100+
# MD039 - Spaces inside link text
101+
MD039: true
102+
103+
# MD040 - Fenced code blocks should have a language specified
104+
MD040: true
105+
106+
# MD041 - First line in file should be a top level heading - DISABLED: Flexible document structure
107+
MD041: false
108+
109+
# MD042 - No empty links
110+
MD042: true
111+
112+
# MD043 - Required heading structure
113+
MD043: true
114+
115+
# MD044 - Proper names should have the correct capitalization
116+
MD044: true
117+
118+
# MD045 - Images should have alternate text (alt text)
119+
MD045: true
120+
121+
# MD046 - Code block style (consistent, fenced, indented)
122+
MD046: true
123+
124+
# MD047 - Files should end with a single newline character - DISABLED: Flexible file endings
125+
MD047: false
126+
127+
# MD048 - Code fence style (consistent, backtick, tilde)
128+
MD048: true
129+
130+
# MD049 - Emphasis style - DISABLED: Allows both * and _ for emphasis
131+
MD049: false
132+
133+
# MD050 - Strong style - DISABLED: Allows both ** and __ for bold
134+
MD050: false
135+
136+
# MD051 - Link fragments should be valid
137+
MD051: true
138+
139+
# MD052 - Reference links and images should use a label that is defined
140+
MD052: true
141+
142+
# MD053 - Link and image reference definitions should be needed
143+
MD053: true
144+
145+
# Additional named rules (aliases for MD rules above)
146+
line-length: false # Alias for MD013
147+
no-hard-tabs: false # Alias for MD010 - allows tabs in code examples
148+
no-bare-urls: false # Alias for MD034 - allows bare URLs in documentation
149+
single-title: false # Alias for MD025 - allows multiple H1 headings
150+
no-emphasis-as-heading: false # Alias for MD036 - allows emphasized text as section markers
151+
no-inline-html: false # Alias for MD033 - allows HTML for complex formatting
152+
ul-style: false # Alias for MD004 - flexible unordered list markers (*, -, +)
153+
ol-prefix: false # Alias for MD029 - flexible ordered list numbering
154+
blanks-around-fences: false # Alias for MD031 - flexible spacing around code blocks
155+
blanks-around-headings: false # Alias for MD022 - flexible spacing around headings
156+
blanks-around-lists: false # Alias for MD032 - flexible spacing around lists
157+
single-trailing-newline: false # Alias for MD047 - flexible file endings
158+
no-multiple-blanks: false # Alias for MD012 - allows multiple blank lines for readability
159+
no-trailing-spaces: false # Alias for MD009 - allows trailing spaces
160+
emphasis-style: false # Alias for MD049 - flexible emphasis style
161+
strong-style: false # Alias for MD050 - flexible strong/bold style
162+
no-space-in-emphasis: false # Alias for MD037 - flexible spacing in emphasis
163+
commands-show-output: false # Shell command examples don't need to show output

‎.pre-commit-config.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Pre-commit hooks for OpenShift Virtualization test documentation
2+
# See https://pre-commit.com for more information
3+
4+
repos:
5+
# Markdownlint for Markdown file linting
6+
- repo: https://github.com/igorshubovych/markdownlint-cli
7+
rev: v0.39.0
8+
hooks:
9+
- id: markdownlint
10+
name: Lint Markdown files
11+
files: \.md$
12+
13+
- repo: https://github.com/pre-commit/pre-commit-hooks
14+
rev: "v6.0.0"
15+
hooks:
16+
- id: check-merge-conflict
17+
stages: [pre-commit]
18+
- id: trailing-whitespace
19+
stages: [pre-commit]
20+
- id: end-of-file-fixer
21+
stages: [pre-commit]
22+
- id: detect-private-key
23+
- id: mixed-line-ending
24+
25+
- repo: https://github.com/gitleaks/gitleaks
26+
rev: "v8.28.0"
27+
hooks:
28+
- id: gitleaks

0 commit comments

Comments
 (0)