MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2025-12-16 14:23:28 +07:00
Code Issues Packages Projects Releases Wiki Activity

Better names for CLI inspection logger API (IDEA-CR-52729)

Browse Source 
GitOrigin-RevId: 0d98a57f3d9db6469c88015fab98722325029e40
This commit is contained in:
Dmitry Jemerov
2019-09-24 12:06:32 +02:00
committed by intellij-monorepo-bot
parent f38a0e1d34
commit cbda6e7ccf
5 changed files with 55 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
java/java-impl/src/com/intellij/codeInspection/JavaCommandLineInspectionProjectConfigurator.java
View File

@@ -21,7 +21,7 @@ import java.util.Set;
*/
public class JavaCommandLineInspectionProjectConfigurator implements CommandLineInspectionProjectConfigurator {
@Override
public boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger) {
public boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger) {
JavaSdk javaSdk = JavaSdk.getInstance();
List<Sdk> sdks = ProjectJdkTable.getInstance().getSdksOfType(javaSdk);
if (!sdks.isEmpty()) return false;
@@ -29,7 +29,7 @@ public class JavaCommandLineInspectionProjectConfigurator implements CommandLine
try {
boolean hasAnyJavaFiles = Files.walk(projectPath).anyMatch(f -> f.toString().endsWith(".java"));
if (!hasAnyJavaFiles) {
logger.logMessageLn(3, "Skipping JDK autodetection because the project doesn't contain any Java files");
logger.reportMessage(3, "Skipping JDK autodetection because the project doesn't contain any Java files");
}
return hasAnyJavaFiles;
}
@@ -39,7 +39,7 @@ public class JavaCommandLineInspectionProjectConfigurator implements CommandLine
}
@Override
public void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger) {
public void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger) {
JavaSdk javaSdk = JavaSdk.getInstance();
List<Sdk> sdks = ProjectJdkTable.getInstance().getSdksOfType(javaSdk);
if (!sdks.isEmpty()) {
@@ -55,7 +55,7 @@ public class JavaCommandLineInspectionProjectConfigurator implements CommandLine
if (existingVersions.contains(version)) continue;
existingVersions.add(version);
String name = javaSdk.suggestSdkName(null, path);
logger.logMessageLn(2, "Detected JDK with name " + name + " at " + path);
logger.reportMessage(2, "Detected JDK with name " + name + " at " + path);
Sdk jdk = javaSdk.createJdk(name, path, false);
ApplicationManager.getApplication().runWriteAction(() -> ProjectJdkTable.getInstance().addJdk(jdk));
}

8
platform/lang-impl/src/com/intellij/codeInspection/CommandLineInspectionLogger.java → platform/lang-impl/src/com/intellij/codeInspection/CommandLineInspectionProgressReporter.java
View File

@@ -4,10 +4,8 @@ package com.intellij.codeInspection;
/**
* @author yole
*/
public interface CommandLineInspectionLogger {
void logMessage(int minVerboseLevel, String message);
public interface CommandLineInspectionProgressReporter {
void reportError(String message);
void logError(String message);
void logMessageLn(int minVerboseLevel, String message);
void reportMessage(int minVerboseLevel, String message);
}

6
platform/lang-impl/src/com/intellij/codeInspection/CommandLineInspectionProjectConfigurator.java
View File

@@ -17,18 +17,18 @@ public interface CommandLineInspectionProjectConfigurator {
/**
* Returns true if any additional configuration is required to inspect the project at the given path.
*/
boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger);
boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger);
/**
* Invoked before a project is imported.
*/
default void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger) {
default void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger) {
}
/**
* Invoked after the project has been imported and before the analysis on the specified scope
* is started.
*/
default void configureProject(@NotNull Project project, @NotNull AnalysisScope scope, @NotNull CommandLineInspectionLogger logger) {
default void configureProject(@NotNull Project project, @NotNull AnalysisScope scope, @NotNull CommandLineInspectionProgressReporter logger) {
}
}

69
platform/lang-impl/src/com/intellij/codeInspection/InspectionApplication.java
View File

@@ -55,7 +55,7 @@ import java.util.concurrent.ForkJoinPool;
* @author max
*/
@SuppressWarnings("UseOfSystemOutOrSystemErr")
public class InspectionApplication implements CommandLineInspectionLogger {
public class InspectionApplication implements CommandLineInspectionProgressReporter {
private static final Logger LOG = Logger.getInstance("#com.intellij.codeInspection.InspectionApplication");
public InspectionToolCmdlineOptionHelpProvider myHelpProvider;
@@ -79,12 +79,12 @@ public class InspectionApplication implements CommandLineInspectionLogger {
public void startup() {
if (myProjectPath == null) {
logError("Project to inspect is not defined");
reportError("Project to inspect is not defined");
printHelp();
}
if (myProfileName == null && myProfilePath == null && myStubProfile == null) {
logError("Profile to inspect with is not defined");
reportError("Profile to inspect with is not defined");
printHelp();
}
IdeaForkJoinWorkerThreadFactory.setupForkJoinCommonPool(true);
@@ -95,7 +95,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
}
catch (Throwable e) {
LOG.error(e);
logError(e.getMessage());
reportError(e.getMessage());
gracefulExit();
return;
}
@@ -108,9 +108,9 @@ public class InspectionApplication implements CommandLineInspectionLogger {
public void execute() throws Exception {
ApplicationManager.getApplication().runReadAction((ThrowableComputable<Object, Exception>)() -> {
final ApplicationInfoEx appInfo = (ApplicationInfoEx)ApplicationInfo.getInstance();
logMessage(1, InspectionsBundle.message("inspection.application.starting.up",
reportMessageNoLineBreak(1, InspectionsBundle.message("inspection.application.starting.up",
appInfo.getFullApplicationName() + " (build " + appInfo.getBuild().asString() + ")"));
logMessageLn(1, InspectionsBundle.message("inspection.done"));
reportMessage(1, InspectionsBundle.message("inspection.done"));
Disposable disposable = Disposer.newDisposable();
try {
@@ -132,11 +132,11 @@ public class InspectionApplication implements CommandLineInspectionLogger {
private void run(@NotNull Path projectPath, @NotNull Disposable parentDisposable) throws IOException, JDOMException {
VirtualFile vfsProject = LocalFileSystem.getInstance().findFileByPath(FileUtil.toSystemIndependentName(projectPath.toString()));
if (vfsProject == null) {
logError(InspectionsBundle.message("inspection.application.file.cannot.be.found", projectPath));
reportError(InspectionsBundle.message("inspection.application.file.cannot.be.found", projectPath));
printHelp();
}
logMessage(1, InspectionsBundle.message("inspection.application.opening.project"));
reportMessageNoLineBreak(1, InspectionsBundle.message("inspection.application.opening.project"));
if (ConversionService.getInstance().convertSilently(projectPath, createConversionListener()).openingIsCanceled()) {
gracefulExit();
return;
@@ -150,7 +150,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
Project project = ProjectUtil.openOrImport(projectPath, null, false);
if (project == null) {
logError("Unable to open project");
reportError("Unable to open project");
gracefulExit();
return;
}
@@ -161,8 +161,8 @@ public class InspectionApplication implements CommandLineInspectionLogger {
PatchProjectUtil.patchProject(project);
logMessageLn(1, InspectionsBundle.message("inspection.done"));
logMessage(1, InspectionsBundle.message("inspection.application.initializing.project"));
reportMessage(1, InspectionsBundle.message("inspection.done"));
reportMessageNoLineBreak(1, InspectionsBundle.message("inspection.application.initializing.project"));
InspectionProfileImpl inspectionProfile = loadInspectionProfile(project);
if (inspectionProfile == null) return;
@@ -184,7 +184,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
VirtualFile vfsDir = LocalFileSystem.getInstance().findFileByPath(mySourceDirectory);
if (vfsDir == null) {
logError(InspectionsBundle.message("inspection.application.directory.cannot.be.found", mySourceDirectory));
reportError(InspectionsBundle.message("inspection.application.directory.cannot.be.found", mySourceDirectory));
printHelp();
}
@@ -192,10 +192,10 @@ public class InspectionApplication implements CommandLineInspectionLogger {
scope = new AnalysisScope(Objects.requireNonNull(psiDirectory));
}
logMessageLn(1, InspectionsBundle.message("inspection.done"));
reportMessage(1, InspectionsBundle.message("inspection.done"));
if (!myRunWithEditorSettings) {
logMessageLn(1, InspectionsBundle.message("inspection.application.chosen.profile.log.message", inspectionProfile.getName()));
reportMessage(1, InspectionsBundle.message("inspection.application.chosen.profile.log.message", inspectionProfile.getName()));
}
InspectionsReportConverter reportConverter = getReportConverter(myOutputFormat);
@@ -239,7 +239,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
reportConverter.convert(resultsDataPath.toString(), myOutPath, context.getTools(), ContainerUtil.map2List(inspectionsResults, path -> path.toFile()));
}
catch (InspectionsReportConverter.ConversionException e) {
logError("\n" + e.getMessage());
reportError("\n" + e.getMessage());
printHelp();
}
}
@@ -260,7 +260,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
return;
}
context.launchInspectionsOffline(scope, resultsDataPath.toString(), myRunGlobalToolsOnly, inspectionsResults);
logMessageLn(1, "\n" + InspectionsBundle.message("inspection.capitalized.done") + "\n");
reportMessage(1, "\n" + InspectionsBundle.message("inspection.capitalized.done") + "\n");
if (!myErrorCodeRequired) {
closeProject(project);
}
@@ -276,12 +276,12 @@ public class InspectionApplication implements CommandLineInspectionLogger {
String prefix = getPrefix(text);
if (prefix == null) return;
if (prefix.equals(lastPrefix)) {
logMessage(1, ".");
reportMessageNoLineBreak(1, ".");
return;
}
lastPrefix = prefix;
logMessageLn(1, "");
logMessageLn(1, prefix);
reportMessage(1, "");
reportMessage(1, prefix);
return;
}
@@ -292,12 +292,12 @@ public class InspectionApplication implements CommandLineInspectionLogger {
String prefix = getPrefix(text);
myLastPercent = percent;
String msg = (prefix != null ? prefix : InspectionsBundle.message("inspection.display.name")) + " " + percent + "%";
logMessageLn(2, msg);
reportMessage(2, msg);
}
return;
}
logMessageLn(2, text);
reportMessage(2, text);
}
});
}
@@ -328,7 +328,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
if (myProfileName != null) {
inspectionProfile = loadProfileByName(project, myProfileName);
if (inspectionProfile == null) {
logError("Profile with configured name (" + myProfileName + ") was not found (neither in project nor in config directory)");
reportError("Profile with configured name (" + myProfileName + ") was not found (neither in project nor in config directory)");
gracefulExit();
return null;
}
@@ -338,7 +338,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
if (myProfilePath != null) {
inspectionProfile = loadProfileByPath(myProfilePath);
if (inspectionProfile == null) {
logError("Failed to load profile from \'" + myProfilePath + "\'");
reportError("Failed to load profile from \'" + myProfilePath + "\'");
gracefulExit();
return null;
}
@@ -355,7 +355,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
}
inspectionProfile = InspectionProjectProfileManager.getInstance(project).getCurrentProfile();
logError("Using default project profile");
reportError("Using default project profile");
}
return inspectionProfile;
}
@@ -364,7 +364,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
private InspectionProfileImpl loadProfileByPath(final String profilePath) throws IOException, JDOMException {
InspectionProfileImpl inspectionProfile = ApplicationInspectionProfileManager.getInstanceImpl().loadProfile(profilePath);
if (inspectionProfile != null) {
logMessageLn(1, "Loaded profile \'" + inspectionProfile.getName() + "\' from file \'" + profilePath + "\'");
reportMessage(1, "Loaded profile \'" + inspectionProfile.getName() + "\' from file \'" + profilePath + "\'");
}
return inspectionProfile;
}
@@ -374,14 +374,14 @@ public class InspectionApplication implements CommandLineInspectionLogger {
InspectionProjectProfileManager profileManager = InspectionProjectProfileManager.getInstance(project);
InspectionProfileImpl inspectionProfile = profileManager.getProfile(profileName, false);
if (inspectionProfile != null) {
logMessageLn(1, "Loaded shared project profile \'" + profileName + "\'");
reportMessage(1, "Loaded shared project profile \'" + profileName + "\'");
}
else {
//check if ide profile is used for project
for (InspectionProfileImpl profile : profileManager.getProfiles()) {
if (Comparing.strEqual(profile.getName(), profileName)) {
inspectionProfile = profile;
logMessageLn(1, "Loaded local profile \'" + profileName + "\'");
reportMessage(1, "Loaded local profile \'" + profileName + "\'");
break;
}
}
@@ -405,19 +405,19 @@ public class InspectionApplication implements CommandLineInspectionLogger {
return new ConversionListener() {
@Override
public void conversionNeeded() {
logMessageLn(1, InspectionsBundle.message("inspection.application.project.has.older.format.and.will.be.converted"));
reportMessage(1, InspectionsBundle.message("inspection.application.project.has.older.format.and.will.be.converted"));
}
@Override
public void successfullyConverted(@NotNull final File backupDir) {
logMessageLn(1, InspectionsBundle.message(
reportMessage(1, InspectionsBundle.message(
"inspection.application.project.was.succesfully.converted.old.project.files.were.saved.to.0",
backupDir.getAbsolutePath()));
}
@Override
public void error(@NotNull final String message) {
logError(InspectionsBundle.message("inspection.application.cannot.convert.project.0", message));
reportError(InspectionsBundle.message("inspection.application.cannot.convert.project.0", message));
}
@Override
@@ -426,7 +426,7 @@ public class InspectionApplication implements CommandLineInspectionLogger {
for (File file : readonlyFiles) {
files.append(file.getAbsolutePath()).append("; ");
}
logError(InspectionsBundle.message("inspection.application.cannot.convert.the.project.the.following.files.are.read.only.0", files.toString()));
reportError(InspectionsBundle.message("inspection.application.cannot.convert.the.project.the.following.files.are.read.only.0", files.toString()));
}
};
}
@@ -447,20 +447,19 @@ public class InspectionApplication implements CommandLineInspectionLogger {
myVerboseLevel = verboseLevel;
}
@Override
public void logMessage(int minVerboseLevel, String message) {
private void reportMessageNoLineBreak(int minVerboseLevel, String message) {
if (myVerboseLevel >= minVerboseLevel) {
System.out.print(message);
}
}
@Override
public void logError(String message) {
public void reportError(String message) {
System.err.println(message);
}
@Override
public void logMessageLn(int minVerboseLevel, String message) {
public void reportMessage(int minVerboseLevel, String message) {
if (myVerboseLevel >= minVerboseLevel) {
System.out.println(message);
}

22
python/pluginJava/com/jetbrains/python/inspections/PythonPluginCommandLineInspectionProjectConfigurator.java
View File

@@ -2,7 +2,7 @@
package com.jetbrains.python.inspections;
import com.intellij.analysis.AnalysisScope;
import com.intellij.codeInspection.CommandLineInspectionLogger;
import com.intellij.codeInspection.CommandLineInspectionProgressReporter;
import com.intellij.codeInspection.CommandLineInspectionProjectConfigurator;
import com.intellij.facet.FacetManager;
import com.intellij.openapi.application.ApplicationManager;
@@ -27,7 +27,7 @@ import java.util.List;
public class PythonPluginCommandLineInspectionProjectConfigurator implements CommandLineInspectionProjectConfigurator {
@Override
public boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger) {
public boolean isApplicable(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger) {
List<Sdk> sdks = PythonSdkUtil.getAllSdks();
if (!sdks.isEmpty()) return false;
@@ -36,7 +36,7 @@ public class PythonPluginCommandLineInspectionProjectConfigurator implements Com
return f.toString().endsWith(".py");
});
if (!hasAnyPythonFiles) {
logger.logMessageLn(3, "Skipping Python interpreter autodetection because the project doesn't contain any Python files");
logger.reportMessage(3, "Skipping Python interpreter autodetection because the project doesn't contain any Python files");
}
return hasAnyPythonFiles;
@@ -47,35 +47,35 @@ public class PythonPluginCommandLineInspectionProjectConfigurator implements Com
}
@Override
public void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionLogger logger) {
logger.logMessageLn(3, "Python environment configuration...");
public void configureEnvironment(@NotNull Path projectPath, @NotNull CommandLineInspectionProgressReporter logger) {
logger.reportMessage(3, "Python environment configuration...");
List<Sdk> sdks = PythonSdkUtil.getAllSdks();
logger.logMessageLn(3, "Python interpreters detected:");
logger.reportMessage(3, "Python interpreters detected:");
for (Sdk sdk : sdks) {
logger.logMessageLn(3, sdk.getHomePath());
logger.reportMessage(3, sdk.getHomePath());
}
if (sdks.isEmpty()) {
final List<Sdk> detectedSdks = PySdkExtKt.findAllPythonSdks(projectPath);
if (detectedSdks.size() > 0) {
for (Sdk sdk : detectedSdks) {
logger.logMessageLn(3, sdk.getHomePath());
logger.reportMessage(3, sdk.getHomePath());
}
final Sdk sdk = detectedSdks.get(0);
ApplicationManager.getApplication().runWriteAction(() -> {
logger.logMessageLn(1, "Settings up interpreter " + sdk.getName());
logger.reportMessage(1, "Settings up interpreter " + sdk.getName());
ProjectJdkTable.getInstance().addJdk(sdk);
});
PythonSdkUpdater.update(sdk, null, null, null);
} else {
logger.logMessageLn(1, "ERROR: Can't find Python interpreter");
logger.reportMessage(1, "ERROR: Can't find Python interpreter");
}
}
}
@Override
public void configureProject(@NotNull Project project, @NotNull AnalysisScope scope, @NotNull CommandLineInspectionLogger logger) {
public void configureProject(@NotNull Project project, @NotNull AnalysisScope scope, @NotNull CommandLineInspectionProgressReporter logger) {
List<Sdk> sdks = PythonSdkUtil.getAllSdks();
if (!sdks.isEmpty()) {
PythonFacetType facetType = PythonFacetType.getInstance();