chore: Prepare for 1.3.2 (#261)

jdneo · Oct 18, 2019 · bc12a8f · bc12a8f
1 parent a27a79e
commit bc12a8f
Show file tree

Hide file tree

Showing 12 changed files with 33 additions and 22 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -14,4 +14,5 @@
     "java.checkstyle.properties": {
         "checkstyle.header.file": "${workspaceFolder}/jdtls.ext/config/java.header"
     },
+    "java.configuration.updateBuildConfiguration": "automatic",
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,10 @@ All notable changes to the "vscode-checkstyle" extension will be documented in t
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [1.3.2]
+### Added
+- Support customized Checkstyle modules ([#206](https://github.com/jdneo/vscode-checkstyle/issues/206))
+
 ## [1.3.1]
 ### Fixed
 - [Bugs fixed](https://github.com/jdneo/vscode-checkstyle/issues?q=is%3Aissue+is%3Aclosed+milestone%3A1.3.1+label%3Abug)

diff --git a/README.md b/README.md
@@ -32,41 +32,47 @@
 
 ## Features
 
-### Set Checkstyle Version
-<p align="center">
-  <img src="https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/imgs/set_version.png" style="border-radius: 15px" alt="Set Checkstyle Configuration File" />
-</p>
-
-- You can use the command `Checkstyle: Set the Checkstyle Version` to manually set the Checkstyle version according to your project preferences. The extension will automatically download the required jar files if they do not exist locally.
-
 ### Set Checkstyle Configuration File
-<p align="center">
-  <img src="https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/imgs/set_config.png" alt="Set Checkstyle Configuration File" />
-</p>
+
+![demo](https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/gifs/setConfiguration.gif)
 
 - To set the configuration file, Just Right click the `.xml` file and select `Set the Checkstyle Configuration File`.
 
 - You can also trigger the command **Checkstyle: Set Checkstyle Configuration File** to choose the configuration file in the File Explorer. The extension will automatically detect and list the Checkstyle configuration files in your workspace. Besides that, you will also see the two built-in configurations:
   - **Google's Check**
   - **Sun's Check**
 
+### Set Checkstyle Version
+
+![demo](https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/gifs/setVersion(lower).gif)
+
+- You can use the command `Checkstyle: Set the Checkstyle Version` to manually set the Checkstyle version according to your project preferences. The extension will automatically download the required jar files if they do not exist locally.
+
 ### Check the Style and Fix the Violations
-<p align="center">
-  <img src="https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/imgs/quick_fix.png" alt="Set Checkstyle Configuration File" />
-</p>
 
-- When opening or saving a Java file, the extension will check the file format and provide quick fixes if possible. You can click the ![bulb](https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/imgs/btn_bulb.png) button in the editor to show the available quick fixes.
+![demo](https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/gifs/liveLinting.gif)
+
+- When editing a Java file, the extension will check the file format and provide quick fixes if possible. You can click the ![bulb](https://raw.githubusercontent.com/jdneo/vscode-checkstyle/master/docs/imgs/btn_bulb.png) button in the editor to show the available quick fixes.
+
+
 
 ## Settings
 | Setting Name | Description | Default Value |
 |---|---|---|
 | `java.checkstyle.configuration` | Specify the path of the Checkstyle configuration file. The path can either be a local file path or a URL. | `""` |
 | `java.checkstyle.properties` | Specify the customized properties used in the Checkstyle configuration. | `{}` |
+| `java.checkstyle.modules` | Specify the third-party modules used for Checkstyle. | `[]` |
 | `java.checkstyle.autocheck` | Specify if the extension will check the format automatically or not. | `true` |
 
-> Note: You can use the `${workspaceFolder}` to represent the path of the workspace folder of the file to be checked. For example: 
+> Note: You can use the `${workspaceFolder}` to represent the path of the workspace folder of the file to be checked. For example:
 
-```javascript
+```json
+"java.checkstyle.modules": [
+    "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar"
+]
+```
+or
+```json
 "java.checkstyle.properties": {
     "basedir": "${workspaceFolder}"
 }

diff --git a/docs/gifs/liveLinting.gif b/docs/gifs/liveLinting.gif
diff --git a/docs/gifs/setConfiguration.gif b/docs/gifs/setConfiguration.gif
diff --git a/docs/gifs/setVersion(lower).gif b/docs/gifs/setVersion(lower).gif
diff --git a/jdtls.ext/com.shengchen.checkstyle.checker/pom.xml b/jdtls.ext/com.shengchen.checkstyle.checker/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.shengchen.checkstyle</groupId>
         <artifactId>parent</artifactId>
-        <version>1.3.1</version>
+        <version>1.3.2</version>
     </parent>
     <artifactId>com.shengchen.checkstyle.checker</artifactId>
     <packaging>jar</packaging>

diff --git a/jdtls.ext/com.shengchen.checkstyle.runner/META-INF/MANIFEST.MF b/jdtls.ext/com.shengchen.checkstyle.runner/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: com.shengchen.checkstyle.runner
 Bundle-SymbolicName: com.shengchen.checkstyle.runner;singleton:=true
-Bundle-Version: 1.3.1
+Bundle-Version: 1.3.2
 Bundle-Activator: com.shengchen.checkstyle.runner.CheckstylePlugin
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Import-Package: org.eclipse.jdt.core,

diff --git a/jdtls.ext/com.shengchen.checkstyle.runner/pom.xml b/jdtls.ext/com.shengchen.checkstyle.runner/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.shengchen.checkstyle</groupId>
         <artifactId>parent</artifactId>
-        <version>1.3.1</version>
+        <version>1.3.2</version>
     </parent>
     <artifactId>com.shengchen.checkstyle.runner</artifactId>
     <packaging>eclipse-plugin</packaging>

diff --git a/jdtls.ext/pom.xml b/jdtls.ext/pom.xml
@@ -4,7 +4,7 @@
     <groupId>com.shengchen.checkstyle</groupId>
     <artifactId>parent</artifactId>
     <name>${base.name} :: Parent</name>
-    <version>1.3.1</version>
+    <version>1.3.2</version>
     <packaging>pom</packaging>
     <properties>
         <base.name>Java Checkstyle Runner</base.name>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "vscode-checkstyle",
     "displayName": "Checkstyle for Java",
     "description": "%description%",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "author": "Sheng Chen",
     "publisher": "shengchen",
     "license": "GNU LGPL V3.0",