linthis 0.2.0__tar.gz → 0.3.0__tar.gz

{linthis-0.2.0 → linthis-0.3.0}/Cargo.lock

@@ -1330,7 +1330,7 @@ dependencies = [
 
 [[package]]
 name = "linthis"
-version = "0.2.0"
+version = "0.3.0"
 dependencies = [
  "anyhow",
  "async-trait",

{linthis-0.2.0 → linthis-0.3.0}/Cargo.toml

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

{linthis-0.2.0 → linthis-0.3.0}/PKG-INFO

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

linthis-0.3.0/jetbrains-linthis/README.md

@@ -0,0 +1,219 @@
+# Linthis for JetBrains IDEs
+
+Multi-language linter and formatter plugin for JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, GoLand, CLion, etc.).
+
+## Features
+
+- **Real-time Diagnostics**: See linting issues as you type
+- **Format on Save**: Automatically format code when saving files
+- **Multi-language Support**: 18+ programming languages supported
+- **Quick Fixes**: Apply suggestions from linters
+- **Configurable**: Customize via `.linthis.toml`
+
+## Supported Languages
+
+| Language              | Linter        | Formatter          |
+| --------------------- | ------------- | ------------------ |
+| Rust                  | clippy        | rustfmt            |
+| Python                | ruff          | ruff/black         |
+| TypeScript/JavaScript | ESLint        | Prettier           |
+| Go                    | golangci-lint | gofmt              |
+| Java                  | checkstyle    | google-java-format |
+| C/C++                 | clang-tidy    | clang-format       |
+| Objective-C           | clang-tidy    | clang-format       |
+| Swift                 | SwiftLint     | swift-format       |
+| Kotlin                | detekt        | ktlint             |
+| Lua                   | luacheck      | stylua             |
+| Dart                  | dart analyze  | dart format        |
+| Shell/Bash            | shellcheck    | shfmt              |
+| Ruby                  | rubocop       | rubocop            |
+| PHP                   | phpcs         | php-cs-fixer       |
+| Scala                 | scalafix      | scalafmt           |
+| C#                    | dotnet format | dotnet format      |
+| And more...           |               |                    |
+
+## Requirements
+
+### 1. Install Linthis CLI
+
+```bash
+# Using pip
+pip install linthis
+# Or use uv (recommended)
+uv pip install 
+
+# Or using cargo
+cargo install linthis
+```
+
+### 2. Install LSP4IJ Plugin
+
+This plugin requires the [LSP4IJ](https://plugins.jetbrains.com/plugin/23257-lsp4ij) plugin for Language Server Protocol support.
+
+Install from JetBrains Marketplace:
+
+1. Open Settings/Preferences → Plugins
+2. Search for "LSP4IJ"
+3. Click Install
+
+### 3. Install Linthis Plugin
+
+#### From JetBrains Marketplace (Coming Soon)
+
+1. Open Settings/Preferences → Plugins
+2. Search for "Linthis"
+3. Click Install
+
+#### From Local Build
+
+1. Build the plugin: `./gradlew buildPlugin`
+2. Install from disk: Settings → Plugins → ⚙️ → Install Plugin from Disk
+3. Select `build/distributions/jetbrains-linthis-*.zip`
+
+## Configuration
+
+Create a `.linthis.toml` file in your project root:
+
+```toml
+[global]
+# Enabled languages
+enabled_languages = ["rust", "python", "typescript"]
+
+# Format on save
+format_on_save = true
+
+# Cache settings
+cache_enabled = true
+
+[python]
+# Python-specific settings
+lint_tool = "ruff"
+format_tool = "ruff"
+
+[rust]
+# Rust-specific settings
+lint_tool = "clippy"
+format_tool = "rustfmt"
+```
+
+## Usage
+
+### Quick Start
+
+1. **Install prerequisites** (LSP4IJ plugin + Linthis CLI)
+2. **Install Linthis plugin**
+3. **Open a supported file** - The LSP server starts automatically
+4. **View diagnostics** - Issues appear in editor gutter and Problems view
+
+### Automatic Features
+
+Once installed, the plugin will automatically:
+
+- **Start the LSP server** when you open a supported file
+- **Show diagnostics** in the editor gutter and Problems view
+- **Format on save** (if enabled in settings)
+- **Lint on file open** (if enabled in settings)
+
+### Menu Actions
+
+Access linting and formatting actions from **Tools → Linthis**:
+
+![Tools Menu](docs/images/tools-menu.png)
+
+| Action                  | Description                                           |
+| ----------------------- | ----------------------------------------------------- |
+| **Lint Current File**   | Manually trigger linting on the active file           |
+| **Format Current File** | Format the active file using the configured formatter |
+
+Additional menu actions:
+
+- **Code → Reformat Code**: Also triggers LSP-based formatting
+- **View → Tool Windows → Problems**: Show all diagnostics
+
+### Plugin Settings
+
+Configure Linthis in **Settings/Preferences → Tools → Linthis**:
+
+![Settings](docs/images/settings.png)
+
+| Setting              | Default | Description                       |
+| -------------------- | ------- | --------------------------------- |
+| Lint on file open    | On      | Run linter when opening a file    |
+| Lint on save         | On      | Run linter when saving a file     |
+| Format on save       | Off     | Auto-format file when saving      |
+| Linthis path         | (auto)  | Custom path to linthis executable |
+| Additional arguments | (empty) | Extra arguments passed to linthis |
+
+### Keyboard Shortcuts
+
+To configure shortcuts:
+
+1. Open **Settings/Preferences → Keymap**
+2. Search for "Linthis"
+3. Right-click on an action and select "Add Keyboard Shortcut"
+
+Suggested shortcuts (not set by default to avoid conflicts):
+
+- Lint Current File: `Ctrl+Shift+;` / `Cmd+Shift+;`
+- Format Current File: `Ctrl+Shift+'` / `Cmd+Shift+'`
+
+### Viewing Diagnostics
+
+Linting issues are displayed in multiple places:
+
+1. **Editor Gutter** - Icons indicate warnings/errors on specific lines
+2. **Problems Tool Window** - View → Tool Windows → Problems
+3. **Inline Highlights** - Underlines in the code editor
+4. **Hover Tooltips** - Hover over highlighted code to see details
+
+### LSP Server Status
+
+Check the Language Server status at **View → Tool Windows → Language Servers**. You can:
+
+- See if Linthis server is running
+- View server logs
+- Restart the server if needed
+
+## Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/zhlinh/linthis.git
+cd linthis/jetbrains-linthis
+
+# Build the plugin
+./gradlew buildPlugin
+
+# Run in a sandbox IDE for testing
+./gradlew runIde
+```
+
+## Troubleshooting
+
+### Linthis not found
+
+If you see "Linthis not found" notification:
+
+1. Verify linthis is installed: `linthis --version`
+2. Ensure linthis is in your PATH
+3. Restart the IDE
+
+### No diagnostics showing
+
+1. Check if the file type is supported
+2. Verify `.linthis.toml` configuration
+3. View → Tool Windows → Language Servers to check server status
+
+### LSP server not starting
+
+1. Open Help → Diagnostic Tools → Debug Log Settings
+2. Add `#com.linthis` to enable debug logging
+3. Check idea.log for errors
+
+## License
+
+MIT License - see [LICENSE](../LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please see the [main repository](https://github.com/zhlinh/linthis) for guidelines.

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "com.mojeter.linthis"
-version = "0.1.0"
+version = "0.2.0"
 
 repositories {
     mavenCentral()

linthis-0.3.0/jetbrains-linthis/scripts/publish.sh

@@ -0,0 +1,245 @@
+#!/bin/bash
+# Copyright 2024 zhlinh and linthis Project Authors. All rights reserved.
+# Use of this source code is governed by a MIT-style license.
+#
+# Publish linthis plugin to JetBrains Marketplace
+#
+# Prerequisites:
+#   1. JDK 17+ installed
+#   2. JETBRAINS_MARKETPLACE_TOKEN environment variable set
+#      Get token from: https://plugins.jetbrains.com/author/me/tokens
+#
+# For signed releases, also set:
+#   - CERTIFICATE_CHAIN: Plugin signing certificate chain
+#   - PRIVATE_KEY: Plugin signing private key
+#   - PRIVATE_KEY_PASSWORD: Private key password
+#
+# Usage:
+#   ./scripts/publish.sh                    # Build, sign, and publish
+#   ./scripts/publish.sh --patch            # Bump patch version, commit, push, then publish
+#   ./scripts/publish.sh --minor            # Bump minor version, commit, push, then publish
+#   ./scripts/publish.sh --major            # Bump major version, commit, push, then publish
+#   ./scripts/publish.sh --patch --build    # Bump version and build only (no publish)
+#   ./scripts/publish.sh --build            # Build only (no version bump, no publish)
+#   ./scripts/publish.sh --dry-run          # Build and sign, but don't publish
+
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
+
+cd "$PROJECT_DIR"
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+log_info() {
+    echo -e "${GREEN}[INFO]${NC} $1"
+}
+
+log_warn() {
+    echo -e "${YELLOW}[WARN]${NC} $1"
+}
+
+log_error() {
+    echo -e "${RED}[ERROR]${NC} $1"
+}
+
+# Get current version from build.gradle.kts
+get_current_version() {
+    grep 'version = ' build.gradle.kts | head -1 | sed 's/.*"\(.*\)".*/\1/'
+}
+
+# Bump version based on type
+bump_version() {
+    local current="$1"
+    local bump_type="$2"
+
+    IFS='.' read -r major minor patch <<< "$current"
+
+    case "$bump_type" in
+        --major)
+            echo "$((major + 1)).0.0"
+            ;;
+        --minor)
+            echo "${major}.$((minor + 1)).0"
+            ;;
+        --patch)
+            echo "${major}.${minor}.$((patch + 1))"
+            ;;
+        *)
+            echo "$current"
+            ;;
+    esac
+}
+
+# Update version in build.gradle.kts
+update_version() {
+    local old_version="$1"
+    local new_version="$2"
+
+    if [[ "$OSTYPE" == "darwin"* ]]; then
+        sed -i '' "s/version = \"$old_version\"/version = \"$new_version\"/" build.gradle.kts
+    else
+        sed -i "s/version = \"$old_version\"/version = \"$new_version\"/" build.gradle.kts
+    fi
+    log_info "Updated build.gradle.kts: $old_version -> $new_version"
+}
+
+# Parse arguments
+BUILD_ONLY=false
+DRY_RUN=false
+BUMP_TYPE=""
+
+for arg in "$@"; do
+    case $arg in
+        --patch|--minor|--major)
+            BUMP_TYPE="$arg"
+            ;;
+        --build)
+            BUILD_ONLY=true
+            ;;
+        --dry-run)
+            DRY_RUN=true
+            ;;
+        --help|-h)
+            echo "Usage: $0 [OPTIONS]"
+            echo ""
+            echo "Version bump options:"
+            echo "  --patch     Bump patch version (0.1.0 -> 0.1.1)"
+            echo "  --minor     Bump minor version (0.1.0 -> 0.2.0)"
+            echo "  --major     Bump major version (0.1.0 -> 1.0.0)"
+            echo ""
+            echo "Build options:"
+            echo "  --build     Build only (no publish)"
+            echo "  --dry-run   Build and sign, but don't publish"
+            echo "  --help, -h  Show this help message"
+            echo ""
+            echo "Examples:"
+            echo "  $0                    # Build and publish current version"
+            echo "  $0 --patch            # Bump patch, commit, push, then publish"
+            echo "  $0 --minor --build    # Bump minor, commit, push, build only"
+            echo "  $0 --build            # Build current version only"
+            echo ""
+            echo "Environment variables:"
+            echo "  JETBRAINS_MARKETPLACE_TOKEN  Required for publishing"
+            echo "  CERTIFICATE_CHAIN            Optional: for signed releases"
+            echo "  PRIVATE_KEY                  Optional: for signed releases"
+            echo "  PRIVATE_KEY_PASSWORD         Optional: for signed releases"
+            echo ""
+            echo "Current version: $(get_current_version)"
+            exit 0
+            ;;
+        *)
+            log_error "Unknown option: $arg"
+            exit 1
+            ;;
+    esac
+done
+
+# Check prerequisites
+log_info "Checking prerequisites..."
+
+if ! command -v java &> /dev/null; then
+    log_error "Java is not installed. Please install JDK 17+."
+    exit 1
+fi
+
+JAVA_VERSION=$(java -version 2>&1 | head -n 1 | cut -d'"' -f2 | cut -d'.' -f1)
+if [ "$JAVA_VERSION" -lt 17 ]; then
+    log_error "Java 17+ is required. Current version: $JAVA_VERSION"
+    exit 1
+fi
+
+log_info "Java version: $(java -version 2>&1 | head -n 1)"
+
+# Handle version bump if requested
+CURRENT_VERSION=$(get_current_version)
+
+if [ -n "$BUMP_TYPE" ]; then
+    NEW_VERSION=$(bump_version "$CURRENT_VERSION" "$BUMP_TYPE")
+
+    if [ "$CURRENT_VERSION" == "$NEW_VERSION" ]; then
+        log_warn "Version is already $CURRENT_VERSION"
+    else
+        log_info "Bumping version: $CURRENT_VERSION -> $NEW_VERSION"
+        update_version "$CURRENT_VERSION" "$NEW_VERSION"
+
+        # Commit and push the version bump
+        log_info "Committing version bump..."
+        git add build.gradle.kts
+        git commit -m "chore(jetbrains-linthis): bump version to $NEW_VERSION"
+
+        log_info "Pushing to remote..."
+        git push
+
+        log_info "Version bump committed and pushed!"
+        CURRENT_VERSION="$NEW_VERSION"
+    fi
+fi
+
+VERSION="$CURRENT_VERSION"
+log_info "Plugin version: $VERSION"
+
+# Clean previous builds
+log_info "Cleaning previous builds..."
+./gradlew clean
+
+# Build the plugin
+log_info "Building plugin..."
+./gradlew buildPlugin
+
+# Verify build output
+BUILD_OUTPUT="build/distributions"
+if [ ! -d "$BUILD_OUTPUT" ]; then
+    log_error "Build output directory not found: $BUILD_OUTPUT"
+    exit 1
+fi
+
+ZIP_FILE=$(ls "$BUILD_OUTPUT"/*.zip 2>/dev/null | head -1)
+if [ -z "$ZIP_FILE" ]; then
+    log_error "No plugin ZIP file found in $BUILD_OUTPUT"
+    exit 1
+fi
+
+log_info "Built: $ZIP_FILE"
+
+if [ "$BUILD_ONLY" = true ]; then
+    log_info "Build completed (--build flag specified, skipping publish)"
+    exit 0
+fi
+
+# Sign the plugin (if credentials are available)
+if [ -n "$CERTIFICATE_CHAIN" ] && [ -n "$PRIVATE_KEY" ]; then
+    log_info "Signing plugin..."
+    ./gradlew signPlugin
+
+    SIGNED_FILE=$(ls "$BUILD_OUTPUT"/*-signed.zip 2>/dev/null | head -1)
+    if [ -n "$SIGNED_FILE" ]; then
+        log_info "Signed: $SIGNED_FILE"
+    fi
+else
+    log_warn "Signing credentials not found. Plugin will be unsigned."
+    log_warn "Set CERTIFICATE_CHAIN, PRIVATE_KEY, and PRIVATE_KEY_PASSWORD for signed releases."
+fi
+
+if [ "$DRY_RUN" = true ]; then
+    log_info "Dry run completed (--dry-run flag specified, skipping publish)"
+    exit 0
+fi
+
+# Publish to JetBrains Marketplace
+if [ -z "$JETBRAINS_MARKETPLACE_TOKEN" ]; then
+    log_error "JETBRAINS_MARKETPLACE_TOKEN is not set."
+    log_error "Get your token from: https://plugins.jetbrains.com/author/me/tokens"
+    exit 1
+fi
+
+log_info "Publishing to JetBrains Marketplace..."
+./gradlew publishPlugin
+
+log_info "Successfully published linthis plugin v$VERSION to JetBrains Marketplace!"
+log_info "View at: https://plugins.jetbrains.com/plugin/29860-linthis"

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/src/main/kotlin/com/mojeter/linthis/plugin/LinthisStreamConnectionProvider.kt

@@ -7,6 +7,7 @@
 package com.mojeter.linthis.plugin
 
 import com.intellij.openapi.project.Project
+import com.mojeter.linthis.plugin.settings.LinthisSettings
 import com.redhat.devtools.lsp4ij.server.ProcessStreamConnectionProvider
 import java.io.File
 
@@ -31,8 +32,22 @@ class LinthisStreamConnectionProvider(private val project: Project) : ProcessStr
     }
 
     private fun buildCommand(): List<String> {
-        val linthisPath = findLinthisExecutable()
-        return listOf(linthisPath, "lsp")
+        val settings = LinthisSettings.getInstance(project)
+        val linthisPath = if (settings.linthisPath.isNotBlank()) {
+            settings.linthisPath
+        } else {
+            findLinthisExecutable()
+        }
+
+        val commands = mutableListOf(linthisPath, "lsp")
+
+        // Add --use-plugin if configured
+        if (settings.usePlugin.isNotBlank()) {
+            commands.add("--use-plugin")
+            commands.add(settings.usePlugin)
+        }
+
+        return commands
     }
 
     /**

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/src/main/kotlin/com/mojeter/linthis/plugin/actions/LinthisFormatAction.kt

@@ -49,7 +49,7 @@ class LinthisFormatAction : AnAction(), DumbAware {
         // Run linthis format
         ApplicationManager.getApplication().executeOnPooledThread {
             LOG.warn("Running format on file: ${file.path}")
-            val result = LinthisExecutor.format(file.path, project.basePath, settings.linthisPath)
+            val result = LinthisExecutor.format(file.path, project.basePath, settings.linthisPath, settings.usePlugin)
 
             ApplicationManager.getApplication().invokeLater {
                 if (result.success) {

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/src/main/kotlin/com/mojeter/linthis/plugin/listeners/LinthisDocumentListener.kt

@@ -81,7 +81,7 @@ class LinthisDocumentListener : FileDocumentManagerListener {
                     LOG.warn("Running format on save for: ${file.path}")
 
                     // Format the file in-place (file is already saved to disk)
-                    val result = LinthisExecutor.format(file.path, project.basePath, settings.linthisPath)
+                    val result = LinthisExecutor.format(file.path, project.basePath, settings.linthisPath, settings.usePlugin)
 
                     if (result.success) {
                         LOG.warn("Format on save successful, reloading document")

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/src/main/kotlin/com/mojeter/linthis/plugin/settings/LinthisSettings.kt

@@ -28,6 +28,7 @@ class LinthisSettings : PersistentStateComponent<LinthisSettings.State> {
         var lintOnSave: Boolean = true
         var formatOnSave: Boolean = false
         var linthisPath: String = ""
+        var usePlugin: String = ""
         var additionalArgs: String = ""
     }
 
@@ -53,6 +54,10 @@ class LinthisSettings : PersistentStateComponent<LinthisSettings.State> {
         get() = myState.linthisPath
         set(value) { myState.linthisPath = value }
 
+    var usePlugin: String
+        get() = myState.usePlugin
+        set(value) { myState.usePlugin = value }
+
     var additionalArgs: String
         get() = myState.additionalArgs
         set(value) { myState.additionalArgs = value }

{linthis-0.2.0 → linthis-0.3.0}/jetbrains-linthis/src/main/kotlin/com/mojeter/linthis/plugin/settings/LinthisSettingsConfigurable.kt

@@ -28,6 +28,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
     private var lintOnSaveCheckbox: JBCheckBox? = null
     private var formatOnSaveCheckbox: JBCheckBox? = null
     private var linthisPathField: TextFieldWithBrowseButton? = null
+    private var usePluginField: JBTextField? = null
     private var additionalArgsField: JBTextField? = null
 
     override fun getDisplayName(): String = "Linthis"
@@ -47,6 +48,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
         }
 
         additionalArgsField = JBTextField()
+        usePluginField = JBTextField()
 
         settingsPanel = FormBuilder.createFormBuilder()
             .addComponent(JBLabel("<html><b>Behavior</b></html>"))
@@ -59,6 +61,14 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
                 JBLabel("Linthis path (leave empty for auto-detect):"),
                 linthisPathField!!
             )
+            .addSeparator()
+            .addComponent(JBLabel("<html><b>Plugin</b></html>"))
+            .addLabeledComponent(
+                JBLabel("<html>Use plugin (e.g., https://github.com/zhlinh/linthis-plugin-template):</html>"),
+                usePluginField!!
+            )
+            .addSeparator()
+            .addComponent(JBLabel("<html><b>Advanced</b></html>"))
             .addLabeledComponent(
                 JBLabel("Additional arguments:"),
                 additionalArgsField!!
@@ -75,6 +85,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
                lintOnSaveCheckbox?.isSelected != settings.lintOnSave ||
                formatOnSaveCheckbox?.isSelected != settings.formatOnSave ||
                linthisPathField?.text != settings.linthisPath ||
+               usePluginField?.text != settings.usePlugin ||
                additionalArgsField?.text != settings.additionalArgs
     }
 
@@ -84,6 +95,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
         settings.lintOnSave = lintOnSaveCheckbox?.isSelected ?: true
         settings.formatOnSave = formatOnSaveCheckbox?.isSelected ?: false
         settings.linthisPath = linthisPathField?.text ?: ""
+        settings.usePlugin = usePluginField?.text ?: ""
         settings.additionalArgs = additionalArgsField?.text ?: ""
     }
 
@@ -93,6 +105,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
         lintOnSaveCheckbox?.isSelected = settings.lintOnSave
         formatOnSaveCheckbox?.isSelected = settings.formatOnSave
         linthisPathField?.text = settings.linthisPath
+        usePluginField?.text = settings.usePlugin
         additionalArgsField?.text = settings.additionalArgs
     }
 
@@ -102,6 +115,7 @@ class LinthisSettingsConfigurable(private val project: Project) : Configurable {
         lintOnSaveCheckbox = null
         formatOnSaveCheckbox = null
         linthisPathField = null
+        usePluginField = null
         additionalArgsField = null
     }
 }