hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-27 16:57:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Rewrite comparing references inspection

Browse Source 
Rewrite inspections tutorial doc
This commit is contained in:
JohnHake 2019-03-24 21:46:05 -07:00
parent 19b283d995
commit 0639ae696e
23 changed files with 393 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
comparing_references_inspection/comparing_references_inspection.iml
View File

@ -1,11 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="PLUGIN_MODULE" version="4">
<component name="DevKit.ModuleBuildProperties" url="file://$MODULE_DIR$/source/META-INF/plugin.xml" />
<component name="DevKit.ModuleBuildProperties" url="file://$MODULE_DIR$/resources/META-INF/plugin.xml" />
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/source" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/testSource" isTestSource="true" />
<sourceFolder url="file://$MODULE_DIR$/resources" type="java-resource" />
<sourceFolder url="file://$MODULE_DIR$/testData" type="java-test-resource" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />

72
comparing_references_inspection/resources/META-INF/plugin.xml Normal file
View File

@ -0,0 +1,72 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<idea-plugin>
<!-- Unique id for this plugin. Must stay constant for the life of the plugin. -->
<id>org.intelliJ.sdk.codeInspection</id>
<!-- Text to display as name on Preferences/Settings | Plugin page -->
<name>SDK Comparing References Inspection Sample</name>
<!-- The version of this plugin -->
<version>1.1.0</version>
<!-- Compatible with the following versions of IntelliJ Platform -->
<idea-version since-build="173"/>
<!-- Text to display as description on Preferences/Settings | Plugin page -->
<description>
<![CDATA[
Demonstrates implementing a Local Inspection Tool.<br> Adds entries to <b>Preferences | Editor | Inspections | Java | Probable Bugs</b>.
]]>
</description>
<change-notes>
<![CDATA[
<ul>
<li><b>1.1.0</b> Refactor resources, register this inspection.</li>
<li><b>1.0.0</b> Release 2018.3 and earlier.</li>
</ul>
]]>
</change-notes>
<!-- Text to display as company information on Preferences/Settings | Plugin page -->
<vendor email="sdk-example@jetbrains.com" url="https://plugins.jetbrains.com">IntelliJ Platform SDK</vendor>
<extensions defaultExtensionNs="com.intellij">
<!-- Extend the IntelliJ Platform local inspection type, and connect it to the implementation class
in this plugin.
<localInspection> type element is applied within the scope of a file under edit.
It is preferred over <inspectionToolProvider>
@see intellij.platform.resources.LangExtensionPoints
@see com.intellij.codeInspection.InspectionProfileEntry
Attributes:
language= Defines the type of file (in this case java source) for this inspection. Not localized
shortName= The default name for the inspection, e.g. the default
for name for the description file "ComparingReferences.html". Not localized.
displayName= The string to be shown in the Preferences | Editor | Inspections panel
The displayName gets registered to identify this inspection.
Can be localized using key= and bundle= attributes instead.
groupPath= Defines the outermost grouping for this inspection in
the Preferences | Editor | Inspections panel. Not localized.
groupBundle= Name of *.bundle file to translate groupKey.
In this case reuse an IntelliJ Platform bundle file from intellij.platform.resources.en
groupKey= Key to use for translation subgroup name using groupBundle file.
In this case reuse the IntelliJ Platform subcategory "Probable bugs"
enabledByDefault= Inspection state when Inspections panel is created.
level= The default level of error found by this inspection, e.g. INFO, ERROR, etc.
@see com.intellij.codeHighlighting.HighlightDisplayLevel
inplementationClass= package.className of implementation
-->
<localInspection language="JAVA"
shortName="ComparingReferences"
displayName="SDK: '==' or '!=' used instead of 'equals()'"
groupPath="Java"
groupBundle="messages.InspectionsBundle"
groupKey="group.names.probable.bugs"
enabledByDefault="true"
level="WARNING"
implementationClass="com.intellij.codeInspection.ComparingReferencesInspection"/>
</extensions>
</idea-plugin>

7
comparing_references_inspection/resources/inspectionDescriptions/ComparingReferences.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<b>SDK:</b> This inspection reports when the '==' or '!=' operator was used between expressions of
reference types. <br>
Classes to be inspected are controlled by a semi-colon separated <i>Options</i> list in the preferences panel for this inspection.
</body>
</html>

14
comparing_references_inspection/source/META-INF/plugin.xml
View File

@ -1,14 +0,0 @@
<idea-plugin>
<name>Comparing References Inspection</name>
<description>Inspection for (probably) inappropriate use of equality relation operation.</description>
<version>1.0</version>
<vendor>JetBrains</vendor>
<!--
<idea-version since-build="3000"/>
-->
<extensions defaultExtensionNs="com.intellij">
<inspectionToolProvider implementation="com.intellij.codeInspection.ComparingReferencesProvider"/>
</extensions>
</idea-plugin>

196
comparing_references_inspection/source/com/intellij/codeInspection/ComparingReferencesInspection.java
View File

@ -1,105 +1,167 @@
package com.intellij.codeInspection;
import com.intellij.codeInsight.daemon.GroupNames;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.tree.IElementType;
import com.intellij.ui.DocumentAdapter;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.*;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import java.awt.*;
import java.util.StringTokenizer;
import static com.siyeh.ig.psiutils.ExpressionUtils.isNullLiteral;
/**
* @author max
* @author jhake
*/
public class ComparingReferencesInspection extends AbstractBaseJavaLocalInspectionTool {
private static final Logger LOG = Logger.getInstance("#com.intellij.codeInspection.ComparingReferencesInspection");
private final LocalQuickFix myQuickFix = new MyQuickFix();
private final CriQuickFix myQuickFix = new CriQuickFix();
// Defines the text of the quick fix intention
public static final String QUICK_FIX_NAME = "SDK: " + InspectionsBundle.message("inspection.comparing.references.use.quickfix");
// This string holds a list of classes relevant to this inspection.
@SuppressWarnings({"WeakerAccess"})
@NonNls
public String CHECKED_CLASSES = "java.lang.String;java.util.Date";
@NonNls
private static final String DESCRIPTION_TEMPLATE =
InspectionsBundle.message("inspection.comparing.references.problem.descriptor");
@NotNull
public String getDisplayName() {
return "'==' or '!=' instead of 'equals()'";
/**
* This method is called to get the panel describing the inspection.
* It is called every time the user selects the inspection in preferences.
* The user has the option to edit the list of CHECKED_CLASSES.
* Adds a document listener to see if
*
* @return panel to display inspection information.
*/
@Override
public JComponent createOptionsPanel() {
JPanel panel = new JPanel(new FlowLayout(FlowLayout.LEFT));
final JTextField checkedClasses = new JTextField(CHECKED_CLASSES);
checkedClasses.getDocument().addDocumentListener(new DocumentAdapter() {
public void textChanged(DocumentEvent event) {
CHECKED_CLASSES = checkedClasses.getText();
}
});
panel.add(checkedClasses);
return panel;
}
@NotNull
public String getGroupDisplayName() {
return GroupNames.BUGS_GROUP_NAME;
}
@NotNull
public String getShortName() {
return "ComparingReferences";
}
private boolean isCheckedType(PsiType type) {
if (!(type instanceof PsiClassType)) return false;
StringTokenizer tokenizer = new StringTokenizer(CHECKED_CLASSES, ";");
while (tokenizer.hasMoreTokens()) {
String className = tokenizer.nextToken();
if (type.equalsToText(className)) return true;
}
return false;
}
/**
* This method is overridden to provide a custom visitor
* that inspects expressions with relational operators '==' and '!='
* The visitor must not be recursive and must be thread-safe.
*
* @param holder object for visitor to register problems found.
* @param isOnTheFly true if inspection was run in non-batch mode
* @return non-null visitor for this inspection.
* @see JavaElementVisitor
*/
@NotNull
@Override
public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder, boolean isOnTheFly) {
return new JavaElementVisitor() {
/**
* This string defines the short message shown to a user signaling the inspection
* found a problem. It reuses a string from the inspections bundle.
*/
@NonNls
private final String DESCRIPTION_TEMPLATE = "SDK " + InspectionsBundle.message("inspection.comparing.references.problem.descriptor");
/**
* Avoid defining visitors for both Reference and Binary expressions.
*
* @param psiReferenceExpression The expression to be evaluated.
*/
@Override
public void visitReferenceExpression(PsiReferenceExpression psiReferenceExpression) {
}
/**
* Evaluate binary psi expressions to see if they contain
* relational operators '==' and '!=', AND they contain
* classes contained in CHECKED_CLASSES. The evaluation
* ignores expressions comparing an object to null.
* IF this criteria is met, add the expression to the
* problems list.
*
* @param expression The binary expression to be evaluated.
*/
@Override
public void visitBinaryExpression(PsiBinaryExpression expression) {
super.visitBinaryExpression(expression);
IElementType opSign = expression.getOperationTokenType();
if (opSign == JavaTokenType.EQEQ || opSign == JavaTokenType.NE) {
// The binary expression is the correct type for this inspection
PsiExpression lOperand = expression.getLOperand();
PsiExpression rOperand = expression.getROperand();
if (rOperand == null || isNullLiteral(lOperand) || isNullLiteral(rOperand)) return;
if (rOperand == null || isNullLiteral(lOperand) || isNullLiteral(rOperand))
return;
// Nothing is compared to null, now check the types being compared
PsiType lType = lOperand.getType();
PsiType rType = rOperand.getType();
if (isCheckedType(lType) || isCheckedType(rType)) {
// Identified an expression with potential problems, add to list with fix object.
holder.registerProblem(expression,
DESCRIPTION_TEMPLATE, myQuickFix);
}
}
}
/**
* Verifies the input is the correct {@code PsiType} for this inspection.
*
* @param type The {@code PsiType} to be examined for a match
* @return {@code true} if input is {@code PsiClassType} and matches
* one of the classes in the CHECKED_CLASSES list.
*/
private boolean isCheckedType(PsiType type) {
if (!(type instanceof PsiClassType))
return false;
StringTokenizer tokenizer = new StringTokenizer(CHECKED_CLASSES, ";");
while (tokenizer.hasMoreTokens()) {
String className = tokenizer.nextToken();
if (type.equalsToText(className))
return true;
}
return false;
}
};
}
private static boolean isNullLiteral(PsiExpression expr) {
return expr instanceof PsiLiteralExpression && "null".equals(expr.getText());
}
private static class MyQuickFix implements LocalQuickFix {
/**
* This class provides a solution to inspection problem expressions by manipulating
* the PSI tree to use a.equals(b) instead of '==' or '!='
*/
private static class CriQuickFix implements LocalQuickFix {
/**
* Returns a partially localized string for the quick fix intention.
* Used by the test code for this plugin.
*
* @return Quick fix short name.
*/
@NotNull
@Override
public String getName() {
// The test (see the TestThisPlugin class) uses this string to identify the quick fix action.
return InspectionsBundle.message("inspection.comparing.references.use.quickfix");
return QUICK_FIX_NAME;
}
/**
* This method manipulates the PSI tree to replace 'a==b' with 'a.equals(b)
* or 'a!=b' with '!a.equals(b)'
*
* @param project The project that contains the file being edited.
* @param descriptor A problem found by this inspection.
*/
public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
try {
PsiBinaryExpression binaryExpression = (PsiBinaryExpression) descriptor.getPsiElement();
@ -108,16 +170,16 @@ public class ComparingReferencesInspection extends AbstractBaseJavaLocalInspecti
PsiExpression rExpr = binaryExpression.getROperand();
if (rExpr == null)
return;
PsiElementFactory factory = JavaPsiFacade.getInstance(project).getElementFactory();
PsiMethodCallExpression equalsCall =
(PsiMethodCallExpression) factory.createExpressionFromText("a.equals(b)", null);
(PsiMethodCallExpression) factory.createExpressionFromText("a.equals(b)", null);
equalsCall.getMethodExpression().getQualifierExpression().replace(lExpr);
equalsCall.getArgumentList().getExpressions()[0].replace(rExpr);
PsiExpression result = (PsiExpression) binaryExpression.replace(equalsCall);
if (opSign == JavaTokenType.NE) {
PsiPrefixExpression negation = (PsiPrefixExpression) factory.createExpressionFromText("!a", null);
negation.getOperand().replace(result);
@ -127,27 +189,11 @@ public class ComparingReferencesInspection extends AbstractBaseJavaLocalInspecti
LOG.error(e);
}
}
@NotNull
public String getFamilyName() {
return getName();
}
}
public JComponent createOptionsPanel() {
JPanel panel = new JPanel(new FlowLayout(FlowLayout.LEFT));
final JTextField checkedClasses = new JTextField(CHECKED_CLASSES);
checkedClasses.getDocument().addDocumentListener(new DocumentAdapter() {
public void textChanged(DocumentEvent event) {
CHECKED_CLASSES = checkedClasses.getText();
}
});
panel.add(checkedClasses);
return panel;
}
public boolean isEnabledByDefault() {
return true;
}
}

2
comparing_references_inspection/source/com/intellij/codeInspection/ComparingReferencesProvider.java
View File

@ -1,6 +1,8 @@
package com.intellij.codeInspection;
/**
* This class provides a list of inspections (classes) for this plugin.
* Each inspection class should have a corresponding entry in plugin.xml
* @author max
*/
public class ComparingReferencesProvider implements InspectionToolProvider {

7
comparing_references_inspection/source/inspectionDescriptions/ComparingReferences.html
View File

@ -1,7 +0,0 @@
<html>
<body>
This inspection reports when the '==' or '!=' operator was used between expressions of
reference types. <br>
In the text field below, specify the semicolon separated list of classes to be considered as suspicious.
</body>
</html>

63
comparing_references_inspection/testSource/testPlugin/TestThisPlugin.java
View File

@ -4,73 +4,84 @@ package testPlugin;
import com.intellij.codeInsight.daemon.impl.HighlightInfo;
import com.intellij.codeInsight.intention.IntentionAction;
import com.intellij.codeInspection.ComparingReferencesInspection;
import com.intellij.codeInspection.InspectionToolProvider;
import com.intellij.testFramework.TestDataPath;
import com.intellij.openapi.application.PathManager;
import com.intellij.testFramework.UsefulTestCase;
import com.intellij.testFramework.builders.JavaModuleFixtureBuilder;
import com.intellij.testFramework.fixtures.*;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* @see JavaCodeInsightFixtureTestCase
* @see LightCodeInsightFixtureTestCase
*/
@TestDataPath("$CONTENT_ROOT/../testData")
public class TestThisPlugin extends UsefulTestCase {
protected CodeInsightTestFixture myFixture;
// TODO: Get path to module root, then add path to testData
// Specify path to your test data directory
// e.g. final String dataPath = "c:\\users\\john.doe\\idea\\community\\samples\\ComparingReferences/testData";
final String dataPath = "c:\\users\\John.Doe\\idea\\community\\samples\\comparingReferences/testData";
// Specify the path to the test data directory
final String dataPath = PathManager.getResourceRoot(TestThisPlugin.class, "/testPlugin/TestThisPlugin.class");
@Before
public void setUp() throws Exception {
final IdeaTestFixtureFactory fixtureFactory = IdeaTestFixtureFactory.getFixtureFactory();
final TestFixtureBuilder<IdeaProjectTestFixture> testFixtureBuilder =
fixtureFactory.createFixtureBuilder(getName());
fixtureFactory.createFixtureBuilder(getName());
myFixture = JavaTestFixtureFactory.getFixtureFactory().createCodeInsightFixture(testFixtureBuilder.getFixture());
myFixture.setTestDataPath(dataPath);
final JavaModuleFixtureBuilder builder = testFixtureBuilder.addModule(JavaModuleFixtureBuilder.class);
builder.addContentRoot(myFixture.getTempDirPath()).addSourceRoot("");
builder.setMockJdkLevel(JavaModuleFixtureBuilder.MockJdkLevel.jdk15);
myFixture.setUp();
}
@After
public void tearDown() throws Exception {
myFixture.tearDown();
myFixture = null;
}
protected void doTest(String testName, String hint) throws Throwable {
myFixture.configureByFile(testName + ".java");
myFixture.enableInspections(ComparingReferencesInspection.class);
List<HighlightInfo> highlightInfos = myFixture.doHighlighting();
Assert.assertTrue(!highlightInfos.isEmpty());
final IntentionAction action = myFixture.findSingleIntention(hint);
Assert.assertNotNull(action);
myFixture.launchAction(action);
myFixture.checkResultByFile(testName + ".after.java");
}
// Test the "==" case
/**
* Test the "==" case
* Note the hint must match CriQuickFix#getName
*
* @throws Throwable
*/
@Test
public void test() throws Throwable {
doTest("before", "Use equals()");
// doTest("before", "Use equals()");
doTest("before", ComparingReferencesInspection.QUICK_FIX_NAME);
}
// Test the "!=" case
/**
* Test the "!=" case
* Note the hint must match CriQuickFix#getName
* @throws Throwable
*/
@Test
public void test1() throws Throwable {
doTest("before1", "Use equals()");
doTest("before1", ComparingReferencesInspection.QUICK_FIX_NAME);
}
}

27
conditional_operator_intention/META-INF/plugin.xml
View File

@ -1,27 +0,0 @@
<idea-plugin>
<name>Conditional Operator Converter</name>
<id>ConditionalOperatorConverter</id>
<description>Intention action that suggests to convert a conditional operator into
'if' block.
</description>
<version>1.3</version>
<vendor>JetBrains</vendor>
<!--
<idea-version since-build="2000"/>
-->
<extensions defaultExtensionNs="com.intellij">
<intentionAction>
<className>com.intellij.codeInsight.intention.ConditionalOperatorConvertor</className>
<category>Conditional Operator</category>
<descriptionDirectoryName>ConditionalOperatorConvertor</descriptionDirectoryName>
</intentionAction>
</extensions>
<project-components>
<component>
<implementation-class>com.intellij.codeInsight.intention.ConditionalOperatorConvertor</implementation-class>
</component>
</project-components>
</idea-plugin>

3
conditional_operator_intention/conditional_operator_intention.iml
View File

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="PLUGIN_MODULE" version="4">
<component name="DevKit.ModuleBuildProperties" url="file://$MODULE_DIR$/META-INF/plugin.xml" />
<component name="DevKit.ModuleBuildProperties" url="file://$MODULE_DIR$/resources/META-INF/plugin.xml" />
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/source" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/testSource" isTestSource="true" />
<sourceFolder url="file://$MODULE_DIR$/testData" type="java-test-resource" />
<sourceFolder url="file://$MODULE_DIR$/resources" type="java-resource" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />

46
conditional_operator_intention/resources/META-INF/plugin.xml Normal file
View File

@ -0,0 +1,46 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<idea-plugin>
<!-- Unique id for this plugin. Must stay constant for the life of the plugin. -->
<id>ConditionalOperatorConverter</id>
<!-- Text to display as name on Preferences/Settings | Plugin page -->
<name>SDK Conditional Operator Converter</name>
<!-- The version of this plugin -->
<version>1.4.0</version>
<!-- Compatible with the following versions of IntelliJ Platform -->
<idea-version since-build="191"/>
<!-- Text to display as description on Preferences/Settings | Plugin page -->
<description>
<![CDATA[
Intention action that suggests converting a ternary operator into an 'if' block.<br>Adds entry to <b>Preferences | Editor | Intentions | SDK Intentions<b>.
]]>
</description>
<change-notes>
<![CDATA[
<ul>
<li><b>1.4.0</b> Refactor resources, general cleanup.</li>
<li><b>1.3.0</b> Release 2018.3 and earlier.</li>
</ul>
]]>
</change-notes>
<!-- Text to display as company information on Preferences/Settings | Plugin page -->
<vendor email="sdk-example@jetbrains.com" url="https://plugins.jetbrains.com">IntelliJ Platform SDK</vendor>
<extensions defaultExtensionNs="com.intellij">
<intentionAction>
<className>com.intellij.codeInsight.intention.ConditionalOperatorConvertor</className>
<category>SDK Intentions</category>
</intentionAction>
</extensions>
<project-components>
<component>
<implementation-class>com.intellij.codeInsight.intention.ConditionalOperatorConvertor</implementation-class>
</component>
</project-components>
</idea-plugin>

0
conditional_operator_intention/source/intentionDescriptions/ConditionalOperatorConvertor/after.java.template → conditional_operator_intention/resources/intentionDescriptions/ConditionalOperatorIntention/after.java.template
View File

0
conditional_operator_intention/source/intentionDescriptions/ConditionalOperatorConvertor/before.java.template → conditional_operator_intention/resources/intentionDescriptions/ConditionalOperatorIntention/before.java.template
View File

7
conditional_operator_intention/resources/intentionDescriptions/ConditionalOperatorIntention/description.html Normal file
View File

@ -0,0 +1,7 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<html>
<body>
<b>SDK:</b> This intention converts a ternary operator to a corresponding if statement. <br>
</body>
</html>

17
conditional_operator_intention/source/com/intellij/codeInsight/intention/ConditionalOperatorConvertor.java
View File

@ -1,6 +1,5 @@
/*
* Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
*/
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.codeInsight.intention;
@ -26,21 +25,21 @@ public class ConditionalOperatorConvertor extends PsiElementBaseIntentionAction
*/
@NotNull
public String getText() {
return "Convert ternary operator to if statement";
return "SDK Convert ternary operator to if statement";
}
/**
* Returns text for name of this family of intentions. It is used to externalize
* "auto-show" state of intentions. Only one intention action is being provided,
* so the family name is the same text as the intention action list entry.
* "auto-show" state of intentions.
* It is also the directory name for the descriptions.
*
* @return the intention family name.
* @see ConditionalOperatorConvertor#getText()
* @see com.intellij.codeInsight.intention.IntentionManager#registerIntentionAndMetaData(IntentionAction, String...)
* @return the intention family name.
*/
@NotNull
public String getFamilyName() {
return getText();
return "ConditionalOperatorIntention";
}

5
conditional_operator_intention/source/intentionDescriptions/ConditionalOperatorConvertor/description.html
View File

@ -1,5 +0,0 @@
<html>
<body>
This intention converts a ternary operator to a corresponding if statement. <br>
</body>
</html>

4
conditional_operator_intention/testSource/testPlugin/YourTest.java
View File

@ -1,3 +1,5 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package testPlugin;
import com.intellij.codeInsight.intention.IntentionAction;
@ -52,7 +54,7 @@ public class YourTest extends UsefulTestCase {
@Test
public void test() {
doTest("before.template", "Convert ternary operator to if statement");
doTest("before.template", "SDK Convert ternary operator to if statement");
}
}

64
inspection/resources/META-INF/plugin.xml
View File

@ -1,15 +1,67 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<idea-plugin>
<!-- Unique id for this plugin. Must stay constant for the life of the plugin. -->
<id>com.intellij.tutorials.inspection</id>
<name>Inspection Demo</name>
<version>1.0</version>
<vendor>JetBrains</vendor>
<description>Basic example of working with code inspections</description>
<!-- Text to display as name on Preferences/Settings | Plugin page -->
<name>SDK Inspection Demo</name>
<idea-version since-build="131"/>
<!-- The version of this plugin -->
<version>1.1.0</version>
<!-- Compatible with the following versions of IntelliJ Platform -->
<idea-version since-build="191"/>
<!-- Text to display as description on Preferences/Settings | Plugin page -->
<description>
<![CDATA[
Basic example of working with code inspections. Adds entry to <b>Preferences | Editor | Inspections | SDK | Example Tools</b>.
]]>
</description>
<change-notes>
<![CDATA[
<ul>
<li><b>1.1.0</b> Refactor resources, add "SDK" to description.</li>
<li><b>1.0.0</b> Release 2018.3 and earlier.</li>
</ul>
]]>
</change-notes>
<!-- Text to display as company information on Preferences/Settings | Plugin page -->
<vendor email="sdk-example@jetbrains.com" url="https://plugins.jetbrains.com">IntelliJ Platform SDK</vendor>
<extensions defaultExtensionNs="com.intellij">
<inspectionToolProvider implementation="com.intellij.tutorials.inspection.DemoInspectionToolProvider"/>
<!-- Extend the IntelliJ Platform local inspection type, and connect it to the implementation class
in this plugin.
<localInspection> type element is applied within the scope of a file under edit.
It is preferred over <inspectionToolProvider>
@see intellij.platform.resources.LangExtensionPoints
@see com.intellij.codeInspection.InspectionProfileEntry
Attributes:
language= Defines the type of file (in this case java source) for this inspection. Not localized
shortName= The default name for the inspection, e.g. the default
for name for the description file "DemoCode.html". Not localized.
displayName= The string to be shown in the Preferences | Editor | Inspections panel
The displayName gets registered to identify this inspection.
Can be localized using key= and bundle= attributes instead.
groupPath= Defines the outermost grouping for this inspection in
the Preferences | Editor | Inspections panel. Not localized.
groupName= The subgroup containing this inspection. Not localized.
enabledByDefault= Inspection state when Inspections panel is created.
level= The default level of error found by this inspection, e.g. INFO, ERROR, etc.
@see com.intellij.codeHighlighting.HighlightDisplayLevel
inplementationClass= package.className of inspection implementation
-->
<localInspection language="JAVA"
shortName="DemoCode"
displayName="Demo Inspection"
groupName="Example Inspections"
groupPath="SDK"
enabledByDefault="true"
level="WARNING"
implementationClass="com.intellij.tutorials.inspection.DemoCodeInspection"/>
</extensions>
</idea-plugin>

9
inspection/resources/inspectionDescriptions/DemoCode.html Normal file
View File

@ -0,0 +1,9 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<html>
<body>
<b>SDK:</b> Write your description here.<br>
<!-- tooltip end -->
Text after this comment will not be shown in tooltips.
</body>
</html>

23
inspection/src/com/intellij/tutorials/inspection/DemoCodeInspection.java
View File

@ -1,19 +1,24 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.tutorials.inspection;
import com.intellij.codeInspection.*;
import org.jetbrains.annotations.*;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.ProblemsHolder;
import org.jetbrains.annotations.NotNull;
/**
* @author Anna Bulenkova
*/
public class DemoCodeInspection extends LocalInspectionTool {
@Nls
@NotNull
@Override
public String getDisplayName() {
return "Demo Inspection";
}
/**
* This method is overridden to provide a custom visitor
* The visitor must not be recursive and must be thread-safe.
*
* @param holder object for visitor to register problems found.
* @param isOnTheFly true if inspection was run in non-batch mode
* @return DemoInspectionVisitor.
*/
@NotNull
@Override
public DemoInspectionVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {

2
inspection/src/com/intellij/tutorials/inspection/DemoInspectionToolProvider.java
View File

@ -1,3 +1,5 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.tutorials.inspection;
import com.intellij.codeInspection.InspectionToolProvider;

2
inspection/src/com/intellij/tutorials/inspection/DemoInspectionVisitor.java
View File

@ -1,3 +1,5 @@
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.tutorials.inspection;
import com.intellij.psi.*;

7
inspection/src/inspectionDescriptions/DemoCode.html
View File

@ -1,7 +0,0 @@
<html>
<body>
Write your description here.
<!-- tooltip end -->
Text after this comment will not be shown in tooltips.
</body>
</html>