linthis 0.0.10__tar.gz → 0.0.11__tar.gz

{linthis-0.0.10 → linthis-0.0.11}/.gitignore

@@ -45,3 +45,4 @@ Thumbs.db
 # Project
 .linthis/
 
+site/

linthis-0.0.11/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt

{linthis-0.0.10 → linthis-0.0.11}/Cargo.lock

@@ -1208,7 +1208,7 @@ dependencies = [
 
 [[package]]
 name = "linthis"
-version = "0.0.10"
+version = "0.0.11"
 dependencies = [
  "anyhow",
  "async-trait",

{linthis-0.0.10 → linthis-0.0.11}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "linthis"
-version = "0.0.10"
+version = "0.0.11"
 edition = "2021"
 authors = ["zhlinh"]
 description = "A fast, cross-platform multi-language linter and formatter"

{linthis-0.0.10 → linthis-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linthis
-Version: 0.0.10
+Version: 0.0.11
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers

linthis-0.0.11/docs/development/changelog.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Shell/Bash language support (ShellCheck + shfmt)
+- Ruby language support (RuboCop)
+- PHP language support (phpcs + php-cs-fixer)
+- Scala language support (scalafix + scalafmt)
+- C# language support (dotnet format)
+- Watch mode for continuous file monitoring
+- MkDocs documentation with Material theme
+
+### Changed
+
+- Improved error messages for missing tools
+
+### Fixed
+
+- Fixed file pattern matching on Windows
+
+## [0.0.10] - 2024-XX-XX
+
+### Added
+
+- Lua language support (luacheck + stylua)
+- Dart language support (dart analyze + dart format)
+- Plugin auto-sync feature
+- Self-update functionality
+- Configuration migration from ESLint, Prettier, Black
+
+### Changed
+
+- Improved parallel processing performance
+- Enhanced plugin caching mechanism
+
+### Fixed
+
+- Fixed gitignore pattern handling
+- Fixed staged file detection
+
+## [0.0.1] - 2024-XX-XX
+
+### Added
+
+- Initial release
+- Support for Rust, Python, TypeScript, JavaScript, Go, Java, C++, Swift, Kotlin, Objective-C
+- Plugin system
+- Git hooks integration
+- Format presets (Google, Airbnb, Standard)
+- Configuration management CLI
+- JSON and GitHub Actions output formats

linthis-0.0.11/docs/development/contributing.md

@@ -0,0 +1,132 @@
+# Contributing
+
+Thank you for your interest in contributing to linthis!
+
+## Getting Started
+
+### Prerequisites
+
+- Rust 1.75+ (stable)
+- Cargo
+
+### Clone and Build
+
+```bash
+git clone https://github.com/zhlinh/linthis.git
+cd linthis
+cargo build
+```
+
+### Run Tests
+
+```bash
+cargo test
+```
+
+### Run Clippy
+
+```bash
+cargo clippy
+```
+
+## Development Workflow
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-feature`
+3. Make your changes
+4. Run tests: `cargo test`
+5. Run clippy: `cargo clippy`
+6. Commit your changes: `git commit -m "feat: add my feature"`
+7. Push to your fork: `git push origin feature/my-feature`
+8. Open a Pull Request
+
+## Code Style
+
+- Follow Rust standard conventions
+- Use `rustfmt` for formatting
+- Use `clippy` for linting
+- Write tests for new features
+- Document public APIs
+
+## Commit Messages
+
+We follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat:` - New feature
+- `fix:` - Bug fix
+- `docs:` - Documentation changes
+- `refactor:` - Code refactoring
+- `test:` - Test changes
+- `chore:` - Build/tooling changes
+
+Examples:
+
+```
+feat(python): add support for mypy
+fix(cli): handle empty file list correctly
+docs: update installation instructions
+```
+
+## Adding Language Support
+
+To add support for a new language:
+
+1. Create checker in `src/checkers/<language>.rs`
+2. Create formatter in `src/formatters/<language>.rs`
+3. Add language variant to `Language` enum in `src/lib.rs`
+4. Update extension mappings
+5. Add install hints
+6. Write tests
+7. Create documentation in `docs/languages/<language>.md`
+
+See existing implementations for reference.
+
+## Project Structure
+
+```
+src/
+├── main.rs          # CLI entry point
+├── lib.rs           # Main library
+├── checkers/        # Language checkers
+├── formatters/      # Language formatters
+├── config/          # Configuration handling
+├── plugin/          # Plugin system
+├── cli/             # CLI commands
+└── utils/           # Utility functions
+```
+
+## Testing
+
+### Unit Tests
+
+```bash
+cargo test
+```
+
+### Integration Tests
+
+```bash
+cargo test --test integration
+```
+
+### Specific Test
+
+```bash
+cargo test test_name
+```
+
+## Documentation
+
+- Update docs in `docs/` directory
+- Use MkDocs for local preview: `mkdocs serve`
+- Keep README.md in sync with major changes
+
+## Questions?
+
+- Open an issue for bugs or feature requests
+- Start a discussion for questions
+- Check existing issues before creating new ones
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

linthis-0.0.11/docs/features/auto-sync.md

@@ -0,0 +1,226 @@
+# Plugin Auto-Sync
+
+## Overview
+
+linthis supports automatic plugin synchronization, inspired by oh-my-zsh's auto-update mechanism. This feature automatically checks and syncs plugin updates when running linthis, ensuring you always use the latest plugin configurations.
+
+## Features
+
+- **Configurable sync interval**: Customize how often to check for updates (default: 7 days)
+- **Multiple sync modes**:
+  - `auto`: Sync automatically without confirmation
+  - `prompt`: Ask user before syncing (default)
+  - `disabled`: Disable auto-sync
+- **Smart time tracking**: Uses Unix timestamps to avoid timezone issues
+- **Smart update detection**: Only prompts when actual updates are available
+- **Graceful user interaction**: Clear progress indicators and error handling
+
+## Configuration
+
+### Configuration File
+
+Add to `.linthis/config.toml` or `~/.linthis/config.toml`:
+
+```toml
+# Plugin settings
+[plugin]
+sources = [
+    { name = "myplugin", url = "https://github.com/your-org/myplugin.git", ref = "main" }
+]
+
+# Plugin auto-sync settings
+[plugin_auto_sync]
+enabled = true           # Enable auto-sync
+mode = "prompt"          # Sync mode: "auto", "prompt", "disabled"
+interval_days = 7        # Sync interval (days)
+```
+
+### Configuration Options
+
+#### `enabled`
+- **Type**: Boolean
+- **Default**: `true`
+- **Description**: Whether to enable auto-sync
+
+#### `mode`
+- **Type**: String
+- **Default**: `"prompt"`
+- **Options**:
+  - `"auto"`: Sync automatically without user confirmation
+  - `"prompt"`: Ask user before syncing
+  - `"disabled"`: Disable auto-sync
+
+#### `interval_days`
+- **Type**: Integer
+- **Default**: `7`
+- **Description**: Number of days between sync checks
+
+## How It Works
+
+### Time Tracking
+
+Auto-sync uses `~/.linthis/.plugin_sync_last_check` to store the timestamp (Unix epoch seconds) of the last sync.
+
+### Trigger
+
+Each time linthis runs, the system:
+1. Loads `plugin_auto_sync` settings from config
+2. Checks `~/.linthis/.plugin_sync_last_check` file
+3. Calculates time since last sync
+4. If interval exceeded, triggers sync flow
+
+### Sync Flow
+
+Based on configured `mode`:
+
+- **auto mode**:
+  1. Check all plugins for updates
+  2. If updates available, automatically start sync
+  3. Display sync progress
+  4. Update timestamp
+
+- **prompt mode**:
+  1. Check all plugins for updates
+  2. If updates available, prompt: `Updates available for plugins. Update now? [Y/n]:`
+  3. Wait for user input
+  4. If confirmed, execute sync
+  5. If declined or no updates, skip and update timestamp
+
+- **disabled mode**:
+  - Skip all checks
+
+## Examples
+
+### Example 1: Default (Prompt Mode)
+
+```toml
+[plugin_auto_sync]
+enabled = true
+mode = "prompt"
+interval_days = 7
+```
+
+When interval exceeded and updates available:
+```bash
+$ linthis
+Updates available for plugins. Update now? [Y/n]: y
+↓ Syncing project plugins...
+  ↓ myplugin... ✓ @ a1b2c3d
+✓ Synced 1 plugin(s), 1 updated
+```
+
+### Example 2: Auto Mode
+
+```toml
+[plugin_auto_sync]
+enabled = true
+mode = "auto"
+interval_days = 3
+```
+
+Auto-syncs every 3 days without confirmation:
+```bash
+$ linthis
+↓ Syncing project plugins...
+  ↓ myplugin... ✓ @ a1b2c3d
+✓ Synced 1 plugin(s), 1 updated
+```
+
+### Example 3: Disable Auto-Sync
+
+```toml
+[plugin_auto_sync]
+enabled = false
+```
+
+Or:
+
+```toml
+[plugin_auto_sync]
+mode = "disabled"
+```
+
+### Example 4: Manual Sync
+
+You can always manually sync regardless of auto-sync settings:
+
+```bash
+# Sync project plugins
+linthis plugin sync
+
+# Sync global plugins
+linthis plugin sync -g
+```
+
+## Comparison with oh-my-zsh
+
+| Feature | oh-my-zsh | linthis |
+|---------|-----------|---------|
+| Default interval | 13 days | 7 days |
+| Sync modes | auto, prompt, disabled | auto, prompt, disabled |
+| Time tracking | `~/.zsh-update` | `~/.linthis/.plugin_sync_last_check` |
+| Manual sync | `omz update` | `linthis plugin sync` |
+| Smart detection | No | Yes (only prompts when updates exist) |
+
+## Configuration Priority
+
+Configuration is loaded with the following priority (highest to lowest):
+1. Project config (`.linthis/config.toml`)
+2. Global config (`~/.linthis/config.toml`)
+3. Built-in defaults
+
+## Troubleshooting
+
+### Auto-sync not working
+
+**Checklist**:
+1. Confirm `plugin_auto_sync.enabled = true`
+2. Confirm `plugin_auto_sync.mode` is not `"disabled"`
+3. Check permissions on `~/.linthis/.plugin_sync_last_check`
+4. Check for error messages in output
+
+### Prompts too frequent
+
+**Solution**: Increase `interval_days`:
+```toml
+[plugin_auto_sync]
+interval_days = 14  # Change to 14 days
+```
+
+### Want to completely disable
+
+**Solution**:
+```toml
+[plugin_auto_sync]
+enabled = false
+```
+
+## Relationship with Self-Update
+
+linthis supports both:
+1. **Plugin Auto-Sync** (this feature): Sync plugins
+2. **Self Auto-Update**: Update linthis itself
+
+Both are configured and run independently:
+```toml
+# Sync plugins
+[plugin_auto_sync]
+enabled = true
+mode = "prompt"
+interval_days = 7
+
+# Update linthis itself
+[self_auto_update]
+enabled = true
+mode = "prompt"
+interval_days = 7
+```
+
+Execution order:
+1. Check for linthis self-update first
+2. Then check for plugin sync
+
+## References
+
+- [oh-my-zsh auto-update mechanism](https://maxchadwick.xyz/blog/a-look-at-auto-updating-in-oh-my-zsh)
+- [oh-my-zsh settings documentation](https://github.com/ohmyzsh/ohmyzsh/wiki/Settings)