feat!: v1.0.0 release 🎉 (#17)

* Declarative key mapping via config files (`yaml`, `json`, `toml`, etc.)
* Support for key sequences like `ctrl-b n`, `g g`, etc.
* Support key groups (`@upper`, `@any`, etc.)
* Derive-based config parsing via `keymap_derive`
* Backend-agnostic design with support for `crossterm`, `termion`, `web_sys`, etc.
* `Config<T>`: loads keys exclusively from config files
* `DerivedConfig<T>`: merges config and `#[key("..")]` annotations

Author: rezigned

.github/.release-please-manifest.json

@@ -0,0 +1,2 @@
+{
+}

.github/release-please-config.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "prerelease-type": "rc",
+  "prerelease": true,
+  "include-v-in-tag": true,
+  "packages": {
+    ".": {
+      "release-type": "rust",
+      "component": "keymap"
+    },
+    "keymap_derive": {
+      "release-type": "rust",
+      "component": "keymap_derive"
+    },
+    "keymap_parser": {
+      "release-type": "rust",
+      "component": "keymap_parser"
+    }
+  },
+  "plugins": [
+    {
+      "type": "cargo-workspace",
+      "merge": false
+    },
+    {
+      "type": "linked-versions",
+      "groupName": "crates",
+      "components": [
+        "keymap",
+        "keymap_derive",
+        "keymap_parser"
+      ]
+    }
+  ]
+}

.github/workflows/cd.yml

@@ -16,10 +16,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - uses: google-github-actions/release-please-action@v3
+      - uses: googleapis/release-please-action@v4
         id: release
         with:
-          release-type: rust
+          config-file: .github/release-please-config.json
+          manifest-file: .github/.release-please-manifest.json
 
     outputs:
       release_created: ${{ steps.release.outputs.release_created }}
@@ -35,9 +36,13 @@ jobs:
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
 
+      - name: Install cargo-workspaces
+        run: cargo install cargo-workspaces
+
       - name: Publish
         run: >
-          cargo publish
-          --verbose
+          cargo workspaces publish
+          --yes
           --locked
+          --from-git
           --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/ci.yml

@@ -18,4 +18,4 @@ jobs:
     - name: Build
       run: cargo build --verbose
     - name: Run tests
-      run: cargo test --verbose
+      run: cargo test --workspace --verbose

.gitignore

@@ -1,7 +1,9 @@
 /target
 Cargo.lock
 .DS_Store
+.vscode
 
 # Devenv
 .devenv*
 devenv.local.nix
+.env

CHANGELOG.md

@@ -1,29 +1,42 @@
 # Changelog
 
-## [0.4.1](https://github.com/rezigned/keymap-rs/compare/v0.4.0...v0.4.1) (2024-11-24)
+## [1.0.0](https://github.com/rezigned/keymap-rs/compare/v0.4.1...v1.0.0) (2025-06-08)
+
+### ⚠ BREAKING CHANGES
+
+* v1.0.0 release 🎉 ([#17](https://github.com/rezigned/keymap-rs/issues/17))
+
+### Features
 
+* v1.0.0 release 🎉 ([#17](https://github.com/rezigned/keymap-rs/issues/17)) ([8da2b52](https://github.com/rezigned/keymap-rs/commit/8da2b525ac0a628583bc8945a3eb74cd8a6c90dd))
+* **Declarative key mapping** via config files (`yaml`, `json`, `toml`, etc.)
+* **Support for key sequences** like `ctrl-b n`, `g g`, etc.
+* **Pattern-matching key groups** (`@upper`, `@any`, etc.)
+* **Derive-based config parsing** via `keymap_derive`
+* **Backend-agnostic** design with support for `crossterm`, `termion`, `web_sys`, etc.
+* `Config<T>`: loads keys exclusively from config files
+* `DerivedConfig<T>`: merges config and `#[key("..")]` annotations
+
+## [0.4.1](https://github.com/rezigned/keymap-rs/compare/v0.4.0...v0.4.1) (2024-11-24)
 
 ### Bug Fixes
 
 * update dependencies ([#12](https://github.com/rezigned/keymap-rs/issues/12)) ([2d0bfda](https://github.com/rezigned/keymap-rs/commit/2d0bfda90e3eff9c2b89079f1096f08de666b600))
 
 ## [0.4.0](https://github.com/rezigned/keymap-rs/compare/v0.3.0...v0.4.0) (2023-10-11)
 
-
 ### Features
 
 * Convert from Backend::Key to Node ([#10](https://github.com/rezigned/keymap-rs/issues/10)) ([2b46c7f](https://github.com/rezigned/keymap-rs/commit/2b46c7fe0fa4ec0f23555642c3f1464544cf59d4))
 
 ## [0.3.0](https://github.com/rezigned/keymap-rs/compare/v0.2.0...v0.3.0) (2023-09-24)
 
-
 ### Features
 
 * Expose 'parse' function ([#7](https://github.com/rezigned/keymap-rs/issues/7)) ([3180c28](https://github.com/rezigned/keymap-rs/commit/3180c28992f30de63a48b1d2647f99637e4d020d))
 
 ## [0.2.0](https://github.com/rezigned/keymap-rs/compare/v0.1.0...v0.2.0) (2023-08-01)
 
-
 ### Features
 
 * use char instead of u8 for parser's input to improve error message ([e1c1eb1](https://github.com/rezigned/keymap-rs/commit/e1c1eb1227443e86dbb3a806aee868ea14e9fe45))

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "keymap"
-description = "A library for parsing terminal input events from configuration"
+description = "A library for parsing input events from configuration"
 authors = ["Marut Khumtong <[email protected]>"]
-version = "0.4.1"
+version = "1.0.0"
 homepage = "https://github.com/rezigned/keymap-rs"
 repository = "https://github.com/rezigned/keymap-rs"
 edition = "2021"
@@ -12,16 +12,22 @@ license = "MIT"
 [lib]
 doctest = false
 
+[workspace]
+members = [
+    "keymap_derive",
+    "keymap_parser",
+]
+
 [dependencies]
+keymap_parser = { path = "./keymap_parser", version = "1.0.0" }
+keymap_derive = { path = "./keymap_derive", version = "1.0.0", optional = true }
 crossterm = { version = "0.29", optional = true }
 termion = { version = "4.0", optional = true }
-pom = "3.4.0"
 serde = { version = "1.0", features = ["derive"] }
-strum = "0.27"
-strum_macros = "0.27"
 
 [features]
-default = ["crossterm"]
+default = ["crossterm", "derive"]
+derive = ["dep:keymap_derive"]
 
 [dev-dependencies]
 toml = "0.8"
@@ -30,6 +36,26 @@ toml = "0.8"
 name = "crossterm"
 required-features = ["crossterm"]
 
+[[example]]
+name = "crossterm_derive"
+path = "examples/crossterm/derive.rs"
+required-features = ["crossterm", "derive"]
+
+[[example]]
+name = "crossterm_derived_config"
+path = "examples/crossterm/derived_config.rs"
+required-features = ["crossterm", "derive"]
+
 [[example]]
 name = "termion"
 required-features = ["termion"]
+
+[[example]]
+name = "termion_derive"
+path = "examples/termion/derive.rs"
+required-features = ["termion", "derive"]
+
+[[example]]
+name = "termion_derived_config"
+path = "examples/termion/derived_config.rs"
+required-features = ["termion", "derive"]