Skip to content

Added file extensions configuration for checkstyle #100

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

Open
tasmdis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added file extensions configuration for checkstyle #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/main/java/pl/touk/sputnik/configuration/GeneralOption.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public enum GeneralOption implements ConfigurationOption {

CHECKSTYLE_ENABLED("checkstyle.enabled", "Checkstyle enabled", "false"),
CHECKSTYLE_CONFIGURATION_FILE("checkstyle.configurationFile", "Checkstyle configuration file", "sun_checks.xml"),
CHECKSTYLE_FILE_EXTENSIONS("checkstyle.file.extensions","Comma separated file extensions processed by checkstyle","java"),

PMD_ENABLED("pmd.enabled", "PMD enabled", "false"),
PMD_RULESETS("pmd.ruleSets", "PMD rule sets", "rulesets/java/basic.xml"),
Expand Down
17 changes: 16 additions & 1 deletion src/main/java/pl/touk/sputnik/processor/checkstyle/CheckstyleProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
package pl.touk.sputnik.processor.checkstyle;

import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.PropertiesExpander;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;

import lombok.extern.slf4j.Slf4j;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import pl.touk.sputnik.configuration.ConfigurationHolder;
import pl.touk.sputnik.configuration.GeneralOption;
import pl.touk.sputnik.review.Review;
import pl.touk.sputnik.review.ReviewException;
import pl.touk.sputnik.review.ReviewProcessor;
import pl.touk.sputnik.review.ReviewResult;
import pl.touk.sputnik.review.filter.FileExtensionFilter;
import pl.touk.sputnik.review.filter.JavaFilter;
import pl.touk.sputnik.review.transformer.IOFileTransformer;

Expand All @@ -40,7 +47,7 @@ public String getName() {
}

private void innerProcess(@NotNull Review review, @NotNull AuditListener auditListener) {
List<File> files = review.getFiles(new JavaFilter(), new IOFileTransformer());
List<File> files = review.getFiles(new FileExtensionFilter(getSupportedFileExtensions()), new IOFileTransformer());
Checker checker = createChecker(auditListener);
checker.process(files);
checker.destroy();
Expand All @@ -62,6 +69,14 @@ private Checker createChecker(@NotNull AuditListener auditListener) {
}
}

@NotNull
private List<String> getSupportedFileExtensions(){
String commaSeparatedExtensions = ConfigurationHolder.instance().getProperty(GeneralOption.CHECKSTYLE_FILE_EXTENSIONS);
Iterable<String> fileExtensions = Splitter.on(",").omitEmptyStrings().trimResults().split(commaSeparatedExtensions);
Builder<String> listBuilder = ImmutableList.builder();
return listBuilder.addAll(fileExtensions).build();
}

@Nullable
private String getConfigurationFilename() {
String configurationFile = ConfigurationHolder.instance().getProperty(GeneralOption.CHECKSTYLE_CONFIGURATION_FILE);
Expand Down