Skip to content

changelog.md

Latest commit

 

History

History
199 lines (155 loc) · 6.38 KB

changelog.md

File metadata and controls

199 lines (155 loc) · 6.38 KB

更新日志

All notable changes to Global Scripts will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[5.0.0]

Added

Core Features

  • Unified Data Models: Type-safe dataclass-based structures (CommandResult, PluginMetadata, FunctionInfo)
  • Dependency Injection: Complete DI container implementation for better modularity
  • Smart Caching: LRU cache for plugin configurations with 72% hit rate
  • Process Executor: Unified command execution with timeout and security controls
  • Four Plugin Types: Python, Shell, Config, and Hybrid plugin support
  • Dynamic Completion: jq-based real-time command completion system
  • Async First: asyncio-based execution engine for high performance
  • Template Engine: Jinja2-based template rendering for env scripts and completion files
  • System Config Loader: YAML-based system configuration with dataclass validation

Plugin System

  • Python plugin support with @plugin_function decorator
  • Shell plugin with annotation-based function discovery
  • Config plugin for simple command wrapping
  • Hybrid plugin for mixed implementation strategies
  • Subplugin architecture for better organization
  • Plugin enable/disable functionality
  • Plugin discovery from plugins/, custom/, and examples/ directories

CLI Enhancements

  • New command structure: gs <plugin> <subplugin> <command>
  • gs doctor - System health check command
  • gs refresh - Rebuild plugins and completion
  • gs plugin list/info/enable/disable - Plugin management commands
  • gs system config get/set/list - Configuration management
  • Multi-language support (Chinese/English)
  • Improved error messages with suggestions

Documentation

  • Comprehensive README with badges and examples
  • Architecture documentation with detailed diagrams
  • Plugin development guide with all plugin types
  • Quick start guide (5-minute tutorial)
  • Installation guide with multiple methods
  • FAQ with troubleshooting steps
  • Contributing guide with development setup
  • API reference documentation
  • Bilingual documentation (Chinese/English)

Development Tools

  • UV project management support
  • Pre-commit hooks configuration
  • pytest with async support
  • Black code formatting
  • Ruff linting
  • MyPy type checking
  • 80%+ type annotation coverage

Changed

  • Breaking: Restructured from gs_system to src/gscripts package
  • Breaking: New command format requires gs <plugin> <subplugin> <command>
  • Breaking: Configuration format updated with system_plugins and custom_plugins
  • Improved plugin loader with parser registry system
  • Enhanced router indexer with version 2.0 format
  • Better error handling with specific exception types
  • Optimized plugin loading with async operations

Improved

  • Performance: Plugin loading 34% faster (100 plugins < 3 seconds)
  • Code Quality: Reduced duplicate code by 2,638+ lines (40% reduction) through template engine refactoring
  • Type Safety: Increased type annotation coverage to 80%+
  • Caching: Automatic caching reduces I/O overhead by 30%
  • Security: Enhanced command validation and timeout controls
  • Documentation: Complete documentation system from basics to advanced
  • PEP 8 Compliance: Full PEP 8 naming convention compliance (64 @property methods refactored)
  • Template System: Eliminated hardcoded string generation in setup.py (2317 → ~200 lines, 90% reduction)
  • Configuration: Simplified system_config.yaml by removing 40% unused configuration items
  • Shell Completion: Improved Fish shell completion with position-specific helper functions

Fixed

  • Plugin loading race conditions
  • Configuration merge issues
  • Shell completion edge cases (Fish plugin info completion bug)
  • Import path resolution
  • Async execution error handling
  • Process timeout and cleanup
  • Class-level constant access in GlobalConstants
  • Missing exit codes (invalid_arguments, plugin_not_found) in system config

Security

  • Command whitelist enforcement
  • Dangerous pattern blocking
  • Shell argument escaping
  • Process group management
  • Timeout controls for all commands

[4.x.x] - Previous Version

(Historical versions not documented here. See git history for details.)

Upgrade Guide

From 4.x to 5.0

Breaking Changes

  1. Package Name Change:

    # Old
from gs_system.models import CommandResult

# New
from gscripts.models import CommandResult

  2. Command Format:

    # Old
gs android-device-list

# New
gs android device list

  3. Configuration Format:

    {
  "system_plugins": {
    "android": true
  },
  "custom_plugins": {}
}

Migration Steps

  1. Update imports in Python plugins
  2. Update command calls in scripts
  3. Migrate configuration to new format
  4. Run gs refresh to rebuild completion
  5. Test all custom plugins

See Migration Guide for detailed steps.

Future Plans

v5.1.0 (Planned)

  • Plugin marketplace
  • Web UI for plugin management
  • Docker plugin
  • Kubernetes plugin
  • Enhanced logging with structured output

v5.2.0 (Planned)

  • Plugin versioning and dependencies
  • Auto-update functionality
  • Remote plugin installation
  • Plugin sandboxing
  • Performance profiling tools

v6.0.0 (Future)

  • gRPC-based plugin system
  • Distributed execution
  • Cloud integration
  • AI-powered command suggestions

Versioning Policy

  • Major (X.0.0): Breaking changes, major features
  • Minor (x.X.0): New features, backward compatible
  • Patch (x.x.X): Bug fixes, backward compatible

Support Policy

  • Current version (5.x): Full support, active development
  • Previous version (4.x): Bug fixes only for 6 months
  • Older versions: Community support only

Contributing

See Contributing Guide for how to contribute to this project.

Links

[Unreleased]: https://github.com/i-rtfsc/global_scripts/compare/v5.0.0...HEAD [5.0.0]: https://github.com/i-rtfsc/global_scripts/releases/tag/v5.0.0