ai-skill-lint 0.1.0__tar.gz

ai_skill_lint-0.1.0/.githooks/pre-commit

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+# Secret detection pre-commit hook for skill-lint
+# Blocks commits containing secrets, keys, tokens, or sensitive files.
+
+set -euo pipefail
+
+BLOCKED=0
+
+# --- Check 1: Sensitive file patterns ---
+set -f
+SENSITIVE_NAMES=".env .env.local .env.production credentials.json token.json .git-credentials .netrc .npmrc .pypirc kubeconfig terraform.tfvars"
+SENSITIVE_GLOBS="*.pem *.key *.p12 *.pfx *.jks *.asc *.secret *.secrets secrets.yaml secrets.json"
+SENSITIVE_SSH="id_rsa id_dsa id_ed25519 id_ecdsa"
+ALL_PATTERNS="$SENSITIVE_NAMES $SENSITIVE_GLOBS $SENSITIVE_SSH"
+
+while IFS= read -r file; do
+  [ -z "$file" ] && continue
+  base=$(basename "$file")
+  for pat in $ALL_PATTERNS; do
+    if [[ "$base" == $pat ]]; then
+      echo "BLOCKED: '$file' matches sensitive file pattern '$pat'"
+      BLOCKED=1
+    fi
+  done
+done < <(git diff --cached --name-only --diff-filter=ACM)
+set +f
+
+# --- Check 2: Content patterns in staged diffs ---
+CONTENT_PATTERNS=(
+  'AKIA[0-9A-Z]{16}'                          # AWS access key
+  'AIza[0-9A-Za-z_-]{35}'                     # Google API key
+  'ghp_[0-9a-zA-Z]{36}'                       # GitHub PAT
+  'gho_[0-9a-zA-Z]{36}'                       # GitHub OAuth
+  'github_pat_[0-9a-zA-Z_]{82}'               # GitHub fine-grained PAT
+  'glpat-[0-9a-zA-Z_-]{20}'                   # GitLab PAT
+  'sk-[0-9a-zA-Z]{48}'                        # OpenAI/Anthropic key
+  'xox[bpors]-[0-9a-zA-Z-]+'                  # Slack token
+  'ATATT[0-9a-zA-Z_/+=]{50,}'                 # Atlassian API token
+  '-----BEGIN (RSA |EC |DSA |OPENSSH )?PRIVATE KEY-----'
+  'password\s*[:=]\s*["\x27][^"\x27]{8,}'     # password assignments
+  'api[_-]?key\s*[:=]\s*["\x27][^"\x27]{16,}' # api key assignments
+  'bearer\s+[0-9a-zA-Z._~+/=-]{20,}'         # bearer tokens
+)
+
+STAGED_DIFF=$(git diff --cached -U0 --diff-filter=ACM 2>/dev/null || true)
+
+if [ -n "$STAGED_DIFF" ]; then
+  for pattern in "${CONTENT_PATTERNS[@]}"; do
+    matches=$(echo "$STAGED_DIFF" | grep -nE "^\+" | grep -iE "$pattern" 2>/dev/null || true)
+    if [ -n "$matches" ]; then
+      echo "BLOCKED: Staged diff matches secret pattern: $pattern"
+      echo "$matches" | head -3
+      BLOCKED=1
+    fi
+  done
+fi
+
+# --- Check 3: Large binary files (>1MB) ---
+while IFS= read -r file; do
+  [ -z "$file" ] && continue
+  if [ -f "$file" ]; then
+    size=$(wc -c < "$file" 2>/dev/null || echo 0)
+    if [ "$size" -gt 1048576 ]; then
+      echo "BLOCKED: '$file' is $(( size / 1024 ))KB — binary/large files should not be committed"
+      BLOCKED=1
+    fi
+  fi
+done < <(git diff --cached --name-only --diff-filter=ACM)
+
+# --- Result ---
+if [ "$BLOCKED" -eq 1 ]; then
+  echo ""
+  echo "Commit blocked by .githooks/pre-commit secret detection."
+  echo "If this is a false positive, use: git commit --no-verify"
+  exit 1
+fi
+
+exit 0

ai_skill_lint-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync --extra dev --python ${{ matrix.python-version }}
+      - run: uv run pytest -v
+      - run: uv run ruff check src/ tests/

ai_skill_lint-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

ai_skill_lint-0.1.0/.gitignore

@@ -0,0 +1,40 @@
+# Local reference docs (not committed)
+local-docs/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+.venv/
+
+# Build
+dist/
+build/
+
+# Environment
+.env
+.env.*
+!.env.example
+
+# OS
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Test & coverage
+.pytest_cache/
+.coverage
+htmlcov/
+coverage/
+
+# uv
+uv.lock
+
+# Logs
+*.log

ai_skill_lint-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: skill-lint
+  name: skill-lint
+  description: Lint AI skill files for quality issues
+  entry: skill-lint
+  language: python
+  pass_filenames: false
+  always_run: true

ai_skill_lint-0.1.0/CLAUDE.md

@@ -0,0 +1,23 @@
+# skill-lint
+
+Linter for AI instruction files (CLAUDE.md, AGENTS.md, GEMINI.md, SKILL.md, .cursorrules, .github/copilot-instructions.md).
+
+## Commands
+
+```bash
+uv sync --extra dev    # install deps
+uv run skill-lint .    # run linter
+uv run pytest -v       # run tests
+uv run ruff check src/ # lint
+```
+
+## Project Structure
+
+```
+src/skill_lint/
+├── cli.py              # CLI entry point (Click)
+└── scanner.py          # Scanner engine (40 rules across 8 categories)
+tests/
+├── test_scanner.py     # Scanner tests
+└── test_cli.py         # CLI tests
+```

ai_skill_lint-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to skill-lint
+
+## Getting Started
+
+```bash
+git clone https://github.com/rajusem/skill-lint.git
+cd skill-lint
+uv sync --extra dev
+uv run skill-lint .
+uv run pytest -v
+```
+
+## Development
+
+```bash
+make install     # Install deps
+make test        # Run tests
+make lint        # Run linter
+make scan        # Scan this project
+make help        # Show all targets
+```
+
+## Code Standards
+
+- Python 3.11+
+- `uv run ruff check src/ tests/` must pass before committing
+- All new rules need tests (positive + negative cases)
+- Follow existing rule ID conventions (TCOST, HRISK, FRAME, etc.)
+
+## Adding a New Rule
+
+1. Add check logic in the appropriate `_check_*` function in `scanner.py`
+2. Use an existing prefix (TCOST, STRUCT, DESC, HRISK, OQUAL, FRAME, BPRAC, CROSS) or CUSTOM_ for custom rules
+3. Add tests in `tests/test_scanner.py`
+4. Test against real repos to validate for false positives
+
+## Commits
+
+```bash
+git commit -s -m "Add HRISK006: detect XYZ pattern"
+```
+
+Always sign off with `-s`.
+
+## License
+
+[Apache-2.0](LICENSE)

ai_skill_lint-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ai_skill_lint-0.1.0/Makefile

@@ -0,0 +1,29 @@
+.PHONY: install dev test lint scan clean help
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+install: ## Install skill-lint (project-local)
+	uv sync --extra dev
+
+install-global: ## Install skill-lint globally
+	uv tool install -e . --force
+
+dev: install ## Install + run scan to verify setup
+	uv run skill-lint .
+
+test: ## Run all tests
+	uv run pytest -v
+
+lint: ## Run linter
+	uv run ruff check src/ tests/
+
+lint-fix: ## Auto-fix lint issues
+	uv run ruff check --fix src/ tests/
+
+scan: ## Scan this project's skill files
+	uv run skill-lint .
+
+clean: ## Remove build artifacts
+	rm -rf dist/ build/ *.egg-info .pytest_cache .ruff_cache
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true

ai_skill_lint-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: ai-skill-lint
+Version: 0.1.0
+Summary: Linter for AI instruction files — skills, prompts, and agent specs
+Project-URL: Homepage, https://github.com/rajusem/skill-lint
+Project-URL: Repository, https://github.com/rajusem/skill-lint
+Project-URL: Issues, https://github.com/rajusem/skill-lint/issues
+Author: Raj Zalavadia
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,claude,copilot,cursor,gemini,linter,prompts,skills
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# skill-lint
+
+Linter for AI instruction files — skills, prompts, and agent specs.
+
+skill-lint scans AI instruction files (CLAUDE.md, AGENTS.md, GEMINI.md, SKILL.md, .cursorrules, .github/copilot-instructions.md, .github/instructions/, and agent/skill directories) for issues that cause token waste, hallucination risk, and unpredictable agent behavior. 40 rules across 8 categories with fix suggestions.
+
+## Quick Start
+
+```bash
+pip install ai-skill-lint   # or: pipx install ai-skill-lint
+
+skill-lint .                                    # Scan current project
+skill-lint /path/to/project                     # Scan a local directory
+skill-lint https://github.com/org/repo          # Scan a GitHub repo
+skill-lint . --format sarif --fail-on warning   # CI gate
+skill-lint . -v                                 # Verbose
+```
+
+## What It Checks
+
+| Category | Rules | Examples |
+|----------|-------|---------|
+| Token cost | 11 | Oversized files, duplicates, filler phrases, hedging |
+| Description | 5 | Too long, missing trigger conditions |
+| Hallucination risk | 4 | Vague instructions, no output format, prompt injection risk |
+| Framing | 4 | Prohibition overuse, emphasis overuse, bare directives |
+| Output quality | 3 | No examples, no verification, no role statement |
+| Best practice | 5 | No model, no error handling, model-complexity mismatch |
+| Structure | 7 | Broken refs, encoding, file too large |
+| Cross-file | 1 | Contradictions between CLAUDE.md and skill files |
+
+Each file scored 0-100 with actionable fix suggestions.
+
+## CI Integration
+
+```yaml
+# GitHub Actions
+- run: pip install ai-skill-lint
+- run: skill-lint . --format sarif --fail-on warning > results.sarif
+- uses: github/codeql-action/upload-sarif@v3
+  with:
+    sarif_file: results.sarif
+```
+
+### pre-commit
+
+```yaml
+repos:
+  - repo: https://github.com/rajusem/skill-lint
+    rev: v0.1.0
+    hooks:
+      - id: skill-lint
+```
+
+### Baseline (incremental adoption)
+
+```bash
+skill-lint . --save-baseline   # Save current findings
+skill-lint . --diff            # Show only NEW issues
+```
+
+## Inline Suppression
+
+```markdown
+<!-- skill-lint: disable TCOST005 -->
+<!-- skill-lint: disable TCOST003, HRISK001 -->
+```
+
+## Configuration
+
+### Option 1: `.skill-lint.yaml`
+
+```yaml
+disable:
+  - HRISK002
+  - OQUAL001
+fail_on: warning
+```
+
+### Option 2: `pyproject.toml`
+
+```toml
+[tool.skill-lint]
+disable = ["HRISK002", "OQUAL001"]
+fail_on = "warning"
+```
+
+Precedence: CLI flags > `.skill-lint.yaml` > `pyproject.toml`
+
+## Custom Rules
+
+Write your own rules by extending the `Rule` base class:
+
+```python
+from skill_lint.scanner import Rule, Issue, register_rule
+
+class MyRule(Rule):
+    id = "CUSTOM_001"
+    description = "Check for company-specific patterns"
+
+    def check(self, ctx):
+        issues = []
+        if "legacy API" in ctx.content:
+            issues.append(Issue(
+                category="best-practice",
+                severity="suggestion",
+                message="References legacy API",
+                fix="Use the new v2 API instead",
+                rule_id=self.id,
+            ))
+        return issues
+
+register_rule(MyRule())
+```
+
+Custom rule IDs must use the `CUSTOM_` prefix. The `ctx` object provides: `content`, `lines`, `regions`, `filepath`, `root`, `tokens`, and `content_text` (code-fence-filtered).
+
+## Philosophy
+
+1. **Help, don't restrict** — every finding is a suggestion, not a gate
+2. **Show, don't enforce** — display impact, let users decide
+3. **Honest numbers** — no inflated claims; validated across 15+ repos
+
+## License
+
+[Apache-2.0](LICENSE)