Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

checkstyle-pluging-description #31

Merged
merged 2 commits into from
May 11, 2024
Merged

checkstyle-pluging-description #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3dba07
feat: checkstyle-pluging-description
JayWei1215 May 11, 2024
2a6648d
feat: update documentation
JayWei1215 May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
_site
.cache
temp_dir
/.idea/.gitignore
/.idea/community.iml
/.idea/misc.xml
/.idea/modules.xml
/.idea/vcs.xml
42 changes: 41 additions & 1 deletion docs/events/gsoc/2024/checkstyle-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# 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) - `@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

- 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.
JayWei1215 marked this conversation as resolved.
Show resolved Hide resolved

- Provide an improved Kotlin DSL, particularly enhancing its declarativity when integrating plugins.

## Links
JayWei1215 marked this conversation as resolved.
Show resolved Hide resolved
- [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)
Loading