Blinter 1.0.2__py3-none-any.whl

blinter-1.0.2.dist-info/METADATA

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: Blinter
+Version: 1.0.2
+Summary: Blinter is a linter for Windows batch files. It provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues and style problems.
+Author-email: tboy1337 <check@my-website.com>
+Maintainer-email: tboy1337 <check@my-website.com>
+License: CRL
+Project-URL: Homepage, https://github.com/tboy1337/Blinter
+Project-URL: Documentation, https://github.com/tboy1337/Blinter
+Project-URL: Repository, https://github.com/tboy1337/Blinter.git
+Project-URL: Issues, https://github.com/tboy1337/Blinter/issues
+Keywords: lint,python,windows,analysis,script,linting,linter,static-analysis,static,batch,batch-file,cmd,batch-script,batchfile,bat,script-analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: Microsoft :: Windows
+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: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: System :: Systems Administration
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: chardet
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-html; extra == "dev"
+Requires-Dist: pytest-json-report; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+Requires-Dist: pytest-rerunfailures; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: autopep8; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# Blinter 🚀
+
+**Blinter** is a linter for Windows batch files (`.bat` and `.cmd`). It provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues and style problems. Blinter helps you write safer, more reliable and maintainable batch scripts. Even in 2025, batch files deserve professional tooling! 💻
+
+- ✅ **Configurable Options** - Configurable rules, logging, robust error handling
+- ✅ **Unicode Support** - Support for international characters and filenames
+- ✅ **Performance Optimized** - Handles large files (10MB+) efficiently
+
+## Features ✨
+
+### 🔍 **Rule Categories**
+- **114 Built-in Rules** across 5 severity levels
+- **Error Level (E001-E999)**: Critical syntax errors that prevent execution
+- **Warning Level (W001-W999)**: Potential runtime issues and bad practices
+- **Style Level (S001-S999)**: Code formatting and readability improvements
+- **Security Level (SEC001+)**: Security vulnerabilities and dangerous operations
+- **Performance Level (P001-P999)**: Optimization opportunities and efficiency improvements
+
+📖 **For complete rule descriptions with examples and implementation details, see [docs/Batch-File-Linter-Requirements.md](docs/Batch-File-Linter-Requirements.md)**
+
+### 📋 **Output Format**
+- **Rule Codes**: Each issue has a unique identifier (e.g., E002, W005, SEC003)
+- **Clear Explanations**: Detailed descriptions of why each issue matters
+- **Actionable Recommendations**: Specific guidance on how to fix problems
+- **Line-by-Line Analysis**: Precise location of every issue
+- **Context Information**: Additional details about detected problems
+
+### 🚀 **Advanced Analysis**
+- **Static Code Analysis**: Detects unreachable code and logic errors
+- **Advanced Variable Expansion**: Validates percent-tilde syntax (%~n1), string operations, and SET /A arithmetic
+- **Command-Specific Validation**: FOR loop variations, IF statement best practices, deprecated command detection
+- **Variable Tracking**: Identifies undefined variables and unsafe usage patterns
+- **Security Scanning**: Path traversal attacks, command injection risks, unsafe temp file creation
+- **Performance Optimization**: DIR flag optimization, unnecessary output detection, string operation efficiency
+- **Cross-Platform Compatibility**: Warns about Windows version issues and deprecated commands
+- **Large File Handling**: Efficiently processes files up to 10MB+ with performance warnings
+- **Robust Encoding Detection**: Handles UTF-8, UTF-16, Latin-1 and 6 more encoding formats
+
+## Installation 🛠️
+
+### Prerequisites
+- **Python 3.9+** (required)
+
+### Quick Install
+
+1. Clone the repository:
+```cmd
+git clone https://github.com/tboy1337/Blinter.git
+cd Blinter
+```
+
+2. (Optional) Create a virtual environment:
+```cmd
+python -m venv venv
+venv\Scripts\activate
+```
+
+3. (Optional but recommended) Install dependencies:
+```cmd
+pip install -r requirements.txt
+```
+
+## Usage 📟
+
+### Basic Usage
+
+```cmd
+# Analyze a single batch file
+python blinter.py script.bat
+
+# Analyze all batch files in a directory (recursive)
+python blinter.py /path/to/batch/files
+
+# Analyze batch files in directory only (non-recursive)
+python blinter.py /path/to/batch/files --no-recursive
+
+# Analyze with summary
+python blinter.py script.bat --summary
+
+# Get help
+python blinter.py --help
+```
+
+### Command Line Options
+
+- `<path>`: Path to a batch file (`.bat` or `.cmd`) OR directory containing batch files
+- `--summary`: Display summary statistics of issues found
+- `--severity`: Show detailed severity level breakdown (always included)
+- `--no-recursive`: When processing directories, only analyze files in the specified directory (not subdirectories)
+- `--help`: Show help menu and rule categories
+
+### 🐍 **Programmatic API Usage**
+
+Blinter provides a powerful Python API for integration into your applications:
+
+```python
+import blinter
+
+# Basic usage
+issues = blinter.lint_batch_file("script.bat")
+for issue in issues:
+    print(f"Line {issue.line_number}: {issue.rule.name} ({issue.rule.code})")
+    print(f"  {issue.rule.explanation}")
+    print(f"  Fix: {issue.rule.recommendation}")
+
+# Advanced configuration
+issues = blinter.lint_batch_file(
+    "script.bat",
+    max_line_length=100,           # Custom line length limit  
+    enable_style_rules=False,      # Disable style checks
+    enable_performance_rules=True  # Keep performance checks
+)
+
+# Thread-safe design allows safe concurrent usage
+# You can implement your own concurrent processing if needed
+from concurrent.futures import ThreadPoolExecutor
+
+files = ["script1.bat", "script2.cmd", "script3.bat"]
+with ThreadPoolExecutor(max_workers=4) as executor:
+    results = list(executor.map(blinter.lint_batch_file, files))
+```
+
+### 🔧 **Configuration Options**
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `file_path` | `str` | Required | Path to batch file to analyze |
+| `max_line_length` | `int` | `120` | Maximum line length for S011 rule |
+| `enable_style_rules` | `bool` | `True` | Enable/disable style-related rules |
+| `enable_performance_rules` | `bool` | `True` | Enable/disable performance rules |
+
+*Note: Security rules are always enabled for safety.*
+
+### Supported File Types
+- `.bat` files (traditional batch files)
+- `.cmd` files (recommended for modern Windows)
+- **Unicode filenames** and international characters supported
+- **Large files** (10MB+) handled efficiently with performance monitoring
+
+### 📁 **Directory Processing**
+
+Blinter can analyze entire directories of batch files with powerful options:
+
+- **Recursive Analysis**: Automatically finds and processes all `.bat` and `.cmd` files in directories and subdirectories
+- **Non-Recursive Mode**: Use `--no-recursive` to analyze only files in the specified directory
+- **Batch Processing**: Handles multiple files efficiently with consolidated reporting
+- **Error Resilience**: Continues processing other files even if some files have encoding or permission issues
+- **Progress Tracking**: Shows detailed results for each file plus combined summary statistics
+
+**Examples:**
+```cmd
+# Analyze all batch files in project directory and subdirectories
+python blinter.py ./my-batch-scripts
+
+# Analyze only batch files in current directory (no subdirectories)  
+python blinter.py . --no-recursive
+
+# Get combined summary for entire directory
+python blinter.py ./scripts --summary
+```
+
+## 🔥 **Integration Example**
+
+### CI/CD Integration
+```yaml
+# Example GitHub Actions workflow
+- name: Lint Batch Files
+  run: |
+    python -c "
+    import blinter
+    import sys
+    issues = blinter.lint_batch_file('deploy.bat')
+    errors = [i for i in issues if i.rule.severity.value == 'Error']
+    if errors:
+        print(f'Found {len(errors)} critical errors!')
+        sys.exit(1)
+    print(f'✅ Batch file passed with {len(issues)} total issues')
+    "
+```
+
+## Contributing 🤝
+
+**Contributions are welcome!** 
+
+### Ways to Contribute
+- 🐛 Report bugs or issues
+- 💡 Suggest new rules or features
+- 📖 Improve documentation
+- 🧪 Add test cases
+- 🔧 Submit bug fixes or enhancements
+
+## License 📄
+
+This project is licensed under the CRL License - see [LICENSE.md](./LICENSE.md) for details.

blinter-1.0.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+blinter.py,sha256=5rvlIkYNjYR9jVCQZi4M4UIkJpVmYnKFddmw9TQhI2E,158354
+blinter-1.0.2.dist-info/licenses/LICENSE.md,sha256=NYP65MjIOiBIzSEUIwUQw56lJYkP_7nGPFfgIgyl-iI,3035
+blinter-1.0.2.dist-info/METADATA,sha256=XZfzkjkBOLnQ571JuG9idb9Q46eErrSm32QxcCj1wFQ,9553
+blinter-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+blinter-1.0.2.dist-info/entry_points.txt,sha256=rkLMjl2Ejrf1wbd1Z7EYXekuaQohDVF-GC7GwM4LG4Y,41
+blinter-1.0.2.dist-info/top_level.txt,sha256=LCBquhrhgiIfOiECNjdsL1L0c5NMbk61N8GDq7Mu7Uo,8
+blinter-1.0.2.dist-info/RECORD,,

blinter-1.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

blinter-1.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+blinter = blinter:main

blinter-1.0.2.dist-info/licenses/LICENSE.md

@@ -0,0 +1,70 @@
+# Commercial Restricted License (CRL)
+
+**Version 1.1**
+
+**Copyright (c) 2025 tboy1337**
+
+## Grant of Rights
+
+Subject to the terms and conditions of this license, the copyright holder grants you a worldwide, royalty-free, non-exclusive license to use, copy, modify, and distribute this software and associated documentation files (the "Software") for **Non-Commercial Use** only.
+
+## Definitions
+
+**"Non-Commercial Use"** means use of the Software that is not primarily intended for or directed toward commercial advantage or monetary compensation. Non-Commercial Use includes:
+
+- Personal use, learning, and experimentation
+- Academic research and education
+- Open source projects that are not monetized
+- Internal evaluation within a commercial organization (limited to 30 days)
+- Use by registered non-profit organizations for their non-profit activities
+
+**"Commercial Use"** means any use of the Software that is primarily intended for or directed toward commercial advantage or monetary compensation, including but not limited to:
+
+- Use in any product or service that generates revenue
+- Use by for-profit organizations in their business operations
+- Integration into commercial software or services
+- Use in providing paid consulting, support, or services
+- Use in any business process that contributes to revenue generation
+- Use by organizations with annual revenue exceeding $100,000 USD
+
+**Note:** Any Commercial Use of the Software requires a separate commercial license from the copyright holder.
+
+## Conditions
+
+For Non-Commercial Use, you may:
+
+- Use, copy, and modify the Software
+- Distribute copies of the Software
+- Distribute your modifications under this same license
+
+You must:
+
+- Include this license notice in all copies or substantial portions of the Software
+- Not remove or alter any copyright notices
+
+## Restrictions
+
+You may not:
+
+- Use the Software for Commercial Use without a commercial license
+- Sublicense the Software under different terms
+- Use the Software in any way that violates applicable laws
+- Remove, obscure, or modify any licensing, copyright, or other legal notices
+
+## No Warranty
+
+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.
+
+## Termination
+
+This license terminates automatically if you violate any of its terms. Upon termination, you must cease all use and distribution of the Software and destroy all copies in your possession.
+
+## Governing Law
+
+This license shall be governed by and construed in accordance with the laws of the United Kingdom, without regard to its conflict of law provisions.

blinter-1.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+blinter