com.liferay.source.formatter.SourceFormatterArgs Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.source.formatter;
import com.liferay.petra.string.CharPool;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.tools.ToolsUtil;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* @author Raymond Augé
* @author Drew Brokke
*/
public class SourceFormatterArgs {
public static final boolean AUTO_FIX = true;
public static final String BASE_DIR_NAME = "./";
public static final boolean CHECK_VULNERABILITIES = false;
public static final int COMMIT_COUNT = 0;
public static final boolean FAIL_ON_AUTO_FIX = false;
public static final boolean FAIL_ON_HAS_WARNING = true;
public static final boolean FORMAT_CURRENT_BRANCH = false;
public static final boolean FORMAT_LATEST_AUTHOR = false;
public static final boolean FORMAT_LOCAL_CHANGES = false;
public static final String GIT_WORKING_BRANCH_NAME = "master";
public static final boolean INCLUDE_GENERATED_FILES = false;
public static final boolean INCLUDE_SUBREPOSITORIES = false;
public static final boolean JAVA_PARSER_ENABLED = true;
public static final int MAX_DIR_LEVEL = ToolsUtil.PORTAL_MAX_DIR_LEVEL;
public static final int MAX_LINE_LENGTH = 80;
public static final String OUTPUT_FILE_NAME = null;
public static final String OUTPUT_KEY_MODIFIED_FILES =
"source.formatter.modified.files";
public static final boolean PRINT_ERRORS = true;
public static final int PROCESSOR_THREAD_COUNT = 5;
public static final boolean SHOW_DEBUG_INFORMATION = false;
public static final boolean USE_CI_GITHUB_ACCESS_TOKEN = false;
public static final boolean VALIDATE_COMMIT_MESSAGES = false;
public void addRecentChangesFileNames(
Collection fileNames, String baseDirName)
throws IOException {
for (String fileName : fileNames) {
Path path = null;
if (baseDirName != null) {
path = Paths.get(baseDirName, fileName);
}
else {
path = Paths.get(fileName);
}
File file = path.toFile();
File canonicalFile = file.getCanonicalFile();
String canonicalPath = canonicalFile.getPath();
_recentChangesFileNames.add(
StringUtil.replace(
canonicalPath, CharPool.BACK_SLASH, CharPool.SLASH));
}
}
public String getBaseDirName() {
return _baseDirName;
}
public List getCheckCategoryNames() {
return _checkCategoryNames;
}
public List getCheckNames() {
return _checkNames;
}
public int getCommitCount() {
return _commitCount;
}
public List getFileExtensions() {
return _fileExtensions;
}
public List getFileNames() {
return _fileNames;
}
public String getGitWorkingBranchName() {
return _gitWorkingBranchName;
}
public int getMaxDirLevel() {
return _maxDirLevel;
}
public int getMaxLineLength() {
return _maxLineLength;
}
public String getOutputFileName() {
return _outputFileName;
}
public int getProcessorThreadCount() {
return _processorThreadCount;
}
public Set getRecentChangesFileNames() {
return _recentChangesFileNames;
}
public List getSkipCheckNames() {
return _skipCheckNames;
}
public List getSourceFormatterProperties() {
return _sourceFormatterProperties;
}
public boolean isAutoFix() {
return _autoFix;
}
public boolean isCheckVulnerabilities() {
return _checkVulnerabilities;
}
public boolean isFailOnAutoFix() {
return _failOnAutoFix;
}
public boolean isFailOnHasWarning() {
return _failOnHasWarning;
}
public boolean isFormatCurrentBranch() {
return _formatCurrentBranch;
}
public boolean isFormatLatestAuthor() {
return _formatLatestAuthor;
}
public boolean isFormatLocalChanges() {
return _formatLocalChanges;
}
public boolean isIncludeGeneratedFiles() {
return _includeGeneratedFiles;
}
public boolean isIncludeSubrepositories() {
return _includeSubrepositories;
}
public boolean isJavaParserEnabled() {
return _javaParserEnabled;
}
public boolean isPrintErrors() {
return _printErrors;
}
public boolean isShowDebugInformation() {
return _showDebugInformation;
}
public boolean isUseCiGithubAccessToken() {
return _useCiGithubAccessToken;
}
public boolean isValidateCommitMessages() {
return _validateCommitMessages;
}
public void setAutoFix(boolean autoFix) {
_autoFix = autoFix;
}
public void setBaseDirName(String baseDirName) {
if (_fileNames != null) {
throw new RuntimeException("File names are already initialized");
}
if (!baseDirName.endsWith("/")) {
baseDirName += "/";
}
_baseDirName = baseDirName;
}
public void setCheckCategoryNames(List checkCategoryNames) {
_checkCategoryNames = checkCategoryNames;
}
public void setCheckNames(List checkNames) {
_checkNames = checkNames;
}
public void setCheckVulnerabilities(boolean checkVulnerabilities) {
_checkVulnerabilities = checkVulnerabilities;
}
public void setCommitCount(int commitCount) {
_commitCount = commitCount;
}
public void setFailOnAutoFix(boolean failOnAutoFix) {
_failOnAutoFix = failOnAutoFix;
}
public void setFailOnHasWarning(boolean failOnHasWarning) {
_failOnHasWarning = failOnHasWarning;
}
public void setFileExtensions(List fileExtensions) {
_fileExtensions = fileExtensions;
}
public void setFileNames(List fileNames) {
if (_fileNames != null) {
throw new RuntimeException("File names are already initialized");
}
if (_baseDirName != BASE_DIR_NAME) {
throw new RuntimeException("Base directory was already set");
}
_baseDirName = "";
_fileNames = fileNames;
}
public void setFormatCurrentBranch(boolean formatCurrentBranch) {
_formatCurrentBranch = formatCurrentBranch;
}
public void setFormatLatestAuthor(boolean formatLatestAuthor) {
_formatLatestAuthor = formatLatestAuthor;
}
public void setFormatLocalChanges(boolean formatLocalChanges) {
_formatLocalChanges = formatLocalChanges;
}
public void setGitWorkingBranchName(String gitWorkingBranchName) {
_gitWorkingBranchName = gitWorkingBranchName;
}
public void setIncludeGeneratedFiles(boolean includeGeneratedFiles) {
_includeGeneratedFiles = includeGeneratedFiles;
}
public void setIncludeSubrepositories(boolean includeSubrepositories) {
_includeSubrepositories = includeSubrepositories;
}
public void setJavaParserEnabled(boolean javaParserEnabled) {
_javaParserEnabled = javaParserEnabled;
}
public void setMaxDirLevel(int maxDirLevel) {
_maxDirLevel = maxDirLevel;
}
public void setMaxLineLength(int maxLineLength) {
_maxLineLength = maxLineLength;
}
public void setOutputFileName(String outputFileName) {
_outputFileName = outputFileName;
}
public void setPrintErrors(boolean printErrors) {
_printErrors = printErrors;
}
public void setProcessorThreadCount(int processorThreadCount) {
_processorThreadCount = processorThreadCount;
}
public void setShowDebugInformation(boolean showDebugInformation) {
_showDebugInformation = showDebugInformation;
}
public void setSkipCheckNames(List skipCheckNames) {
_skipCheckNames = skipCheckNames;
}
public void setSourceFormatterProperties(
List sourceFormatterProperties) {
_sourceFormatterProperties = sourceFormatterProperties;
}
public void setUseCiGithubAccessToken(boolean useCiGithubAccessToken) {
_useCiGithubAccessToken = useCiGithubAccessToken;
}
public void setValidateCommitMessages(boolean validateCommitMessages) {
_validateCommitMessages = validateCommitMessages;
}
private boolean _autoFix = AUTO_FIX;
private String _baseDirName = BASE_DIR_NAME;
private List _checkCategoryNames = new ArrayList<>();
private List _checkNames = new ArrayList<>();
private boolean _checkVulnerabilities = CHECK_VULNERABILITIES;
private int _commitCount = COMMIT_COUNT;
private boolean _failOnAutoFix = FAIL_ON_AUTO_FIX;
private boolean _failOnHasWarning = FAIL_ON_HAS_WARNING;
private List _fileExtensions = new ArrayList<>();
private List _fileNames;
private boolean _formatCurrentBranch = FORMAT_CURRENT_BRANCH;
private boolean _formatLatestAuthor = FORMAT_LATEST_AUTHOR;
private boolean _formatLocalChanges = FORMAT_LOCAL_CHANGES;
private String _gitWorkingBranchName = GIT_WORKING_BRANCH_NAME;
private boolean _includeGeneratedFiles = INCLUDE_GENERATED_FILES;
private boolean _includeSubrepositories = INCLUDE_SUBREPOSITORIES;
private boolean _javaParserEnabled = JAVA_PARSER_ENABLED;
private int _maxDirLevel = MAX_DIR_LEVEL;
private int _maxLineLength = MAX_LINE_LENGTH;
private String _outputFileName = OUTPUT_FILE_NAME;
private boolean _printErrors = PRINT_ERRORS;
private int _processorThreadCount = PROCESSOR_THREAD_COUNT;
private final Set _recentChangesFileNames = new HashSet<>();
private boolean _showDebugInformation = SHOW_DEBUG_INFORMATION;
private List _skipCheckNames = new ArrayList<>();
private List _sourceFormatterProperties = new ArrayList<>();
private boolean _useCiGithubAccessToken = USE_CI_GITHUB_ACCESS_TOKEN;
private boolean _validateCommitMessages = VALIDATE_COMMIT_MESSAGES;
}