Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

AutoCorrect for Java

Maven Central

The Java version of AutoCorrect built for Java.

Installation

Add io.github.huacnlee:autocorrect-java to your pom.xml:

<dependencies>
    <dependency>
        <groupId>io.github.huacnlee</groupId>
        <artifactId>autocorrect-java</artifactId>
        <version>2.4.3</version>
    </dependency>
    <!-- NativeLibrary need slf4j, so there need add -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-nop</artifactId>
        <version>1.7.36</version>
    </dependency>
</dependencies>

With Gradle:

dependencies {
    implementation 'io.github.huacnlee:autocorrect-java:2.4.3'
    // NativeLibrary need slf4j, so there need add
    implementation 'org.slf4j:slf4j-nop:1.7.36'
}

List on Maven Repo:

https://repo1.maven.org/maven2/io/github/huacnlee/autocorrect-java

Usage

import io.github.huacnlee.AutoCorrect;

public static void main(String[] args) {
    // Load config from string
    String configStr = "{ ... }";
    AutoCorrect.loadConfig(configStr);

    String output = AutoCorrect.format("Hello你好");
    System.out.println(output);
    // Hello 你好

    output = AutoCorrect.formatFor("// Hello你好,这是Java注释.", "test.java");
    System.out.println(output);
    // // Hello 你好,这是 Java 注释。

    LintResult result = AutoCorrect.lintFor("// Hello你好,这是Java注释.", "test.java");
    System.out.printf("LintResult.raw: %s\n", result.getRaw());
    System.out.printf("LintResult.filepath: %s\n", result.getFilepath());

    for (LineResult line : result.getLines()) {
        System.out.printf("LineResult: (%d,%d) severity: %d\n", line.getLine(), line.getCol(), line.getSeverity());
        System.out.printf("LineResult old -> new:\n%s\n%s\n", line.getOld(), line.getNew());
    }
}