fix(autofix): 🐛 write autofixes to disk for eslint

Author: krema

lib/builder/src/builder.spec.ts

@@ -4,11 +4,12 @@ import { Architect } from '@angular-devkit/architect';
 import { TestingArchitectHost } from '@angular-devkit/architect/testing';
 import { schema } from '@angular-devkit/core';
 import { Logger } from '@angular-devkit/core/src/logger';
+import { exec } from 'child_process';
 
 describe('Lint', () => {
   let architect: Architect;
   let architectHost: TestingArchitectHost;
-  const logger = new Logger('test');
+  let logger: Logger;
 
   beforeEach(async () => {
     const registry = new schema.CoreSchemaRegistry();
@@ -18,6 +19,7 @@ describe('Lint', () => {
     // Since we don't use those, both are the same in this case.
     architectHost = new TestingArchitectHost('./test', './test');
     architect = new Architect(architectHost, registry);
+    logger = new Logger('test');
 
     // This will either take a Node package name, or a path to the directory
     // for the package.json file.
@@ -26,6 +28,10 @@ describe('Lint', () => {
     console.info('#', Array.from(architectHost._builderMap.keys()));
   });
 
+  afterEach(async () => {
+    exec('git restore test/src/');
+  });
+
   it('has created the correct linting results', async () => {
     // A "run" can have multiple outputs, and contains progress information.
     const run = await architect.scheduleBuilder(
@@ -94,4 +100,66 @@ describe('Lint', () => {
       },
     ]);
   });
+
+  it('autofix lint issues when using fix option', async () => {
+    // A "run" can have multiple outputs, and contains progress information.
+    const run = await architect.scheduleBuilder(
+      '@krema/angular-eslint-stylelint-builder:lint',
+      {
+        eslintFilePatterns: ['src/**/*.ts'],
+        stylelintFilePatterns: ['src/**/*.css'],
+        fix: true,
+      },
+      { logger }
+    );
+    const loggerPromise = logger
+      .pipe(
+        toArray(),
+        map(messages =>
+          messages.map(y => {
+            console.log('>>', y.message);
+            return { level: y.level, message: y.message };
+          })
+        )
+      )
+      .toPromise();
+
+    // The "result" member (of type BuilderOutput) is the next output.
+    await run.result;
+
+    // Stop the builder from running. This stops Architect from keeping
+    // the builder-associated states in memory, since builders keep waiting
+    // to be scheduled.
+    await run.stop();
+    logger.complete();
+
+    expect(loggerPromise).resolves.toEqual([
+      {
+        level: 'info',
+        message: '\nLinting "<???>"...',
+      },
+      {
+        level: 'debug',
+        message: 'Running eslint...',
+      },
+      {
+        level: 'debug',
+        message: 'Running stylelint...',
+      },
+      {
+        level: 'info',
+        // @ts-ignore
+        message: expect.toIncludeMultiple([
+          //file.ts
+          'file.ts\n' + "  3:3  error  Unexpected 'debugger' statement  eslint\tno-debugger\n",
+          // info messages
+          '✖ 1 problem (1 error, 0 warnings)\n',
+        ]),
+      },
+      {
+        level: 'error',
+        message: 'Lint errors found in the listed files.\n',
+      },
+    ]);
+  });
 });

lib/builder/src/eslint/eslint-linter.ts

@@ -1,7 +1,7 @@
 import type { Schema } from '../schema';
 import type { ESLint } from 'eslint';
 import { join, resolve } from 'path';
-import { checkESlintVersion, loadESLint } from './eslint-utils';
+import { checkESlintVersion, loadESLint, outputFixes } from './eslint-utils';
 
 export async function lint(
   linterInstance: ESLint,
@@ -13,6 +13,9 @@ export async function lint(
     options.eslintFilePatterns.map(p => join(workspaceRoot, p))
   );
 
+  // Modify the files with the fixed code.
+  await outputFixes(lintResults);
+
   return lintResults.map(result => ({
     ...result,
     messages: result.messages.map(message => ({