/*@jsxRuntime automatic @jsxImportSource react*/ const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = Object.assign({ p: "p", a: "a", strong: "strong", h2: "h2", ol: "ol", li: "li", code: "code", figure: "figure", pre: "pre", span: "span" }, _provideComponents(), props.components), {References} = _components; if (!References) _missingMdxReference("References", true); return _jsxs(_Fragment, { children: [_jsx("div", { align: "center", children: _jsx("img", { alt: "Image description", src: "/series/0001/custom-inspections-and-quick-fixes-topbanner.png", width: "80%", style: { borderRadius: "12px", marginTop: "10px", marginBottom: "20px" } }) }), "\n", _jsxs(_components.p, { children: [_jsx(_components.a, { href: "https://www.jetbrains.com/help/idea/code-inspection.html", children: "Inspections" }), " and ", _jsx(_components.a, { href: "https://www.jetbrains.com/resharper/features/quick_fixes.html", children: "Quick Fixes" }), " are essential tools in the IntelliJ IDEA based IDEs.\nThey help you to maintain the code quality and improve the development process, by highlighting the issues and ", _jsx(_components.strong, { children: "providing ready-to-use solutions" }), ".\nIntelliJ Development seems to be a hard topic, but I will show you that it's not that difficult to implement these features."] }), "\n", _jsx(_components.h2, { id: "pretty-use-cases", children: "Pretty use cases" }), "\n", _jsx(_components.p, { children: "When I decided to write this article, I was thinking about the most common use cases,\nbut what is better than a real-life example?\nA few months ago I was working on an annotation-based framework\nwhere a lot of developers had problems with the correct usage of the annotations.\nThe framework was quite complex, and the documentation was not enough to cover all the cases.\nI decided to create an IntelliJ Plugin that\nwould help developers by providing quick fixes for the most common issues." }), "\n", _jsx(_components.p, { children: "There are a few examples of the issues that I wanted to solve:" }), "\n", _jsxs(_components.ol, { children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Missing annotation" }), ": The developer forgot to add the annotation to the parameter."] }), "\n"] }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/example-1.png", width: "70%", style: { borderRadius: "12px" } }), "\n", _jsxs(_components.ol, { start: "2", children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Mixed annotations" }), ": The developer added two annotations that are not compatible with each other."] }), "\n"] }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/example-2.png", width: "70%", style: { borderRadius: "12px" } }), "\n", _jsxs(_components.ol, { start: "3", children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Primitive type for the nullable parameter" }), ": The developer used a primitive type for the parameter that can be null."] }), "\n"] }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/example-3.png", width: "70%", style: { borderRadius: "12px" } }), "\n", _jsxs(_components.ol, { start: "4", children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Invalid value for the annotation" }), ": The developer used an invalid value for the annotation."] }), "\n"] }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/example-4.png", width: "70%", style: { borderRadius: "12px" } }), "\n", _jsx("br", {}), "\n", _jsx(_components.h2, { id: "what-is-the-plan", children: "What is the plan?" }), "\n", _jsx(_components.p, { children: "Now, let's start coding.\nI'll show you how to create inspections and quick fixes in a simpler case." }), "\n", _jsxs(_components.p, { children: ["Imagine that you love the ", _jsx(_components.a, { href: "https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html", children: "Optional" }), " class from Java 8,\nand you want to use it in your project.\nYou know that it's a good practice to use ", _jsx(_components.code, { children: "Optional" }), " instead of ", _jsx(_components.code, { children: "null" }), ",\nbut you are tired of writing the same code that wraps the value in ", _jsx(_components.code, { children: "Optional" }), "."] }), "\n", _jsx(_components.h2, { id: "lets-start-with-the-inspection", children: "Let's start with the inspection" }), "\n", _jsxs(_components.p, { children: ["The first step is to create an inspection that will highlight the places where you can use ", _jsx(_components.code, { children: "Optional" }), " instead of ", _jsx(_components.code, { children: "null" }), ".\nWe can resolve only method annotated with ", _jsx(_components.code, { children: "@Nullable" }), " to simplify the example."] }), "\n", _jsxs(_components.p, { children: ["Define the inspection class that extends the ", _jsx(_components.code, { children: "LocalInspectionTool" }), " class:"] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "java", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "java", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: "public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " class" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalInspection" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " extends" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " LocalInspectionTool" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " String" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " getDisplayName" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \"Method uses @Nullable annotation\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " String" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " getGroupDisplayName" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \"MyPlugin\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " boolean" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " isEnabledByDefault" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " true" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiElementVisitor" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " buildVisitor" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "ProblemsHolder" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " holder" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " boolean" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " isOnTheFly) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " MethodVisitor(holder)" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: "}" }) })] }) }) }), "\n", _jsxs(_components.p, { children: ["Now, we need to define the ", _jsx(_components.code, { children: "MethodVisitor" }), " that will visit the methods and check if they are annotated with ", _jsx(_components.code, { children: "@Nullable" }), ":"] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "java", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "java", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: "class" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " MethodVisitor" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " extends" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " JavaElementVisitor" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " private" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " final" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " ProblemsHolder" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " holder;" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " MethodVisitor" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "ProblemsHolder" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " holder) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " this" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "holder" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " =" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " holder;" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " void" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " visitMethod" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiMethod" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiAnnotation" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " annotation " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getAnnotation" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "Nullable" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "class" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getName" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "());" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiTypeElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " typeElement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getReturnTypeElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (annotation " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " ||" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " typeElement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " holder" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "registerProblem" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " typeElement" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#22863A" }, children: " \"Method uses @Nullable annotation\"" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " ProblemHighlightType" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "WARNING" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalQuickFix(method)" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " );" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: "}" }) })] }) }) }), "\n", _jsxs(_components.p, { children: ["Psi elements are the core of the IntelliJ Platform API.\nThey represent the elements of the code, like classes, methods, fields, etc.\nIn this case, we are using ", _jsx(_components.code, { children: "PsiMethod" }), " and ", _jsx(_components.code, { children: "PsiAnnotation" }), " to check if the method is annotated with ", _jsx(_components.code, { children: "@Nullable" }), "."] }), "\n", _jsxs(_components.p, { children: ["Also, we are registering a problem for the ", _jsx(_components.code, { children: "PsiTypeElement" }), " to highlight the return type of the method.\nSee how cool it is!"] }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/inspection.png", width: "60%", style: { borderRadius: "18px" } }), "\n", _jsx("br", {}), "\n", _jsx(_components.h2, { id: "but-what-about-the-quick-fix", children: "But what about the quick fix?" }), "\n", _jsxs(_components.p, { children: ["The quick fix is a solution that the developer can apply to fix the issue.\nYou can provide multiple quick fixes for the same problem\nor set another level of the problem e.g. ", _jsx(_components.code, { children: "ProblemHighlightType.GENERIC_ERROR" })] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "java", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "java", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: "holder" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "registerProblem" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " typeElement" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#22863A" }, children: " \"Method uses @Nullable annotation\"" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " ProblemHighlightType" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "WARNING" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalQuickFix(method)" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: ");" }) })] }) }) }), "\n", _jsxs(_components.p, { children: ["We register the quick fix in the ", _jsx(_components.code, { children: "registerProblem" }), " method, Let's define the ", _jsx(_components.code, { children: "UseOptionalQuickFix" }), " class:"] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "java", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "java", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: "public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " class" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalQuickFix" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " implements" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " LocalQuickFix" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " private" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " final" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiMethod" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method;" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalQuickFix" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiMethod" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " this" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "method" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " =" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method;" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " String" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " getFamilyName" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \"Use Optional instead of nullable\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " UseOptionalQuickFix" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " getFileModifierForPreview" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiFile" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " target) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " UseOptionalQuickFix(method)" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " void" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " applyFix" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Project" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " project" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " ProblemDescriptor" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " descriptor) {" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // 1. Import Optional class" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // Without this action, users would have to import the class manually." }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " this" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "importClass" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getContainingFile" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "()" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \"java.util.Optional\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ");" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // 2. Remove @Nullable annotation" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // We don't need it anymore." }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiAnnotation" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " annotation " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getAnnotation" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"org.jetbrains.annotations.Nullable\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ");" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (annotation " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "!=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " annotation" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "delete" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiElementFactory" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " factory " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " JavaPsiFacade" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getElementFactory" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getProject" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "());" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // 3. Wrap return type with Optional" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // We replace the return type with `Optional`." }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiTypeElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " typeElement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getReturnTypeElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (typeElement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "!=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " typeElement" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "replace" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " factory" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "createTypeElementFromText" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#22863A" }, children: " \"Optional<\"" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " +" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " typeElement" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getText" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "+" }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \">\"" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " )" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " );" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // 4. Wrap return statements" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // We wrap the return statements with `Optional.ofNullable`," }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // or `Optional.empty` if the return value is `null`." }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiCodeBlock" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " codeBlock " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " method" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getBody" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (codeBlock " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " for" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiReturnStatement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " returnStatement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: ":" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " this" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "findReturnStatements" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(codeBlock)) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiExpression" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " returnValue " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " returnStatement" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getReturnValue" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (returnValue " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " continue" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // wrap with Optional.empty" }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " String" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " text " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " returnValue" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getText" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "text" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "equals" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"null\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ")) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiExpression" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " optional " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " factory" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "createExpressionFromText" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"Optional.empty()\"" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method);" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " returnValue" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "replace" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(optional);" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " continue" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // wrap with Optional.ofNullable" }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiExpression" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " optional " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " factory" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "createExpressionFromText" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"Optional.ofNullable(\"" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " +" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " text " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "+" }), _jsx(_components.span, { style: { color: "#22863A" }, children: " \")\"" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " method);" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " returnValue" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "replace" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(optional);" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // Find all return statements in the code block" }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " private" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " List" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "<" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiReturnStatement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "> " }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "findReturnStatements" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " source) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " List" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "<" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiReturnStatement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "> statements " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " ArrayList" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "<>();" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " for" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiElement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " child " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: ":" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " source" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getChildren" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "()) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (child " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "instanceof" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiReturnStatement" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " returnStatement) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " statements" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "add" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(returnStatement);" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " continue" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (child " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "instanceof" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " PsiStatement " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "||" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " child " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "instanceof" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " PsiCodeBlock) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " statements" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "addAll" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "this" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "findReturnStatements" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(child));" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " statements;" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " private" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " void" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " importClass" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "PsiFile" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " file" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " String" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " classImport) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "!" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(file " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "instanceof" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiJavaFile" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " javaFile)) {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " throw" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " RuntimeException(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"Cannot add import to non-java file\"" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: ")" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " Project" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " project " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " file" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getProject" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "();" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " PsiClass" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " psiClass " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "=" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#D32F2F" }, children: " JavaPsiFacade" }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#212121" }, children: " ." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getInstance" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(project)" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#212121" }, children: " ." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "findClass" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(classImport" }), _jsx(_components.span, { style: { color: "#212121" }, children: "," }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " GlobalSearchScope" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "allScope" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(project));" })] }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (annotationClass " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " throw" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " RuntimeException(" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"Cannot find annotation class \"" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " +" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " classImport)" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ";" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " // Check if the class is already imported" }) }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " if" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " (" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "javaFile" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "findImportReferenceTo" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(psiClass) " }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "==" }), _jsx(_components.span, { style: { color: "#1976D2" }, children: " null" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ") {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#1976D2" }, children: " javaFile" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "importClass" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "(psiClass);" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: "}" }) })] }) }) }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.code, { children: "LocalQuickFix" }), " interface defines the ", _jsx(_components.code, { children: "applyFix" }), " method, that will be called when the developer clicks on the quick fix.\nIn this method, we are importing the ", _jsx(_components.code, { children: "Optional" }), " class, removing the ", _jsx(_components.code, { children: "@Nullable" }), " annotation, and wrapping the return type and return statements with ", _jsx(_components.code, { children: "Optional" }), ".\nAlso, we are using the ", _jsx(_components.code, { children: "PsiElementFactory" }), " to create new elements like ", _jsx(_components.code, { children: "PsiTypeElement" }), " or ", _jsx(_components.code, { children: "PsiExpression" }), " from the text."] }), "\n", _jsx(_components.h2, { id: "register-the-inspection", children: "Register the inspection" }), "\n", _jsxs(_components.p, { children: ["The last step is to register the inspection in the ", _jsx(_components.code, { children: "plugin.xml" }), " file.\nYou need to create a class that implements the ", _jsx(_components.code, { children: "InspectionToolProvider" }), " interface and return the inspection classes:"] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "java", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "java", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: "public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " class" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " InspectionProvider" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " implements" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " InspectionToolProvider" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "Override" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " public" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " Class" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "<" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "?" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " extends" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " LiteInspection" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "> @" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: "NotNull" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " [] " }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: "getInspectionClasses" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "() {" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#D32F2F" }, children: " return" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " new" }), _jsx(_components.span, { style: { color: "#D32F2F" }, children: " Class" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "[]{ " }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "UseOptionalInspection" }), _jsx(_components.span, { style: { color: "#212121" }, children: "." }), _jsx(_components.span, { style: { color: "#1976D2" }, children: "class" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: " };" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: " }" }) }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#24292EFF" }, children: "}" }) })] }) }) }), "\n", _jsxs(_components.p, { children: ["And add the extension in the ", _jsx(_components.code, { children: "plugin.xml" }), " file:"] }), "\n", _jsx(_components.figure, { "data-rehype-pretty-code-figure": "", children: _jsx(_components.pre, { style: { backgroundColor: "#ffffff", color: "#24292eff" }, tabIndex: "0", "data-language": "xml", "data-theme": "min-light", children: _jsxs(_components.code, { "data-language": "xml", "data-theme": "min-light", style: { display: "grid" }, children: [_jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: "<" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "idea-plugin" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ">" })] }), "\n", _jsx(_components.span, { "data-line": "", children: _jsx(_components.span, { style: { color: "#C2C3C5" }, children: " " }) }), "\n", _jsx(_components.span, { "data-line": "", children: " " }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " <" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "extensions" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " defaultExtensionNs" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "=" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"com.intellij\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: ">" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " <" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "inspectionToolProvider" }), _jsx(_components.span, { style: { color: "#6F42C1" }, children: " implementation" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "=" }), _jsx(_components.span, { style: { color: "#22863A" }, children: "\"dev.rollczi.myplugin.inspection.InspectionProvider\"" }), _jsx(_components.span, { style: { color: "#24292EFF" }, children: "/>" })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: " " })] }), "\n", _jsxs(_components.span, { "data-line": "", children: [_jsx(_components.span, { style: { color: "#24292EFF" }, children: "" })] })] }) }) }), "\n", _jsx(_components.p, { children: "That's it! Now you can build and install the plugin in your IDE." }), "\n", _jsx(_components.h2, { id: "results-and-summary", children: "Results and summary" }), "\n", _jsxs(_components.p, { children: ["In this article, I showed you how to create custom inspections and quick fixes in the IntelliJ Plugin.", _jsx("br", {}), "\nI hope you enjoyed it and learned something new."] }), "\n", _jsx(_components.p, { children: "Before" }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/before.png", width: "50%", style: { borderRadius: "18px" } }), "\n", _jsx(_components.p, { children: "After" }), "\n", _jsx("img", { alt: "Image description", src: "/series/0001/01/after.png", width: "50%", style: { borderRadius: "18px" } }), "\n", _jsx("br", {}), "\n", _jsx(References, { links: [{ title: "IntelliJ Platform SDK Documentation", url: "https://plugins.jetbrains.com/docs/intellij/welcome.html" }] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components); return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, { children: _jsx(_createMdxContent, props) })) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

rollczi

Series

IntelliJ Plugin Development

Articles