2 | 
3 |
20 | 
21 |
22 |
3 |
18 |
28 |
37 | {{ title }}
19 |
20 |
21 |
22 |
27 |
38 | {% if render_keys %}
39 |
162 |
--------------------------------------------------------------------------------
/src/templates/cheatsheets/components/header.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 | Keyboard Layout: {{ layout.keyboard }} | System: {{ layout.system }}
40 | 41 |
42 |
137 | {% endif %}
138 | {% for section, shortcuts in shortcuts.items() %}
139 |
45 |
46 |
136 |
47 |
61 | Esc
48 | F1
49 | F2
50 | F3
51 | F4
52 | F5
53 | F6
54 | F7
55 | F8
56 | F9
57 | F10
58 | F11
59 | F12
60 |
62 |
77 | ` ~
63 | 1 !
64 | 2 @
65 | 3 #
66 | 4 $
67 | 5 %
68 | 6 ^
69 | 7 &
70 | 8 *
71 | 9 (
72 | 0 )
73 | - _
74 | =+
75 | Backspace
76 |
78 |
93 | Tab
79 | Q
80 | W
81 | E
82 | R
83 | T
84 | Y
85 | U
86 | I
87 | O
88 | P
89 | [{
90 | ]}
91 | \|
92 |
94 |
108 | Caps Lock
95 | A
96 | S
97 | D
98 | F
99 | G
100 | H
101 | J
102 | K
103 | L
104 | ; :
105 | ' "
106 | Enter
107 |
109 |
122 | Shift
110 | Z
111 | X
112 | C
113 | V
114 | B
115 | N
116 | M
117 | <, >
118 | . >
119 | / ?
120 | Shift
121 |
123 |
135 | CTRL
124 | ALT
125 | CMD
126 |
127 | CMD
128 | ALT
129 | CTRL
130 | ←
131 | ↑
132 | ↓
133 | →
134 |
140 |
160 | {% endfor %}
161 | {{ section }}
141 |
142 | {% for shortcut, details in shortcuts.items() %}
143 |
159 |
145 |
157 | {% endfor %}
158 |
146 | {% if allow_text %}
147 | {{ shortcut }}
148 | {% else %}
149 | {% for key in shortcut.split('') %}
150 | {{ key | safe }}
151 | {% if not loop.last %}+{% endif %}
152 | {% endfor %}
153 | {% endif %}
154 |
155 | {{ details.description }}
156 |
416 | 
421 |
426 |
421 | Cheatsheet Index
422 | 425 |
427 |
430 |
434 |
441 |
442 |
447 |
448 |
449 |
450 |
451 |
571 |
572 |
597 |
598 |
--------------------------------------------------------------------------------
/src/validate_yaml.py:
--------------------------------------------------------------------------------
1 | from ruamel.yaml import YAML
2 | from ruamel.yaml.error import YAMLError
3 | import re
4 | from logger import get_logger
5 |
6 | logger = get_logger()
7 |
8 | # Create YAML instances once
9 | yaml_safe = YAML(typ='safe')
10 | yaml_rw = YAML()
11 | yaml_rw.indent(mapping=2, sequence=4, offset=2)
12 | yaml_rw.preserve_quotes = True
13 | yaml_rw.width = 100
14 |
15 | def validate_required_keys(data):
16 | """Validate presence of required top-level keys."""
17 | required_keys = ['title', 'shortcuts']
18 | for key in required_keys:
19 | if key not in data:
20 | logger.error(f"Missing required top-level key: '{key}'")
21 | return False
22 | return True
23 |
24 | def validate_title(data):
25 | """Validate title field."""
26 | if 'title' in data and not isinstance(data['title'], str):
27 | logger.error("Title must be a string")
28 | return False
29 | return True
30 |
31 | def validate_render_options(data):
32 | """Validate RenderKeys and AllowText options."""
33 | is_valid = True
34 | render_keys = data.get('RenderKeys', True)
35 | allow_text = data.get('AllowText', False)
36 |
37 | if 'RenderKeys' in data and not isinstance(render_keys, bool):
38 | logger.error("RenderKeys must be a boolean value (true/false)")
39 | is_valid = False
40 |
41 | if 'AllowText' in data and not isinstance(allow_text, bool):
42 | logger.error("AllowText must be a boolean value (true/false)")
43 | is_valid = False
44 |
45 | if allow_text and render_keys:
46 | logger.error("AllowText can only be true when RenderKeys is false")
47 | is_valid = False
48 |
49 | return is_valid
50 |
51 | def validate_layout(data):
52 | """Validate keyboard layout configuration."""
53 | if 'layout' not in data:
54 | return True
55 |
56 | if not isinstance(data['layout'], dict):
57 | logger.error("Layout must be a dictionary")
58 | return False
59 |
60 | valid_keyboards = ['US', 'UK', 'DE', 'FR', 'ES']
61 | valid_systems = ['Darwin', 'Linux', 'Windows']
62 | is_valid = True
63 |
64 | if 'keyboard' in data['layout'] and data['layout']['keyboard'] not in valid_keyboards:
65 | logger.error(f"Invalid keyboard layout. Must be one of: {', '.join(valid_keyboards)}")
66 | is_valid = False
67 |
68 | if 'system' in data['layout'] and data['layout']['system'] not in valid_systems:
69 | logger.error(f"Invalid system. Must be one of: {', '.join(valid_systems)}")
70 | is_valid = False
71 |
72 | return is_valid
73 |
74 | def validate_shortcuts(data):
75 | """Validate shortcuts structure and content."""
76 | if 'shortcuts' not in data:
77 | return True
78 |
79 | if not isinstance(data['shortcuts'], dict):
80 | logger.error("Shortcuts must be a dictionary")
81 | return False
82 |
83 | allow_text = data.get('AllowText', False)
84 | is_valid = True
85 |
86 | for category, shortcuts in data['shortcuts'].items():
87 | if not isinstance(shortcuts, dict):
88 | logger.error(f"Category '{category}' must contain a dictionary of shortcuts")
89 | is_valid = False
90 | continue
91 |
92 | for shortcut, details in shortcuts.items():
93 | if not isinstance(details, dict) or 'description' not in details:
94 | logger.error(f"Shortcut '{shortcut}' in category '{category}' must have a 'description' key")
95 | is_valid = False
96 | elif not isinstance(details['description'], str):
97 | logger.error(f"Description for shortcut '{shortcut}' in category '{category}' must be a string")
98 | is_valid = False
99 |
100 | if not allow_text:
101 | if not re.match(r'^[A-Za-z0-9+⌘⌥⌃⇧←→↑↓\s\-\|\[\],.:/`"?<>=\\⌃]+$', shortcut):
102 | logger.error(f"Invalid shortcut format: '{shortcut}' in category '{category}'")
103 | is_valid = False
104 |
105 | return is_valid
106 |
107 | def validate_yaml(file_path):
108 | """Validate YAML file structure and content."""
109 | try:
110 | with open(file_path, 'r', encoding='utf-8') as file:
111 | data = yaml_safe.load(file)
112 | except YAMLError as e:
113 | logger.error(f"YAML parsing error in {file_path}: {str(e)}")
114 | return False
115 | except FileNotFoundError:
116 | logger.error(f"File not found: {file_path}")
117 | return False
118 | except Exception as e:
119 | logger.error(f"Unexpected error reading {file_path}: {str(e)}")
120 | return False
121 |
122 | if data is None:
123 | logger.error(f"Empty YAML file: {file_path}")
124 | return False
125 |
126 | is_valid = True
127 |
128 | # Perform all validations
129 | if not validate_required_keys(data):
130 | is_valid = False
131 | if not validate_title(data):
132 | is_valid = False
133 | if not validate_render_options(data):
134 | is_valid = False
135 | if not validate_layout(data):
136 | is_valid = False
137 | if not validate_shortcuts(data):
138 | is_valid = False
139 |
140 | if is_valid:
141 | logger.info(f"YAML validation successful: {file_path}")
142 | else:
143 | logger.error(f"YAML validation failed: {file_path}")
144 |
145 | return is_valid
146 |
147 | def lint_yaml(file_path):
148 | warnings = []
149 |
150 | with open(file_path, 'r', encoding="utf-8") as file:
151 | lines = file.readlines()
152 |
153 | for i, line in enumerate(lines, start=1):
154 | # Check for lines longer than 100 characters
155 | if len(line.rstrip()) > 100:
156 | warnings.append(f"Line {i} is longer than 100 characters")
157 |
158 | # Check for inconsistent indentation
159 | indent = len(line) - len(line.lstrip())
160 | if indent % 2 != 0:
161 | warnings.append(f"Line {i} has inconsistent indentation")
162 |
163 | # Check for trailing whitespace
164 | if line.rstrip() != line.rstrip('\n'):
165 | warnings.append(f"Line {i} has trailing whitespace")
166 |
167 | return warnings
168 |
169 | def fix_yaml(file_path):
170 | with open(file_path, 'r', encoding="utf-8") as file:
171 | content = file.read()
172 |
173 | fixes = []
174 |
175 | # Replace special characters and convert to uppercase
176 | special_chars = {'⌘': 'CMD', '⌃': 'CTRL', '⌥': 'ALT', '⇧': 'SHIFT'}
177 | for char, replacement in special_chars.items():
178 | if char in content:
179 | content = content.replace(char, replacement)
180 | fixes.append(f"Replaced '{char}' with '{replacement}'")
181 |
182 | # Convert lowercase special keys to uppercase
183 | lowercase_keys = ['cmd', 'ctrl', 'alt', 'shift']
184 | for key in lowercase_keys:
185 | pattern = re.compile(r'\b' + key + r'\b', re.IGNORECASE)
186 | content = pattern.sub(key.upper(), content)
187 | if pattern.search(content):
188 | fixes.append(f"Converted '{key}' to uppercase")
189 |
190 | # Fix indentation
191 | lines = content.split('\n')
192 | fixed_lines = []
193 | for line in lines:
194 | stripped = line.lstrip()
195 | indent = len(line) - len(stripped)
196 | fixed_indent = (indent // 2) * 2 # Round down to nearest even number
197 | if fixed_indent != indent:
198 | fixes.append(f"Fixed indentation in line: {line.strip()}")
199 | fixed_lines.append(' ' * fixed_indent + stripped.rstrip())
200 |
201 | fixed_content = '\n'.join(fixed_lines)
202 |
203 | # Write fixed content back to file
204 | with open(file_path, 'w', encoding="utf-8") as file:
205 | file.write(fixed_content)
206 |
207 | return fixes
208 |
209 | def format_yaml(file_path):
210 | yaml = YAML()
211 | yaml.indent(mapping=2, sequence=4, offset=2)
212 | yaml.preserve_quotes = True
213 | yaml.width = 100
214 |
215 | with open(file_path, 'r', encoding='utf-8') as file:
216 | data = yaml.load(file)
217 |
218 | with open(file_path, 'w', encoding='utf-8') as file:
219 | yaml.dump(data, file)
220 |
221 | return "YAML file has been formatted for improved readability."
222 |
223 | def process_yaml(file_path):
224 | print(f"Processing {file_path}...")
225 |
226 | # Validate
227 | errors = validate_yaml(file_path)
228 | if errors:
229 | print("Validation errors:")
230 | for error in errors:
231 | print(f"- {error}")
232 | else:
233 | print("Validation passed.")
234 |
235 | # Lint
236 | warnings = lint_yaml(file_path)
237 | if warnings:
238 | print("Linting warnings:")
239 | for warning in warnings:
240 | print(f"- {warning}")
241 | else:
242 | print("Linting passed.")
243 |
244 | # Fix
245 | fixes = fix_yaml(file_path)
246 | if fixes:
247 | print("Fixes applied:")
248 | for fix in fixes:
249 | print(f"- {fix}")
250 | else:
251 | print("No fixes were necessary.")
252 |
253 | # Format
254 | format_message = format_yaml(file_path)
255 | print(format_message)
256 |
257 | if __name__ == "__main__":
258 | import sys
259 | if len(sys.argv) != 2:
260 | print("Usage: python validate_yaml.py