Changeset 63783

Timestamp:

09/21/2026 07:55:13 PM (4 weeks ago)

Author:

afercia

Message:

Build/Test Tools: Exclude minified files from Grunt jshint:plugins more effectively.

Follow-up to [63364]. Prevents grunt jshint:plugins from scanning minified JavaScript files that don't use a .min suffix in their filename. Assumes that JavaScript files that contain lines with a length that is longer than 500 characters are minified file and skips them.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13573

Props afercia, westonruter.
Fixes #66123.

File:

• trunk/Gruntfile.js (modified) (1 diff)

trunk/Gruntfile.js

@@ -1084 +1084 @@
                                         '**/vendor/**'
                                 ],
-                                /*
-                                 * Limit JSHint's run to a single specified plugin directory:
+                                /**
+                                 * Limits JSHint's run to a single specified plugin directory:
                                  *
-                                 *    grunt jshint:plugins --dir=foldername
+                                 * Usage example:
+                                 * grunt jshint:plugins --dir=foldername
+                                 *
+                                 * This also automatically skips minified files that may not have
+                                 * a filename ending with `.min.js`, specifically when they have
+                                 * lines longer than 500 characters.
+                                 *
+                                 * @param {string} dirpath Directory path.
+                                 * @return {boolean} Whether the path is skipped.
                                  */
                                 filter: function( dirpath ) {
-                                        var index, dir = grunt.option( 'dir' );
-
-                                        // Don't filter when no target folder is specified.
-                                        if ( ! dir ) {
-                                                return true;
-                                        }
-
-                                        dirpath = dirpath.replace( /\\/g, '/' );
-                                        index = dirpath.lastIndexOf( '/' + dir );
-
-                                        // Match only the folder name passed from cli.
-                                        if ( -1 !== index ) {
-                                                return true;
-                                        }
-
-                                        return false;
+                                        // Bypasses folder targets so fs.readFileSync doesn't throw errors.
+                                        if ( ! fs.lstatSync( dirpath ).isFile() ) {
+                                                return false;
+                                        }
+
+                                        // If `--dir` is provided.
+                                        var dir = grunt.option( 'dir' );
+                                        if ( dir ) {
+                                                var normalizedPath = dirpath.replace( /\\/g, '/' );
+                                                var index = normalizedPath.lastIndexOf( '/' + dir );
+
+                                                // If a directory was requested but this file isn't in it, exclude it.
+                                                if ( -1 === index ) {
+                                                        return false;
+                                                }
+                                        }
+
+                                        // Read the file and inspect line lengths to catch minified/bundled code.
+                                        var content;
+                                        try {
+                                                content = fs.readFileSync( dirpath, 'utf-8' );
+                                        } catch ( error ) {
+                                                grunt.log.writeln( 'Could not read file: ' + dirpath + ' (Error: ' + error.message + ')' );
+                                                return false;
+                                        }
+
+                                        var lines = content.split( '\n' );
+
+                                        // Cap the maximum number of iterations at 5 lines.
+                                        for ( const line of lines.slice( 0, 5 ) ) {
+                                                // Exclude files with lines longer than 500 characters.
+                                                if ( line.length > 500 ) {
+                                                        grunt.log.writeln( 'Skipping minified file: ' + dirpath );
+                                                        return false;
+                                                }
+                                        }
+
+                                        // File passed both independent checks: proceed with JSHint.
+                                return true;
                                 }
                         }