promptlint-cli 1.0.0__tar.gz

promptlint_cli-1.0.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to PromptLint are documented here.  
+This project follows [Semantic Versioning](https://semver.org/).
+
+## 1.0.0 — 2026-03-09
+
+First public release.
+
+### Added
+- **`--version` / `-V`** flag.
+- **`--list-rules`** — tabular overview of every built-in rule with ID, category, severity, and fix support.
+- **`--explain RULE_ID`** — detailed description and examples for any rule.
+- **`--init`** — generate a starter `.promptlintrc` in the current directory.
+- **`--quiet` / `-q`** — suppress findings output; print only the summary line (ideal for CI).
+- **Positional file/glob arguments** — `promptlint prompts/**/*.txt` with optional `--exclude` patterns.
+- **Inline ignore comments** — add `# promptlint-disable rule-id` (or `# promptlint-disable` to suppress all) on any line.
+- **Summary line** — every run ends with "N file(s) scanned, X finding(s) in Ys".
+- **`python -m promptlint`** support via `__main__.py`.
+
+### Security
+- **Injection pattern validation** — invalid regex patterns in config are rejected at load time with a clear warning.
+- **Graceful regex errors at runtime** — bad patterns in `check_injection` and auto-fix won't crash; they're skipped with a stderr warning.
+- **Bounded stdin/file input** — inputs exceeding 10 MB are rejected to prevent memory exhaustion.
+- **Numeric config bounds** — `token_limit`, `cost_per_1k_tokens`, and `calls_per_day` are clamped to sane ranges.
+- **Quadratic regex fix** — replaced `[\s\S]*` JSON-detection regex in `quality.py` with an O(n) character check.
+- **Landing CSP** — `helmet` now enforces a `Content-Security-Policy` header instead of disabling it.
+- **Landing error leak** — Supabase error messages are no longer sent to the client.
+- **Landing rate limit** — `/api/signup-count` now has a 60-req/min rate limiter.
+
+### Changed
+- Version bumped from 0.1.0 to 1.0.0.
+- **Migrated from `setup.py` to `pyproject.toml`** with compatible-release (`~=`) dependency pins.
+- Removed unused `typer` dependency; CLI remains pure `argparse`.
+- **Comprehensive test suite** — 77 pytest tests covering config, rules, engine, CLI flags, auto-fix, and edge cases.
+
+### Rules (unchanged from 0.1.0)
+- `cost` — token count and cost estimate
+- `cost-limit` — token budget enforcement
+- `prompt-injection` — injection pattern detection (auto-fixable)
+- `structure-sections` — section structure verification (auto-fixable)
+- `clarity-vague-terms` — vague language detection
+- `specificity-examples` — missing example suggestion
+- `specificity-constraints` — missing constraint suggestion
+- `politeness-bloat` — politeness word detection (auto-fixable)
+- `verbosity-sentence-length` — long sentence detection
+- `verbosity-redundancy` — redundant phrase detection (auto-fixable)
+- `actionability-weak-verbs` — passive voice detection
+- `consistency-terminology` — mixed term detection
+- `completeness-edge-cases` — edge case reminder

promptlint_cli-1.0.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.

promptlint_cli-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+include CHANGELOG.md

promptlint_cli-1.0.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: promptlint-cli
+Version: 1.0.0
+Summary: A static analyzer for LLM prompts — catches cost waste, quality issues, and security risks.
+Author: Aryaan Sheth
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/AryaanSheth/promptlint
+Project-URL: Repository, https://github.com/AryaanSheth/promptlint
+Project-URL: Changelog, https://github.com/AryaanSheth/promptlint/blob/main/cli/CHANGELOG.md
+Keywords: llm,prompt,linter,static-analysis,prompt-injection,gpt,claude,ai
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+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
+Classifier: Topic :: Security
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: tiktoken~=0.5
+Requires-Dist: rich~=13.0
+Dynamic: license-file
+
+# PromptLint
+
+Static analysis for LLM prompts. Think ESLint, but for the text you send to GPT-4 / Claude / Gemini.
+
+Catches token waste, vague language, prompt injection, missing structure, and other issues that degrade prompt quality in production. Runs locally — no API calls, no round-trips, results in milliseconds.
+
+## Install
+
+```bash
+pip install promptlint-cli
+```
+
+Requires Python 3.9+.
+
+## Quick start
+
+```bash
+# lint a file
+promptlint --file prompt.txt
+
+# lint inline text
+promptlint -t "Please write some code for me"
+
+# multiple files with globs
+promptlint prompts/**/*.txt --exclude prompts/drafts/*
+
+# pipe from stdin
+cat prompt.txt | promptlint --format json
+
+# auto-fix what it can
+promptlint --file prompt.txt --fix
+
+# CI mode: exit 1 on warnings, only print the summary
+promptlint prompts/ --fail-level warn --quiet
+```
+
+Exit codes: `0` = clean, `1` = warnings found (with `--fail-level warn`), `2` = critical issues.
+
+## Example output
+
+```
+$ promptlint --file system_prompt.txt
+
+PromptLint Findings
+[ INFO     ] cost (line -) Prompt is ~38 tokens (~$0.0002 input per call on gpt-4o).
+[ WARN     ] structure-sections (line -) No explicit sections detected (Task/Context/Output).
+[ WARN     ] clarity-vague-terms (line 1) Vague term 'some' detected. Be more specific.
+[ CRITICAL ] prompt-injection (line 5) Injection pattern detected: 'ignore previous instructions'.
+
+1 file(s) scanned, 4 finding(s) in 0.41s
+```
+
+## What it checks
+
+| Rule | What it does | Fixable |
+|------|-------------|---------|
+| `cost` | Token count and per-call cost estimate | — |
+| `cost-limit` | Warns when prompt exceeds your token budget | — |
+| `prompt-injection` | Catches "ignore previous instructions" and similar | yes |
+| `structure-sections` | Flags prompts with no clear sections | yes |
+| `clarity-vague-terms` | Finds "some", "stuff", "maybe", "good", etc. | — |
+| `specificity-examples` | Suggests adding examples for complex instructions | — |
+| `specificity-constraints` | Suggests adding length/format/scope constraints | — |
+| `politeness-bloat` | Flags "please", "kindly", "thank you" (burns tokens) | yes |
+| `verbosity-sentence-length` | Flags sentences over 40 words | — |
+| `verbosity-redundancy` | "in order to" → "to", "due to the fact that" → "because" | yes |
+| `actionability-weak-verbs` | Flags excessive passive voice | — |
+| `consistency-terminology` | Catches mixed terms (user/customer, function/method) | — |
+| `completeness-edge-cases` | Reminds you to specify error handling | — |
+
+Run `promptlint --list-rules` to see them all, or `promptlint --explain cost` for details on any rule.
+
+## Auto-fix
+
+Pass `--fix` and PromptLint removes politeness filler, simplifies redundant phrases, strips injection lines, and scaffolds missing sections:
+
+```
+$ promptlint -t "Please kindly write code in order to sort the array, thank you" --fix
+
+Optimized Prompt
+<task>Write code to sort the array.</task>
+```
+
+## Configuration
+
+Drop a `.promptlintrc` in your repo root (or run `promptlint --init` to generate one):
+
+```yaml
+model: gpt-4o
+token_limit: 800
+cost_per_1k_tokens: 0.005
+calls_per_day: 10000
+
+rules:
+  cost:
+    enabled: true
+  prompt_injection:
+    enabled: true
+    patterns:
+      - ignore previous instructions
+      - system prompt extraction
+  politeness_bloat:
+    enabled: true
+    words: [please, kindly, thank you, i would appreciate]
+  structure_sections:
+    enabled: true
+
+fix:
+  enabled: true
+  prompt_injection: true
+  politeness_bloat: true
+  verbosity_redundancy: true
+  structure_scaffold: true
+```
+
+## CLI reference
+
+```
+promptlint [FILES...] [OPTIONS]
+
+  -V, --version            Show version
+  -f, --file PATH          Single prompt file
+  -t, --text TEXT          Inline prompt text
+  -c, --config PATH        Config file (default: .promptlintrc)
+  --format {text,json}     Output format
+  --fix                    Auto-fix and print optimized prompt
+  --fail-level LEVEL       none / warn / critical (default: critical)
+  --show-dashboard         Token savings breakdown
+  -q, --quiet              Summary line only (for CI)
+  --exclude PATTERN        Exclude globs (repeatable)
+  --list-rules             Show all rules
+  --explain RULE_ID        Explain a specific rule
+  --init                   Generate starter .promptlintrc
+```
+
+## Links
+
+- [GitHub](https://github.com/AryaanSheth/promptlint)
+- [Changelog](https://github.com/AryaanSheth/promptlint/blob/main/cli/CHANGELOG.md)
+
+## License
+
+[Apache 2.0](https://github.com/AryaanSheth/promptlint/blob/main/LICENSE)

promptlint_cli-1.0.0/README.md

@@ -0,0 +1,143 @@
+# PromptLint
+
+Static analysis for LLM prompts. Think ESLint, but for the text you send to GPT-4 / Claude / Gemini.
+
+Catches token waste, vague language, prompt injection, missing structure, and other issues that degrade prompt quality in production. Runs locally — no API calls, no round-trips, results in milliseconds.
+
+## Install
+
+```bash
+pip install promptlint-cli
+```
+
+Requires Python 3.9+.
+
+## Quick start
+
+```bash
+# lint a file
+promptlint --file prompt.txt
+
+# lint inline text
+promptlint -t "Please write some code for me"
+
+# multiple files with globs
+promptlint prompts/**/*.txt --exclude prompts/drafts/*
+
+# pipe from stdin
+cat prompt.txt | promptlint --format json
+
+# auto-fix what it can
+promptlint --file prompt.txt --fix
+
+# CI mode: exit 1 on warnings, only print the summary
+promptlint prompts/ --fail-level warn --quiet
+```
+
+Exit codes: `0` = clean, `1` = warnings found (with `--fail-level warn`), `2` = critical issues.
+
+## Example output
+
+```
+$ promptlint --file system_prompt.txt
+
+PromptLint Findings
+[ INFO     ] cost (line -) Prompt is ~38 tokens (~$0.0002 input per call on gpt-4o).
+[ WARN     ] structure-sections (line -) No explicit sections detected (Task/Context/Output).
+[ WARN     ] clarity-vague-terms (line 1) Vague term 'some' detected. Be more specific.
+[ CRITICAL ] prompt-injection (line 5) Injection pattern detected: 'ignore previous instructions'.
+
+1 file(s) scanned, 4 finding(s) in 0.41s
+```
+
+## What it checks
+
+| Rule | What it does | Fixable |
+|------|-------------|---------|
+| `cost` | Token count and per-call cost estimate | — |
+| `cost-limit` | Warns when prompt exceeds your token budget | — |
+| `prompt-injection` | Catches "ignore previous instructions" and similar | yes |
+| `structure-sections` | Flags prompts with no clear sections | yes |
+| `clarity-vague-terms` | Finds "some", "stuff", "maybe", "good", etc. | — |
+| `specificity-examples` | Suggests adding examples for complex instructions | — |
+| `specificity-constraints` | Suggests adding length/format/scope constraints | — |
+| `politeness-bloat` | Flags "please", "kindly", "thank you" (burns tokens) | yes |
+| `verbosity-sentence-length` | Flags sentences over 40 words | — |
+| `verbosity-redundancy` | "in order to" → "to", "due to the fact that" → "because" | yes |
+| `actionability-weak-verbs` | Flags excessive passive voice | — |
+| `consistency-terminology` | Catches mixed terms (user/customer, function/method) | — |
+| `completeness-edge-cases` | Reminds you to specify error handling | — |
+
+Run `promptlint --list-rules` to see them all, or `promptlint --explain cost` for details on any rule.
+
+## Auto-fix
+
+Pass `--fix` and PromptLint removes politeness filler, simplifies redundant phrases, strips injection lines, and scaffolds missing sections:
+
+```
+$ promptlint -t "Please kindly write code in order to sort the array, thank you" --fix
+
+Optimized Prompt
+<task>Write code to sort the array.</task>
+```
+
+## Configuration
+
+Drop a `.promptlintrc` in your repo root (or run `promptlint --init` to generate one):
+
+```yaml
+model: gpt-4o
+token_limit: 800
+cost_per_1k_tokens: 0.005
+calls_per_day: 10000
+
+rules:
+  cost:
+    enabled: true
+  prompt_injection:
+    enabled: true
+    patterns:
+      - ignore previous instructions
+      - system prompt extraction
+  politeness_bloat:
+    enabled: true
+    words: [please, kindly, thank you, i would appreciate]
+  structure_sections:
+    enabled: true
+
+fix:
+  enabled: true
+  prompt_injection: true
+  politeness_bloat: true
+  verbosity_redundancy: true
+  structure_scaffold: true
+```
+
+## CLI reference
+
+```
+promptlint [FILES...] [OPTIONS]
+
+  -V, --version            Show version
+  -f, --file PATH          Single prompt file
+  -t, --text TEXT          Inline prompt text
+  -c, --config PATH        Config file (default: .promptlintrc)
+  --format {text,json}     Output format
+  --fix                    Auto-fix and print optimized prompt
+  --fail-level LEVEL       none / warn / critical (default: critical)
+  --show-dashboard         Token savings breakdown
+  -q, --quiet              Summary line only (for CI)
+  --exclude PATTERN        Exclude globs (repeatable)
+  --list-rules             Show all rules
+  --explain RULE_ID        Explain a specific rule
+  --init                   Generate starter .promptlintrc
+```
+
+## Links
+
+- [GitHub](https://github.com/AryaanSheth/promptlint)
+- [Changelog](https://github.com/AryaanSheth/promptlint/blob/main/cli/CHANGELOG.md)
+
+## License
+
+[Apache 2.0](https://github.com/AryaanSheth/promptlint/blob/main/LICENSE)

promptlint_cli-1.0.0/promptlint/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "1.0.0"

promptlint_cli-1.0.0/promptlint/__main__.py

@@ -0,0 +1,5 @@
+"""Allow ``python -m promptlint``."""
+
+from .cli import main
+
+main()