Repository navigation
1.0.0 #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
1.0.0 #81
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
8b9e734
refactor: reorganize source into koalakeys package structure
rtuszik 3128ebc
add pre-commit
rtuszik de1168b
refactor(generate_cheatsheet): extract separator and formatting helpers
rtuszik 040bf75
refactor: simplify validation logic with validator list
rtuszik 31b4b62
fix test imports
rtuszik 09f9d25
exclude tests dir from pytest coverage
rtuszik 308a961
remove bandit (use ruff B rules)
rtuszik 68211db
update uv.lock
rtuszik 3abae6c
feat: add theming support
rtuszik 6a40aa6
refactor(theming): add assertions for theme mode existence
rtuszik f12d27a
ci(github): pin actions, disable checkout creds, add permissions
rtuszik 86da727
test(browser): add Playwright browser tests and fixtures
rtuszik 4f8d5c0
chore: workflow formatting
rtuszik 924a323
feat(cli): add init, generate, and validate commands
rtuszik 3d2dbb7
docs: update CLI usage, themes, and example screenshot
rtuszik 68d1266
fix: harden validation, css paths, and failure reporting
rtuszik fa42d4c
chore: bump to version 1.0.0 and update quick start docs
rtuszik 11088a5
chore: add mise configuration
rtuszik 0f5d5e0
ci: add release-please and PyPI trusted publishing workflow
rtuszik e1b896d
fix(deps): regenerate uv.lock after rebase onto main
rtuszik aef89e4
fix: add release-please config, improve theme validation and cli
rtuszik 872316b
docs: update images and add third-party licenses
rtuszik e180560
fix: keep theme default mode until toggled, quote init path per platform
rtuszik 816c6c2
fix(cli): quote cmd metacharacters in Windows cd hint
rtuszik 849c7b9
docs(themes): add theme token contract
rtuszik 668a78a
refactor: use shlex.quote for init path and update theme cascade docs
rtuszik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,38 @@ | ||
| --- | ||
| name: checks | ||
| on: | ||
| pull_request: | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: ./.github/actions/setup-python | ||
| - run: | | ||
| uv run ruff check --fix | ||
| uv run ruff format | ||
| uv run ruff check --fix | ||
| uv run ruff format | ||
|
|
||
| typecheck: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: ./.github/actions/setup-python | ||
| - run: uv run ty check | ||
|
|
||
| vulture: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: ./.github/actions/setup-python | ||
| - run: uv run vulture --min-confidence 100 --exclude ".venv" . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| name: release | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| release-please: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| outputs: | ||
| release_created: ${{ steps.release.outputs.release_created }} | ||
| tag_name: ${{ steps.release.outputs.tag_name }} | ||
| steps: | ||
| - id: release | ||
| uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0 | ||
| with: | ||
| config-file: release-please-config.json | ||
| manifest-file: .release-please-manifest.json | ||
|
|
||
| publish: | ||
| needs: release-please | ||
| if: needs.release-please.outputs.release_created == 'true' | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/project/koalakeys/ | ||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| ref: ${{ needs.release-please.outputs.tag_name }} | ||
| persist-credentials: false | ||
| - uses: astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e # v10.3.2 | ||
| with: | ||
| enable-cache: false | ||
| - name: Build | ||
| run: uv build | ||
| - name: Publish to PyPI | ||
| uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
|
|
||
| repos: | ||
| - repo: https://github.com/astral-sh/ruff-pre-commit | ||
| rev: v0.15.4 | ||
| hooks: | ||
| - id: ruff-check | ||
| args: [--fix] | ||
| - id: ruff-format |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| ".": "0.6.0" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Third-party licenses | ||
|
|
||
| KoalaKeys ships built-in color themes whose palettes (hex color values) are derived | ||
| from the following open-source projects. KoalaKeys reproduces only the color values | ||
| and palette names; no source files from these projects are included. The palette | ||
| names are used nominatively to identify which palette each theme reproduces and do | ||
| not imply any endorsement by their authors. | ||
|
|
||
| All listed palettes are distributed under the MIT License (Gruvbox as "MIT/X11"). | ||
| The MIT permission notice below applies to each, with the respective copyright holders: | ||
|
|
||
| - **Catppuccin** — Copyright (c) 2021 Catppuccin — https://github.com/catppuccin/palette | ||
| - **Rosé Pine** — Copyright (c) mvllow — https://github.com/rose-pine/palette | ||
| - **Gruvbox** — Copyright (c) 2017 Pavel Pertsev (morhetz) — https://github.com/morhetz/gruvbox | ||
| - **Solarized** — Copyright (c) 2011 Ethan Schoonover — https://github.com/altercation/solarized | ||
| - **Nord** — Copyright (c) 2016-present Sven Greb <development@svengreb.de> — https://github.com/nordtheme/nord | ||
| - **Dracula** — Copyright (c) 2023 Dracula Theme — https://github.com/dracula/dracula-theme | ||
|
|
||
| ## MIT License | ||
|
|
||
| ``` | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| ``` | ||
|
|
||
| ## Fonts | ||
|
|
||
| The default `font_url` references **Iosevka** (Copyright Belleve Invis, | ||
| https://github.com/be5invis/Iosevka), licensed under the SIL Open Font License 1.1. | ||
| KoalaKeys links to a CDN-hosted webfont stylesheet and does not redistribute the | ||
| font files. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.