js-build-tools 6.4.0 → 6.4.1

package/dist/partials/lintSource.js

@@ -8,6 +8,7 @@ exports.lintSource = void 0;
 var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
 var _gulp = require("gulp");
 var _neostandardLint = require("./neostandardLint.js");
+var _nodeStream = require("node:stream");
 var cache;
 function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
 /**
@@ -30,12 +31,22 @@ const lintSource = ({
   const linter = (0, _neostandardLint.neostandardLint)({
     fix: true,
     ts,
-    rules: gulpConfig.get('lint.rules'),
-    failOnError
+    rules: gulpConfig.get('lint.rules')
   });
-  const written = (0, _gulp.src)(patterns).pipe(linter).pipe((0, _gulp.dest)(srcPath));
-  // pipe() does not forward errors, and gulp only watches the returned stream, so pass the linter's failure along.
-  linter.on('error', error => written.emit('error', error));
+  // Fail only once dest() has written every fixed file: gulp exits as soon as a task fails, so failing from the
+  // linter itself (before dest() finished) could leave a file that dest() had opened, but not yet written, empty.
+  // dest() passes each file on only after writing it, so this last step's flush runs after the final write. Files
+  // are consumed here rather than passed on, so nothing downstream has to read them.
+  const written = new _nodeStream.Transform({
+    objectMode: true,
+    transform: (file, enc, callback) => callback(),
+    flush: callback => failOnError && linter.totals.errors ? callback(new Error(`neostandard found ${linter.totals.errors} lint error(s) that could not be fixed automatically.`)) : callback()
+  });
+  const saved = (0, _gulp.src)(patterns).pipe(linter).pipe((0, _gulp.dest)(srcPath));
+  saved.pipe(written);
+  // pipe() does not forward errors, and gulp only watches the returned stream, so pass any failure along.
+  linter.on('error', error => written.destroy(error));
+  saved.on('error', error => written.destroy(error));
   return written;
 };
 exports.lintSource = lintSource;

package/dist/partials/neostandardLint.js

@@ -113,7 +113,7 @@ const printFileReport = (file, result) => {
  * @param {function(Object): Promise<{lintText: Function}>} [loadEslint] - Resolves an ESLint-shaped linter. Real
  * callers should never need to pass this - it exists so tests can supply a stand-in, since this project's
  * CommonJS-transform-based Jest setup cannot execute a real dynamic import() of neostandard (ESM-only).
- * @returns {stream.Transform}
+ * @returns {stream.Transform} With a `totals` property ({errors, warnings}), complete once the stream ends.
  */
 const neostandardLint = ({
   fix = true,
@@ -126,7 +126,7 @@ const neostandardLint = ({
     warnings: 0
   };
   let eslintPromise = null;
-  return _through.default.obj(function (file, enc, callback) {
+  const linter = _through.default.obj(function (file, enc, callback) {
     if (file.isNull()) {
       callback(null, file);
       return;
@@ -169,5 +169,8 @@ const neostandardLint = ({
     }
     callback();
   });
+  // Read by lintSource, which can only fail once the fixed files have been written, after this stream has ended.
+  linter.totals = totals;
+  return linter;
 };
 exports.neostandardLint = neostandardLint;

package/functions/partials/lintSource.mjs

@@ -1,6 +1,7 @@
 import * as gulpConfig from '../../gulp.config.mjs'
 import { dest, src } from 'gulp'
 import { neostandardLint } from './neostandardLint.mjs'
+import { Transform } from 'node:stream'
 
 /**
  * Lint the project's source (srcPath: .js, .mjs and .cjs, plus .ts when typescript.enabled) with neostandard and
@@ -17,11 +18,24 @@ export const lintSource = ({ failOnError = false } = {}) => {
   if (ts) {
     patterns.push(`${srcPath}/**/*.ts`)
   }
-  const linter = neostandardLint({ fix: true, ts, rules: gulpConfig.get('lint.rules'), failOnError })
-  const written = src(patterns)
+  const linter = neostandardLint({ fix: true, ts, rules: gulpConfig.get('lint.rules') })
+  // Fail only once dest() has written every fixed file: gulp exits as soon as a task fails, so failing from the
+  // linter itself (before dest() finished) could leave a file that dest() had opened, but not yet written, empty.
+  // dest() passes each file on only after writing it, so this last step's flush runs after the final write. Files
+  // are consumed here rather than passed on, so nothing downstream has to read them.
+  const written = new Transform({
+    objectMode: true,
+    transform: (file, enc, callback) => callback(),
+    flush: callback => failOnError && linter.totals.errors
+      ? callback(new Error(`neostandard found ${linter.totals.errors} lint error(s) that could not be fixed automatically.`))
+      : callback()
+  })
+  const saved = src(patterns)
     .pipe(linter)
     .pipe(dest(srcPath))
-  // pipe() does not forward errors, and gulp only watches the returned stream, so pass the linter's failure along.
-  linter.on('error', error => written.emit('error', error))
+  saved.pipe(written)
+  // pipe() does not forward errors, and gulp only watches the returned stream, so pass any failure along.
+  linter.on('error', error => written.destroy(error))
+  saved.on('error', error => written.destroy(error))
   return written
 }

package/functions/partials/neostandardLint.mjs

@@ -87,7 +87,7 @@ const printFileReport = (file, result) => {
  * @param {function(Object): Promise<{lintText: Function}>} [loadEslint] - Resolves an ESLint-shaped linter. Real
  * callers should never need to pass this - it exists so tests can supply a stand-in, since this project's
  * CommonJS-transform-based Jest setup cannot execute a real dynamic import() of neostandard (ESM-only).
- * @returns {stream.Transform}
+ * @returns {stream.Transform} With a `totals` property ({errors, warnings}), complete once the stream ends.
  */
 export const neostandardLint = (
   { fix = true, ts = false, rules = {}, failOnError = false } = {},
@@ -95,7 +95,7 @@ export const neostandardLint = (
 ) => {
   const totals = { errors: 0, warnings: 0 }
   let eslintPromise = null
-  return through.obj(
+  const linter = through.obj(
     function (file, enc, callback) {
       if (file.isNull()) {
         callback(null, file)
@@ -136,4 +136,7 @@ export const neostandardLint = (
       callback()
     }
   )
+  // Read by lintSource, which can only fail once the fixed files have been written, after this stream has ended.
+  linter.totals = totals
+  return linter
 }

package/functions/sourceLint.test.mjs

@@ -143,4 +143,24 @@ describe('lint', () => {
         done(new Error('lint should have failed on the unused variable'))
       })
   }, 20000)
+
+  test('only fails once every fixed file has been written back', done => {
+    // gulp exits as soon as a task fails, so failing while a file is still being written can leave that file empty.
+    const srcPath = gulpConfig.get('srcPath')
+    const fixable = ['a', 'b', 'c'].map(name => `${srcPath}/fixable-${name}.js`)
+    fixable.forEach(file => fs.writeFileSync(file, 'const x = "y";\n\nmodule.exports = x;\n'))
+    fs.writeFileSync(`${srcPath}/unfixable.js`, 'const unused = 1\n')
+    const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+    expect.assertions(fixable.length)
+    lint()
+      .on('error', () => {
+        logSpy.mockRestore()
+        fixable.forEach(file => expect(fs.readFileSync(file).toString()).toEqual('const x = \'y\'\n\nmodule.exports = x\n'))
+        done()
+      })
+      .on('finish', () => {
+        logSpy.mockRestore()
+        done(new Error('lint should have failed on the unused variable'))
+      })
+  }, 30000)
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "6.4.0",
+  "version": "6.4.1",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {