codemod 1.2.0

codemod: ^1.2.0 copied to clipboard

Breaking: runInteractiveCodemod and runInteractiveCodemodSequence are both now async.

Breaking: Suggestor is now a function typedef instead of a class. Addtionally, it takes the new FileContext type as its only parameter (previously the generatePatches method took a SourceFile) and now must return a Stream<Patch> instead of Iterable<Patch>.

If you were extending Suggestor, you can either change the class to a function like so:

  final String licenseHeader = '...';

- class LicenseHeaderInserter implements Suggestor {
-   @override
-   bool shouldSkip(String sourceFileContents) =>
-       sourceFileContents.trimLeft().startsWith(licenseHeader);
-
-   @override
-   Iterable<Patch> generatePatches(SourceFile sourceFile) sync* {
-     yield Patch(sourceFile, sourceFile.span(0, 0), licenseHeader);
-   }
- }

+ Stream<Patch> licenseHeaderInserter(FileContext context) async* {
+   // Skip if license header already exists.
+   if (context.sourceText.trimLeft().startsWith(licenseHeader)) return;
+
+   yield Patch(licenseHeader, 0, 0);
+ }

Or rename the generatePatches() method to call() so that the class is callable like a function:

  final String licenseHeader = '...';

- class LicenseHeaderInserter implements Suggestor {
+ class LicenseHeaderInserter {
-   @override
    bool shouldSkip(String sourceFileContents) =>
        sourceFileContents.trimLeft().startsWith(licenseHeader);

-   @override
-   Iterable<Patch> generatePatches(SourceFile sourceFile) sync* {
+   Stream<Patch> call(FileContext context) async* {
+     if (shouldSkip(context.sourceText)) return;
-     yield Patch(sourceFile, sourceFile.span(0, 0), licenseHeader);
+     yield Patch(licenseHeader, 0, 0);
    }
  }

Breaking: Simplify the Patch class to now only encapsulate the updated text, start offset, and end offset.

- yield Patch(sourceFile, sourceFile.span(5, 10), 'updated text');
+ yield Patch('updated text', 5, 10);

Breaking: Rename AstVisitingSuggestorMixin to AstVisitingSuggestor since the Mixin suffix was redundant.

Breaking: Remove AggregateSuggestor class in favor of an aggregate(Iterable<Suggestor> suggestors) function.

Breaking: Move applyPatches from the main package:codemod/codemod.dart entrypoint to the new package:codemod/test.dart entrypoint to make its intended usage clear.

Add a shouldResolveAst(FileContext context) method to AstVisitingSuggestor. Defaults to false (since resolving is slower), but can be overridden to true if the fully resolved AST is needed.

• Add example of such a codemod: see example/is_even_or_odd_suggestor.dart

Add package:codemod/test.dart entrypoint for testing suggestors. This entrypoint exports three functions:

• Future<FileContext> fileContextForTest(String name, String contents)

• void expectSuggestorGeneratesPatches(Suggestor suggestor, FileContext context, dynamic resultMatcher)

• String applyPatches(SourceFile sourceFile, Iterable<Patch> patches)

  The first two should be sufficient for testing most suggestors.

Use GitHub Actions for CI (remove Travis CI).

Breaking Change: remove the FileQuery class. The runInteractiveCodemod() function now expects an Iterable<File> instead of a FileQuery. This is intended to simplify consumption; package:glob can be used to easily query for the desired files.

Breaking Change: remove createPathFilter() - this was used with FileQuery and can be replaced by custom logic now that runInteractiveCodemod() accepts an Iterable<File>.

Breaking Change: remove isDartFile() - use package:glob instead to target files with the .dart extension (e.g. Glob('**.dart')).

Add a filePathsFromGlob() utility function that takes a Glob instance and returns the file paths matched by the glob, but filtered to exclude hidden files (e.g. files in .dart_tool/). This is intended to serve the most common use case of running codemods on Dart projects, e.g.:

runInteractiveCodemod(
  filePathsFromGlob(Glob('**.dart', recursive: true)),
  suggestor);

Widen Analyzer dependency range to include 0.39.x.

Make Patch override operator == and hashCode so that instances can be compared for equality. If two Patch instances target the same span in the same file and have the same updatedText, they are considered equal.

AstVisitingSuggestorMixin now de-duplicates patches suggested for each source file. This can be useful for recursive and generalizing AST visitors that may end up suggesting duplicate patches in parts of the AST that get handled by multiple visit methods.

Improve the error/help output when overlapping patches are found.

Widen Analyzer dependency range from ^0.37.0 to >=0.37.0 <0.39.0.

Exclude build/ folder when a codemod gets run.

Codemod authors can now augment the help output and the changes required output via runInteractiveCodemod() and runInteractiveCodemodSequence() using the optional additionalHelpOutput and changesRequiredOutput params.

• If additionalHelpOutput is given, it will be printed to stderr after the default help output when the codemod is run with the -h|--help flag.

• If changesRequiredOutput is given, it will be printed to stderr after the default output when the codemod is run with the --fail-on-changes flag and changes are in fact required.

Fix a typing issue with the AggregateSuggestor's constructor param.

Add tests for AggregateSuggestor and AstVisitingSuggestorMixin