From a3dba07e9d2eb05d7ee76e9fff906ff4c084c392 Mon Sep 17 00:00:00 2001 From: jay Date: Sat, 11 May 2024 13:42:18 +0800 Subject: [PATCH 1/2] feat: checkstyle-pluging-description Signed-off-by: jaywei011215 --- .gitignore | 5 +++ docs/events/gsoc/2024/checkstyle-plugin.md | 38 +++++++++++++++++++++- 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 09fbdcd..b63527f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ _site .cache temp_dir +/.idea/.gitignore +/.idea/community.iml +/.idea/misc.xml +/.idea/modules.xml +/.idea/vcs.xml diff --git a/docs/events/gsoc/2024/checkstyle-plugin.md b/docs/events/gsoc/2024/checkstyle-plugin.md index 43f20e8..c5255cb 100644 --- a/docs/events/gsoc/2024/checkstyle-plugin.md +++ b/docs/events/gsoc/2024/checkstyle-plugin.md @@ -1,3 +1,39 @@ # GSoC 2024. Declarative Syntax and Enhancements for the Checkstyle Plugin -Description is coming soon +## Goal +- **Enhanced Functionality**: Enhance the Checkstyle plugin to support more of Checkstyle's features. +- **Better Declarativity**: improve the declarative nature of Kotlin DSL when integrating plugins. + +## Status +Selected + +## Team +#### Authors +- [@Hongjie Wei](https://github.com/JayWei1215) + +#### Mentors +- [@oleg-nenashev](https://github.com/oleg-nenashev) + +## Background +- Checkstyle is a powerful tool, but currently, the Checkstyle plugin in Gradle may not support all of Checkstyle's features. +- Kotlin DSL does not provide good declarative support when it comes to integrating plugins. + +## Implementation + +- **Enhanced Functionality** - The CheckstyleExtension class is the extension class of the Gradle Checkstyle plugin.It is used to configure various options of the Checkstyle plugin.By Creating a new subclass of CheckstyleExtension and add some new properties, we can make the Checkstyle plugin support more of Checkstyle's features. + +- **Better Declarativity** - Create a Kotlin class to serve as the entry point for the DSL. This class can inherit from CheckstyleExtension. Within the DSL class, define properties and methods specific to the DSL, allowing for the configuration of Checkstyle's various options. + +## Target Repositories + + +## Deliverables + +- Provide an enhanced version of the Gradle Checkstyle plugin. It will support additional Checkstyle features, such as code complexity, duplication, and dependency checks. + +- Provide an improved Kotlin DSL, particularly enhancing its declarativity when integrating plugins. + +## Links +- [Contributor Proposal](https://docs.google.com/document/d/1q0NFuoR1F9wcQxyFEC0m1qOspBSyq9TbyuOZhldHybk/edit?usp=sharing) +- [Project Proposal](https://kotlinlang.org/docs/gsoc-2024.html#kotlin-dsl-improvements-for-declarative-gradle-medium-175-hrs) +- [Declarative Gradle](https://blog.gradle.org/declarative-gradle) From 2a6648d3f217365da3713a947bd76b74daf12aca Mon Sep 17 00:00:00 2001 From: jay Date: Sat, 11 May 2024 16:56:34 +0800 Subject: [PATCH 2/2] feat: update documentation Signed-off-by: jaywei011215 --- docs/events/gsoc/2024/checkstyle-plugin.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/events/gsoc/2024/checkstyle-plugin.md b/docs/events/gsoc/2024/checkstyle-plugin.md index c5255cb..78ad5ad 100644 --- a/docs/events/gsoc/2024/checkstyle-plugin.md +++ b/docs/events/gsoc/2024/checkstyle-plugin.md @@ -9,7 +9,7 @@ Selected ## Team #### Authors -- [@Hongjie Wei](https://github.com/JayWei1215) +- [Hongjie Wei](https://github.com/JayWei1215) - `@JayWei1215` #### Mentors - [@oleg-nenashev](https://github.com/oleg-nenashev) @@ -29,6 +29,8 @@ Selected ## Deliverables +- Create a new branch in the project repository specifically for developing the Checkstyle plugin functionality, which will contain the code necessary for implementing and testing the Checkstyle plugin. + - Provide an enhanced version of the Gradle Checkstyle plugin. It will support additional Checkstyle features, such as code complexity, duplication, and dependency checks. - Provide an improved Kotlin DSL, particularly enhancing its declarativity when integrating plugins. @@ -37,3 +39,5 @@ Selected - [Contributor Proposal](https://docs.google.com/document/d/1q0NFuoR1F9wcQxyFEC0m1qOspBSyq9TbyuOZhldHybk/edit?usp=sharing) - [Project Proposal](https://kotlinlang.org/docs/gsoc-2024.html#kotlin-dsl-improvements-for-declarative-gradle-medium-175-hrs) - [Declarative Gradle](https://blog.gradle.org/declarative-gradle) +- [Checkstyle](https://github.com/checkstyle/checkstyle) +- [Checkstyle Plugin](https://docs.gradle.org/current/userguide/checkstyle_plugin.html)