Modularize index template and add project setup by rtuszik · Pull Request #32 · rtuszik/KoalaKeys

rtuszik · 2025-07-18T20:35:38Z

Reorganize index templates into modular components
Move from monolithic index_template.html to component-based structure
Extract CSS into separate file for better maintainability
Split JavaScript into dedicated main.js file
Create reusable body, footer, and header components
Update base template with consistent favicon and font loading
add pyproject.toml and .python-version for project setup and dependency management

socket-security · 2025-07-18T20:40:20Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	bandit@1.8.6
	pygments@2.19.2
	ruamel-yaml-clib@0.2.14
	python-dotenv@1.2.1 ⏵ 1.1.1
	ty@0.0.1a22
	ruff@0.14.0
	ruamel-yaml@0.18.15
	pyyaml@6.0.3
	stevedore@5.5.0
	vulture@2.14
	markupsafe@3.0.3
	tomli@2.3.0
	colorama@0.4.6
	mdurl@0.1.2

View full report

- Reorganize index templates into modular components - Move from monolithic index_template.html to component-based structure - Extract CSS into separate file for better maintainability - Split JavaScript into dedicated main.js file - Create reusable body, footer, and header components - Update base template with consistent favicon and font loading

…pendency management

… file operations

… requirements.txt

… cheatsheet structure

…umentation

…e pyproject.toml

…k, and vulture

…UV package ecosystems

Copilot

Pull Request Overview

This PR modernizes the project's dependency management and tooling by migrating from requirements.txt to uv with a pyproject.toml configuration. Key changes include:

Migration from pip to uv for dependency management with lock file
Addition of dev dependencies (ruff, bandit, ty, vulture) for code quality
Addition of DVORAK keyboard layout support
Code formatting standardization (moving imports, applying consistent quote styles)
Template restructuring: splitting monolithic HTML into modular components
Schema addition for YAML validation
GitHub Actions workflow updates to use uv and new linting tools

Reviewed Changes

Copilot reviewed 22 out of 24 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
pyproject.toml	New project configuration with dependencies and ruff settings
uv.lock	Locked dependency versions for reproducible builds
yaml_cheatsheet_spec.md	Added DVORAK to valid keyboard layouts
src/validate_yaml.py	Code formatting (quotes, imports, spacing)
src/generate_cheatsheet.py	Code formatting and refactored index generation
src/templates/index/*	Split monolithic template into modular components
src/templates/base.html	Fixed invalid HTML attribute, added common head elements
docs/schema/cheatsheet.schema.json	New JSON Schema for YAML validation
.github/workflows/lint.yml	Replaced super-linter with dedicated uv-based checks
README.md	Updated installation instructions for uv

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-02T12:41:10Z

.github/workflows/lint.yml

+            - name: "Set up Python"
+              uses: actions/setup-python@v6
+              with:
+                  python-version-file: "pyproject.toml"


The python-version-file should reference .python-version (which contains '3.13'), not pyproject.toml. The pyproject.toml specifies requires-python = \">=3.9\" which is a constraint, not a specific version to use for the action.

Copilot · 2025-11-02T12:41:10Z

src/templates/index/components/body.html

+        <option value="name-desc">Name (Z-A)</option>
+    </select>
+    <select id="items-per-page" class="items-per-page-select">
+        <option value="9" selected>9 per page</option>


The default value of '9' in the HTML doesn't match the JavaScript default of itemsPerPage = 9 at line 45 of main.js, but there's a discrepancy - the original template had '8 per page' as the first option but the JS used 9. This change makes the HTML match the JS, but the option value should probably be '8' to match the previous behavior, or update the JS to use 9 explicitly.

Suggested change

<option value="9" selected>9 per page</option>

<option value="8" selected>8 per page</option>

<option value="9">9 per page</option>

Copilot · 2025-11-02T12:41:11Z

.github/dependabot.yml

+    - package-ecosystem: "uv"
+      target-branch: "dev"
+
+      directory: "/"


[nitpick] Inconsistent blank line placement: there's a blank line between target-branch: \"dev\" and directory: \"/\" but not for the other package ecosystems. Remove the blank line on line 17 for consistency.

Copilot · 2025-11-02T12:41:11Z

src/templates/index/index_template.html

+<script>
+{% include "index/scripts/main.js" %}
+</script>


Error: Unexpected token

Suggested change

<script>

{% include "index/scripts/main.js" %}

</script>

<script src="{{ url_for('static', filename='index/scripts/main.js') }}"></script>

Copilot · 2025-11-02T12:41:11Z

src/templates/index/scripts/main.js

+const cheatsheets = [
+    {% for cheatsheet in cheatsheets %}
+    { title: {{ cheatsheet.title|tojson }}, filename: {{ cheatsheet.filename|tojson }} },
+    {% endfor %}
+];
+


Error: Unexpected token

Suggested change

const cheatsheets = [

{% for cheatsheet in cheatsheets %}

{ title: {{ cheatsheet.title|tojson }}, filename: {{ cheatsheet.filename|tojson }} },

{% endfor %}

];

// Replace the following with actual cheatsheet data.

// Example: If you have a global variable `window.cheatsheetsData` defined in your HTML:

const cheatsheets = window.cheatsheetsData || [];

// If you need to embed the data, define it in your HTML as:

// <script>

// window.cheatsheetsData = [

// { title: "Cheat 1", filename: "cheat1.html" },

// { title: "Cheat 2", filename: "cheat2.html" }

// ];

// </script>

…n and update Dependabot configuration

Add renovate.json

0f66117

sourcery-ai bot changed the title ~~@sourcery-ai title~~ Modularize index template and add project setup Jul 18, 2025

This comment was marked as outdated.

Sign in to view

This comment was marked as spam.

Sign in to view

rtuszik temporarily deployed to github-pages October 14, 2025 19:50 — with GitHub Pages Inactive

rtuszik temporarily deployed to github-pages October 14, 2025 20:23 — with GitHub Pages Inactive

rtuszik temporarily deployed to github-pages October 14, 2025 20:28 — with GitHub Pages Inactive

rtuszik temporarily deployed to github-pages October 14, 2025 20:34 — with GitHub Pages Inactive

rtuszik added 12 commits November 1, 2025 23:54

feat: add pyproject.toml and .python-version for project setup and de…

c0547ff

…pendency management

refactor(generate_cheatsheet): improve error handling and logging for…

b28f20b

… file operations

docs: update installation and usage instructions to use uv and remove…

18df6b1

… requirements.txt

docs: add cheatsheet JSON schema for KoalaKeys to define and validate…

332f86f

… cheatsheet structure

docs: add schema information to README.md

212d866

fix: add DVORAK keyboard layout option to schema, validation, and doc…

f3648fb

…umentation

refactor: apply ruff formatting and linting to python files and updat…

0597bec

…e pyproject.toml

ci: refactor linting workflow to use separate jobs for lint, typechec…

3ef168d

…k, and vulture

feat(dependabot): add configurations for GitHub Actions, Docker, and …

f551222

…UV package ecosystems

chore: remove renovate.json configuration file

fe3498d

docs(cheatsheets): add JSON schema reference to example cheatsheet

25a4380

rtuszik force-pushed the develop branch from 991e5f5 to 25a4380 Compare November 1, 2025 22:54

rtuszik temporarily deployed to github-pages November 1, 2025 22:55 — with GitHub Pages Inactive

rtuszik requested a review from Copilot November 2, 2025 12:39

Copilot AI reviewed Nov 2, 2025

View reviewed changes

refactor(github-actions): refactor Python setup into a reusable actio…

2cacbdc

…n and update Dependabot configuration

rtuszik merged commit e91c2f9 into main Nov 2, 2025
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modularize index template and add project setup#32

Modularize index template and add project setup#32
rtuszik merged 14 commits intomainfrom
develop

rtuszik commented Jul 18, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

socket-security bot commented Jul 18, 2025 •

edited

Loading

Uh oh!

This comment was marked as spam.

Copilot AI left a comment

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	<option value="9" selected>9 per page</option>
	<option value="8" selected>8 per page</option>
	<option value="9">9 per page</option>

-const cheatsheets = [
-    {% for cheatsheet in cheatsheets %}
-    { title: {{ cheatsheet.title|tojson }}, filename: {{ cheatsheet.filename|tojson }} },
-    {% endfor %}
-];
+// Replace the following with actual cheatsheet data.
+// Example: If you have a global variable `window.cheatsheetsData` defined in your HTML:
+const cheatsheets = window.cheatsheetsData || [];
+// If you need to embed the data, define it in your HTML as:
+// <script>
+//   window.cheatsheetsData = [
+//     { title: "Cheat 1", filename: "cheat1.html" },
+//     { title: "Cheat 2", filename: "cheat2.html" }
+//   ];
+// </script>

Conversation

rtuszik commented Jul 18, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

socket-security bot commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as spam.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

socket-security bot commented Jul 18, 2025 •

edited

Loading