feat(autofix): add feat to overwrite sources files

Author: adorade

package.json

@@ -50,7 +50,8 @@
     "@jridgewell/trace-mapping": "0.3.25",
     "ansi-colors": "4.1.3",
     "fancy-log": "2.0.0",
-    "text-table": "0.2.0"
+    "text-table": "0.2.0",
+    "write-file-atomic": "6.0.0"
   },
   "devDependencies": {
     "@babel/core": "7.25.2",

src/index.mjs

@@ -11,6 +11,7 @@ const { lint } = stylelint;
 import { Transform } from 'node:stream';
 
 import applySourcemap from './apply-sourcemap.mjs';
+import { overwriteSource } from '../src/writer.mjs';
 import reporterFactory from './reporter-factory.mjs';
 
 /**
@@ -254,8 +255,14 @@ export default function gStylelintEsm(options) {
        * If fix option is enabled and there are fixes in the lint result, update file contents.
        * @type {boolean}
        */
-      if (pluginOptions.fix && lintResult.code) {
+      if (pluginOptions.fix && lintResult.code !== file.contents.toString()) {
         file.contents = Buffer.from(lintResult.code);
+
+        /**
+         * Overwrite the source file with the fixed code.
+         * @type {Function}
+         */
+        await overwriteSource(file, lintResult.code);
       }
 
       /**

src/reporter-factory.mjs

@@ -6,7 +6,8 @@
 
 import { gFormatters } from './formatters.mjs';
 import stylishFormatter from './stylish-formatter.mjs';
-import writeOutputLog from './writer.mjs';
+
+import { writeOutputLog } from './writer.mjs';
 
 /**
  * @typedef {import('stylelint').LintResult} LintResult
@@ -78,7 +79,7 @@ export default function reporterFactory(config = {}) {
      */
     if (config.log) {
       asyncTasks.push(
-        writeOutputLog(config.log, formattedText.trim())
+        await writeOutputLog(config.log, formattedText.trim())
       );
     }
 

src/utils.mjs

@@ -103,6 +103,4 @@ export function formatMessageText(message) {
  * @param {number} count
  * @returns {string}
  */
-export function pluralize(count) {
-  return count === 1 ? '' : 's';
-}
+export const pluralize = (count) => count === 1 ? '' : 's';

src/writer.mjs

@@ -4,11 +4,12 @@
  * License under MIT
  * ========================================================================== */
 
-import { dirname, normalize } from 'node:path';
-import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, normalize, relative } from 'node:path';
+import { mkdir } from 'node:fs/promises';
+import writeFileAtomic from 'write-file-atomic';
 
 import colors from 'ansi-colors';
-const { unstyle } = colors;
+const { blue, green, unstyle } = colors;
 
 /**
  * Writes the given text to a log file at the specified destination.
@@ -17,10 +18,25 @@ const { unstyle } = colors;
  * @param {string} content - The text content to write to the file
  * @returns {Promise<void>} A promise that resolves when the file is written
  */
-export default async function writeOutputLog(filePath, content) {
+export async function writeOutputLog(filePath, content) {
   // Ensure the directory exists
   await mkdir(dirname(filePath), { recursive: true });
 
   // Write the output log
-  await writeFile(normalize(filePath), unstyle(content));
+  await writeFileAtomic(normalize(filePath), unstyle(content));
+}
+
+/**
+ * Overwrites the source file with the given content.
+ *
+ * @param {string} file - The source file
+ * @param {string} content - The content to overwrite the source with
+ * @returns {Promise<void>} A promise that resolves when the file is overwritten
+ */
+export async function overwriteSource(file, content) {
+  process.stdout.write(
+    `${blue(normalize(relative('.', file.path)))} >> ${green('fixed and overwrote')}\n`
+  );
+
+  await writeFileAtomic(normalize(file.path), unstyle(content));
 }

test/index.test.js

@@ -112,14 +112,58 @@ describe('Plugin Functionality', () => {
       throw new Error(`Unexpected error: ${error}`);
     }
   });
+  it('should overwrite the source file when `fix` option is set', async () => {
+    stub(process.stdout, 'write');
+    const outputDir = path.resolve(__dirname, '../tmpa');
+
+    const file = createVinylFile('invalid.css', '.foo {\n  color: #ffffff;\n}\n');
+    const content = file.contents.toString('utf8');
+    const outputFilePath = path.join(outputDir, 'invalid.css');
+
+    fs.mkdirSync(outputDir, { recursive: true });
+    fs.writeFileSync(outputFilePath, content, 'utf8');
+
+    const stream = src(outputFilePath);
+
+    expect.assertions(1);
+
+    try {
+      await new Promise((resolve, reject) => {
+        stream
+          .pipe(gStylelintEsm({
+            config: { rules: { 'color-hex-length': 'short' } },
+            fix: true,
+          }))
+          .on('error', reject)
+          .on('finish', resolve);
+      });
+
+      const outputFileContents = fs.readFileSync(outputFilePath, 'utf8');
+
+      expect(outputFileContents).toBe('.foo {\n  color: #fff;\n}\n');
+    } catch (error) {
+      throw new Error(`Unexpected error: ${error}`);
+    } finally {
+      fs.unlinkSync(outputFilePath);
+      fs.rmdirSync(outputDir);
+      process.stdout.write.restore();
+    }
+  });
   it('should fix the file without emitting errors', async () => {
-    const inputFilePath = fixtures('invalid.css');
-    const outputDir = path.resolve(__dirname, '../tmp');
+    stub(process.stdout, 'write');
+    const inputDir = path.resolve(__dirname, '../tmpb');
+    const outputDir = path.resolve(__dirname, '../tmpc');
+
+    const file = createVinylFile('invalid.css', '.foo {\n  color: #ffffff;\n}\n');
+    const content = file.contents.toString('utf8');
+
+    const inputFilePath = path.join(inputDir, 'invalid.css');
     const outputFilePath = path.join(outputDir, 'invalid.css');
 
-    const stream = src(inputFilePath, {
-      sourcemaps: true,
-    });
+    fs.mkdirSync(inputDir, { recursive: true });
+    fs.writeFileSync(inputFilePath, content, 'utf8');
+
+    const stream = src(inputFilePath);
 
     expect.assertions(1);
 
@@ -141,8 +185,11 @@ describe('Plugin Functionality', () => {
     } catch (error) {
       throw new Error(`Unexpected error: ${error}`);
     } finally {
+      fs.unlinkSync(inputFilePath);
       fs.unlinkSync(outputFilePath);
+      fs.rmdirSync(inputDir);
       fs.rmdirSync(outputDir);
+      process.stdout.write.restore();
     }
   });
 });

test/writer.test.js

@@ -10,7 +10,7 @@ import path from 'node:path';
 
 import colors from 'ansi-colors';
 
-import writeOutputLog from '../src/writer.mjs';
+import { writeOutputLog } from '../src/writer.mjs';
 
 const __dirname = fileURLToPath(new URL('../', import.meta.url));
 

yarn.lock

@@ -4850,6 +4850,14 @@ wrappy@1:
   resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
   integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==
 
+write-file-atomic@6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-6.0.0.tgz#e9c89c8191b3ef0606bc79fb92681aa1aa16fa93"
+  integrity sha512-GmqrO8WJ1NuzJ2DrziEI2o57jKAVIQNf8a18W3nCYU3H7PNWqCCVTeH6/NQE93CIllIgQS98rrmVkYgTX9fFJQ==
+  dependencies:
+    imurmurhash "^0.1.4"
+    signal-exit "^4.0.1"
+
 write-file-atomic@^4.0.2:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-4.0.2.tgz#a9df01ae5b77858a027fd2e80768ee433555fcfd"