@ifi/oh-pi-skills 0.2.8 → 0.2.10

package/skills/rust-workspace-bootstrap/template/devenv.nix

@@ -0,0 +1,214 @@
+{
+  pkgs,
+  lib,
+  config,
+  inputs,
+  ...
+}:
+
+{
+  packages =
+    with pkgs;
+    [
+      cargo-binstall
+      cargo-run-bin
+      dprint
+      mdbook
+      nixfmt
+      rustup
+      shfmt
+    ]
+    ++ lib.optionals stdenv.isDarwin [
+      coreutils
+    ];
+
+  enterShell = ''
+    set -e
+    rustup toolchain install nightly --component rustfmt --no-self-update 2>/dev/null || true
+    rustup update stable --no-self-update 2>/dev/null || true
+  '';
+
+  # Disable dotenv hint since direnv interpolation is preferred.
+  dotenv.disableHint = true;
+
+  scripts = {
+    "__PROJECT_NAME__" = {
+      exec = ''
+        set -e
+        cargo run --quiet -p __CLI_CRATE__ -- $@
+      '';
+      description = "Run the __PROJECT_NAME__ CLI from source.";
+      binary = "bash";
+    };
+    "install:all" = {
+      exec = ''
+        set -e
+        install:cargo:bin
+      '';
+      description = "Install all local development binaries.";
+      binary = "bash";
+    };
+    "install:cargo:bin" = {
+      exec = ''
+        set -e
+        cargo bin --install
+      '';
+      description = "Install cargo binaries from [workspace.metadata.bin].";
+      binary = "bash";
+    };
+    "update:deps" = {
+      exec = ''
+        set -e
+        cargo update
+        devenv update
+      '';
+      description = "Update Cargo and Nix dependencies.";
+      binary = "bash";
+    };
+    "build:all" = {
+      exec = ''
+        set -e
+        if [ -z "$CI" ]; then
+          cargo build --workspace --all-features
+        else
+          cargo build --workspace --all-features --locked
+        fi
+      '';
+      description = "Build all crates with all features activated.";
+      binary = "bash";
+    };
+    "build:default" = {
+      exec = ''
+        set -e
+        cargo build --workspace --locked
+      '';
+      description = "Build workspace crates with default features.";
+      binary = "bash";
+    };
+    "test:all" = {
+      exec = ''
+        set -e
+        test:cargo
+        test:docs
+      '';
+      description = "Run all tests across workspace crates.";
+      binary = "bash";
+    };
+    "test:cargo" = {
+      exec = ''
+        set -e
+        cargo nextest run --workspace --all-features --locked
+      '';
+      description = "Run rust tests with cargo-nextest.";
+      binary = "bash";
+    };
+    "test:docs" = {
+      exec = ''
+        set -e
+        cargo test --workspace --doc --locked
+      '';
+      description = "Run Rust documentation tests.";
+      binary = "bash";
+    };
+    "coverage:all" = {
+      exec = ''
+        set -e
+        mkdir -p "$DEVENV_ROOT/target/coverage"
+        cargo llvm-cov nextest \
+          --workspace \
+          --all-features \
+          --locked \
+          --lcov \
+          --output-path "$DEVENV_ROOT/target/coverage/lcov.info"
+      '';
+      description = "Generate lcov coverage report for the whole workspace.";
+      binary = "bash";
+    };
+    "fix:all" = {
+      exec = ''
+        set -e
+        fix:clippy
+        fix:format
+      '';
+      description = "Apply all autofixable lint/format changes.";
+      binary = "bash";
+    };
+    "fix:format" = {
+      exec = ''
+        set -e
+        dprint fmt --config "$DEVENV_ROOT/dprint.json"
+      '';
+      description = "Format files with dprint.";
+      binary = "bash";
+    };
+    "fix:clippy" = {
+      exec = ''
+        set -e
+        cargo clippy --workspace --all-features --all-targets --fix --allow-dirty --allow-staged
+      '';
+      description = "Apply clippy autofixes for all workspace crates.";
+      binary = "bash";
+    };
+    "docs:build" = {
+      exec = ''
+        set -e
+        mdbook build "$DEVENV_ROOT/docs"
+      '';
+      description = "Build mdBook documentation.";
+      binary = "bash";
+    };
+    "verify:docs" = {
+      exec = ''
+        set -e
+        [ -f "$DEVENV_ROOT/docs/book.toml" ]
+        [ -f "$DEVENV_ROOT/docs/src/SUMMARY.md" ]
+        mdbook build "$DEVENV_ROOT/docs" -d "$DEVENV_ROOT/target/mdbook"
+      '';
+      description = "Validate docs layout and build mdBook.";
+      binary = "bash";
+    };
+    "deny:check" = {
+      exec = ''
+        set -e
+        cargo deny check
+      '';
+      description = "Run cargo-deny checks.";
+      binary = "bash";
+    };
+    "lint:all" = {
+      exec = ''
+        set -e
+        lint:clippy
+        lint:format
+        verify:docs
+        deny:check
+      '';
+      description = "Run all lint and quality gates.";
+      binary = "bash";
+    };
+    "lint:format" = {
+      exec = ''
+        set -e
+        dprint check
+      '';
+      description = "Check formatting with dprint.";
+      binary = "bash";
+    };
+    "lint:clippy" = {
+      exec = ''
+        set -e
+        cargo clippy --workspace --all-features --all-targets --locked
+      '';
+      description = "Run clippy checks across the workspace.";
+      binary = "bash";
+    };
+    "release:dry-run" = {
+      exec = ''
+        set -e
+        knope release --dry-run
+      '';
+      description = "Preview the next release without mutating files.";
+      binary = "bash";
+    };
+  };
+}

package/skills/rust-workspace-bootstrap/template/devenv.yaml

@@ -0,0 +1,10 @@
+# yaml-language-server: $schema=https://devenv.sh/devenv.schema.json
+inputs:
+  nixpkgs:
+    url: github:NixOS/nixpkgs/nixpkgs-unstable
+  rust-overlay:
+    url: github:oxalica/rust-overlay
+    overlays:
+      - default
+
+allowUnfree: true

package/skills/rust-workspace-bootstrap/template/docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["__GITHUB_OWNER__"]
+language = "en"
+multilingual = false
+src = "src"
+title = "__PROJECT_TITLE__"

package/skills/rust-workspace-bootstrap/template/docs/src/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [Introduction](./index.md)

package/skills/rust-workspace-bootstrap/template/docs/src/index.md

@@ -0,0 +1,3 @@
+# __PROJECT_TITLE__
+
+Welcome to the __PROJECT_NAME__ documentation.

package/skills/rust-workspace-bootstrap/template/dprint.json

@@ -0,0 +1,40 @@
+{
+	"incremental": true,
+	"indentWidth": 2,
+	"useTabs": true,
+	"exec": {
+		"commands": [
+			{
+				"command": "rustup run nightly rustfmt --unstable-features --edition 2024",
+				"exts": ["rs"]
+			},
+			{
+				"command": "nixfmt",
+				"exts": ["nix"]
+			},
+			{
+				"command": "shfmt --filename {{file_path}} -i 0",
+				"exts": ["sh", "bash"]
+			}
+		]
+	},
+	"toml": {
+		"useTabs": true,
+		"indentWidth": 2,
+		"cargo.applyConventions": true
+	},
+	"markdown": {
+		"textWrap": "never"
+	},
+	"excludes": [
+		".devenv/**",
+		"**/target",
+		".bin/",
+		"**/node_modules"
+	],
+	"plugins": [
+		"https://plugins.dprint.dev/markdown-0.20.0.wasm",
+		"https://plugins.dprint.dev/exec-0.6.0.json@a054130d458f124f9b5c91484833828950723a5af3f8ff2bd1523bd47b83b364",
+		"https://plugins.dprint.dev/toml-0.7.0.wasm"
+	]
+}

package/skills/rust-workspace-bootstrap/template/knope.toml

@@ -0,0 +1,73 @@
+[changes]
+ignore_conventional_commits = true
+
+[package]
+versioned_files = [
+	"Cargo.toml",
+	{ dependency = "__CORE_CRATE__", path = "Cargo.lock" },
+	{ dependency = "__CORE_CRATE__", path = "Cargo.toml" },
+	{ dependency = "__CLI_CRATE__", path = "Cargo.lock" },
+	{ dependency = "__CLI_CRATE__", path = "Cargo.toml" },
+]
+scopes = ["core", "cli"]
+changelog = "changelog.md"
+extra_changelog_sections = [
+	{ name = "Notes", types = ["note"] },
+	{ name = "Documentation", types = ["docs"] },
+]
+
+[[workflows]]
+name = "release"
+
+[[workflows.steps]]
+type = "PrepareRelease"
+
+[[workflows.steps]]
+type = "Command"
+command = "dprint fmt"
+
+[[workflows.steps]]
+type = "Command"
+command = "cargo check --workspace --locked"
+
+[[workflows.steps]]
+type = "Command"
+command = "git add --all"
+
+[[workflows.steps]]
+type = "Command"
+command = 'git commit -m "chore: prepare releases $version"'
+
+[[workflows.steps]]
+type = "Command"
+command = "git push"
+
+[[workflows.steps]]
+type = "Release"
+
+[[workflows]]
+name = "document-change"
+
+[[workflows.steps]]
+type = "CreateChangeFile"
+
+[[workflows.steps]]
+type = "Command"
+command = "dprint fmt .changeset/* --allow-no-files"
+
+[[workflows]]
+name = "forced-release"
+
+[[workflows.steps]]
+type = "Release"
+
+[[workflows]]
+name = "publish"
+
+[[workflows.steps]]
+type = "Command"
+command = "cargo publish --workspace"
+
+[github]
+owner = "__GITHUB_OWNER__"
+repo = "__GITHUB_REPO__"

package/skills/rust-workspace-bootstrap/template/readme.md

@@ -0,0 +1,77 @@
+# __PROJECT_TITLE__
+
+__DESCRIPTION__
+
+A Rust workspace starter inspired by the structure used in `mdt` and `pina`, with strong defaults for:
+
+- **knope changeset + release workflows**
+- **devenv/direnv reproducible environments**
+- **GitHub Actions CI, coverage, semver, and release assets**
+
+## Crate naming rule
+
+Use underscores (`_`) in crate names, not hyphens (`-`).
+
+## Workspace Layout
+
+```
+__PROJECT_NAME__/
+├── crates/
+│   ├── __CORE_CRATE__/    # shared library crate
+│   └── __CLI_CRATE__/     # CLI crate (binary name: __PROJECT_NAME__)
+├── .changeset/            # knope change files
+├── .github/
+│   ├── actions/devenv/
+│   └── workflows/
+├── docs/                  # mdBook docs source
+├── scripts/release.sh
+├── knope.toml
+├── devenv.nix
+└── Cargo.toml
+```
+
+## Quick Start
+
+```bash
+direnv allow
+# or: devenv shell
+
+install:cargo:bin
+build:all
+lint:all
+test:all
+```
+
+## Changesets
+
+Every change should include a change file:
+
+```bash
+knope document-change
+```
+
+Change types:
+
+- `major` — breaking changes
+- `minor` — new features
+- `patch` — fixes/docs/refactors
+
+## Release
+
+Dry run:
+
+```bash
+knope release --dry-run
+```
+
+Full local release:
+
+```bash
+./scripts/release.sh
+```
+
+Publish:
+
+```bash
+knope publish
+```

package/skills/rust-workspace-bootstrap/template/rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "1.93.1"
+components = ["rustfmt", "cargo", "clippy", "rust-analyzer", "llvm-tools"]
+profile = "default"

package/skills/rust-workspace-bootstrap/template/rustfmt.toml

@@ -0,0 +1,21 @@
+edition = "2024"
+style_edition = "2024"
+unstable_features = true
+condense_wildcard_suffixes = true
+force_multiline_blocks = true
+format_code_in_doc_comments = true
+format_macro_matchers = true
+format_strings = true
+group_imports = "StdExternalCrate"
+hard_tabs = true
+imports_granularity = "Item"
+imports_layout = "HorizontalVertical"
+indent_style = "Block"
+max_width = 100
+newline_style = "Unix"
+normalize_comments = true
+reorder_impl_items = true
+reorder_imports = true
+reorder_modules = true
+use_field_init_shorthand = true
+wrap_comments = false

package/skills/rust-workspace-bootstrap/template/scripts/release.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Local release helper for __PROJECT_NAME__
+#
+# Usage:
+#   ./scripts/release.sh
+#   ./scripts/release.sh --dry-run
+#
+# This script validates the workspace, then delegates versioning/tagging/changelog
+# orchestration to `knope release`.
+
+DRY_RUN=""
+if [[ "${1:-}" == "--dry-run" ]]; then
+  DRY_RUN="--dry-run"
+  echo "🏃 Dry run mode — no repository changes will be made"
+fi
+
+echo "📋 Checking prerequisites..."
+command -v knope >/dev/null 2>&1 || {
+  echo "❌ knope not found. Install with cargo-binstall or nix/devenv."
+  exit 1
+}
+command -v cargo >/dev/null 2>&1 || {
+  echo "❌ cargo not found."
+  exit 1
+}
+
+echo "📋 Checking working tree..."
+if [[ -n $(git status --porcelain) ]] && [[ -z "$DRY_RUN" ]]; then
+  echo "❌ Working tree is dirty. Commit or stash your changes first."
+  exit 1
+fi
+
+echo "📋 Checking for pending changesets..."
+CHANGESET_COUNT=$(find .changeset -name '*.md' ! -name 'README.md' 2>/dev/null | wc -l | tr -d ' ')
+if [[ "$CHANGESET_COUNT" -eq 0 ]]; then
+  echo "❌ No changesets found. Run 'knope document-change' first."
+  exit 1
+fi
+
+echo ""
+echo "🔍 Running quality checks..."
+if command -v devenv >/dev/null 2>&1; then
+  devenv shell -c -- bash -e -c 'lint:all && test:all && build:all'
+else
+  cargo clippy --workspace --all-features --all-targets --locked
+  cargo test --workspace --all-features --locked
+  cargo build --workspace --all-features --locked
+fi
+
+echo ""
+echo "🚀 Running knope release..."
+knope release $DRY_RUN
+
+echo ""
+if [[ -z "$DRY_RUN" ]]; then
+  echo "✅ Release complete"
+else
+  echo "✅ Dry run complete — no changes made"
+fi