chore: update @nullable and putout version (#22)

openrewrite · Oct 10, 2024 · 1ca388e · 1ca388e
1 parent b48fb38
commit 1ca388e
Show file tree

Hide file tree

Showing 7 changed files with 440 additions and 236 deletions.
diff --git a/src/main/java/org/openrewrite/codemods/ApplyCodemod.java b/src/main/java/org/openrewrite/codemods/ApplyCodemod.java
@@ -17,9 +17,9 @@
 
 import lombok.EqualsAndHashCode;
 import lombok.Value;
+import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Option;
-import org.openrewrite.internal.lang.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/src/main/java/org/openrewrite/codemods/ESLint.java b/src/main/java/org/openrewrite/codemods/ESLint.java
@@ -20,10 +20,10 @@
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import lombok.EqualsAndHashCode;
 import lombok.Value;
+import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Option;
 import org.openrewrite.SourceFile;
-import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.marker.Marker;
 import org.openrewrite.marker.Markers;
 import org.openrewrite.marker.SearchResult;
@@ -60,24 +60,24 @@ public class ESLint extends NodeBasedRecipe {
 
     @Option(displayName = "Parser to be used by ESLint",
             description = "Parser used by ESLint to parse the source files. Defaults to `@typescript-eslint/parser`. " +
-                          "See [ESLint documentation](https://eslint.org/docs/latest/use/configure/parsers) for more details.",
+                    "See [ESLint documentation](https://eslint.org/docs/latest/use/configure/parsers) for more details.",
             example = "esprima",
             required = false)
     @Nullable
     String parser;
 
     @Option(displayName = "List of parser options for ESLint",
             description = "A list of parser options for ESLint. The format is `key: value`. Defaults to " +
-                          "`ecmaVersion: \"latest\", ecmaFeatures: { jsx: true }, sourceType: \"module\"`. See " +
-                          "[ESLint documentation](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options) for more details.",
+                    "`ecmaVersion: \"latest\", ecmaFeatures: { jsx: true }, sourceType: \"module\"`. See " +
+                    "[ESLint documentation](https://eslint.org/docs/latest/use/configure/language-options#specifying-parser-options) for more details.",
             example = "ecmaVersion: 6, ecmaFeatures: { jsx: true }",
             required = false)
     @Nullable
     List<String> parserOptions;
 
     @Option(displayName = "Allow inline configuration for ESLint",
             description = "Whether inline config comments are allowed. Defaults to `false`. See " +
-                          "[ESLint documentation](https://eslint.org/docs/latest/use/configure/rules#disabling-inline-comments) for more details.",
+                    "[ESLint documentation](https://eslint.org/docs/latest/use/configure/rules#disabling-inline-comments) for more details.",
             example = "true",
             required = false)
     @Nullable
@@ -113,10 +113,10 @@ public class ESLint extends NodeBasedRecipe {
 
     @Option(displayName = "ESLint rules and rule configuration",
             description = "List of rules to be checked by ESLint. Optionally, the severity and other rule options can " +
-                          "also be specified as e.g. `off`, `warn` or `[\"error\", \"always\"]`. " +
-                          "The severity `off` is useful when the rule is declared by an extended " +
-                          "[shareable config](https://eslint.org/docs/latest/extend/ways-to-extend#shareable-configs). " +
-                          "For more information, see the [ESLint documentation](https://eslint.org/docs/latest/use/configure/rules)",
+                    "also be specified as e.g. `off`, `warn` or `[\"error\", \"always\"]`. " +
+                    "The severity `off` is useful when the rule is declared by an extended " +
+                    "[shareable config](https://eslint.org/docs/latest/extend/ways-to-extend#shareable-configs). " +
+                    "For more information, see the [ESLint documentation](https://eslint.org/docs/latest/use/configure/rules)",
             example = "eqeqeq: warn, multiline-comment-style: [\"error\", \"starred-block\"], prettier/prettier",
             required = false)
     @Nullable
@@ -131,8 +131,8 @@ public class ESLint extends NodeBasedRecipe {
 
     @Option(displayName = "Override config file",
             description = "Allows specifying the full ESLint configuration file contents as multiline JSON. " +
-                          "See [ESLint documentation](https://eslint.org/docs/latest/use/configure/configuration-files) for more details.\n\n" +
-                          "Note that this will override any other configuration options.",
+                    "See [ESLint documentation](https://eslint.org/docs/latest/use/configure/configuration-files) for more details.\n\n" +
+                    "Note that this will override any other configuration options.",
             required = false)
     @Nullable
     String configFile;
@@ -145,7 +145,7 @@ public String getDisplayName() {
     @Override
     public String getDescription() {
         return "Run [ESLint](https://eslint.org/) across the code to fix common static analysis issues in the code.\n\n" +
-               "This requires the code to have an existing ESLint configuration.";
+                "This requires the code to have an existing ESLint configuration.";
     }
 
     @Override

diff --git a/src/main/java/org/openrewrite/codemods/NodeBasedRecipe.java b/src/main/java/org/openrewrite/codemods/NodeBasedRecipe.java
@@ -19,8 +19,9 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
+import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.Nullable;
 import org.openrewrite.*;
-import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.quark.Quark;
 import org.openrewrite.scheduling.WorkingDirectoryExecutionContextView;
 import org.openrewrite.text.PlainText;
@@ -167,7 +168,7 @@ protected void processOutput(Path out, Accumulator acc, ExecutionContext ctx) {
     public TreeVisitor<?, ExecutionContext> getVisitor(Accumulator acc) {
         return new TreeVisitor<Tree, ExecutionContext>() {
             @Override
-            public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
+            public @Nullable Tree visit(@Nullable Tree tree, @NotNull ExecutionContext ctx) {
                 if (tree instanceof SourceFile) {
                     SourceFile sourceFile = (SourceFile) tree;
                     // TODO parse sources like JSON where parser doesn't require an environment

diff --git a/src/main/java/org/openrewrite/codemods/Putout.java b/src/main/java/org/openrewrite/codemods/Putout.java
@@ -17,9 +17,9 @@
 
 import lombok.EqualsAndHashCode;
 import lombok.Value;
+import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Option;
-import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.scheduling.WorkingDirectoryExecutionContextView;
 
 import java.io.IOException;
@@ -45,8 +45,8 @@ public String getDescription() {
         return "Run [Putout](https://github.com/coderaiser/putout) on your projects.";
     }
 
-    @Option(displayName = "Config file",
-            description = "A list of rules to enable",
+    @Option(displayName = "Rules",
+            description = "Names of rules to enable. If not provided, all rules are enabled.",
             required = false)
     @Nullable
     Set<String> rules;
@@ -55,15 +55,16 @@ public String getDescription() {
     protected List<String> getNpmCommand(Accumulator acc, ExecutionContext ctx) {
         List<String> commands = new ArrayList<>();
         String executable = "${nodeModules}/.bin/putout";
+
         if (rules != null) {
             commands.add(executable + " ${repoDir} --disable-all || true"); // hacky because disable-all throws
 
+            // enable only rules that are provided
             for (String rule : rules) {
                 commands.add(executable + " ${repoDir} --enable " + rule);
             }
         }
 
-
         commands.add(executable + " ${repoDir}" + " --fix");
         return commands;
     }
@@ -87,6 +88,7 @@ protected void runNode(Accumulator acc, ExecutionContext ctx) {
                     .replace("${nodeModules}", nodeModules.toString())
                     .replace("${repoDir}", ".")
                     .replace("${parser}", acc.parser()));
+
         }
 
         Path out = null, err = null;