Skip to content

Style: Replace Grunt with @wordpress/scripts and modernize the build - #734

Open
obenland wants to merge 5 commits into
WordPress:trunkfrom
obenland:style/modernize-build-tooling
Open

Style: Replace Grunt with @wordpress/scripts and modernize the build#734
obenland wants to merge 5 commits into
WordPress:trunkfrom
obenland:style/modernize-build-tooling

Conversation

@obenland

Copy link
Copy Markdown
Member

Modernizes the build tooling and code style for wordpress.org/public_html/style/, and adds CI coverage for it.

Tooling

  • Replaces Grunt/JSHint with @wordpress/scripts 33: npm run build / build:css / build:js / format / lint:js.
  • js/navigation.min.js is built in place by webpack (webpack.config.js); wp4-rtl.css by a small bin/build-rtl.js, preserving the Dashicons arrow-swap and @import renaming that RTLCSS can't infer and that wp-scripts' built-in RTL support can't express.
  • Browser targets now extend the official @wordpress/browserslist-config, matching the wporg-*-2024 themes, replacing the 2013-era list (IE 7+, Android 2.1+). Autoprefixer and the self-referential wp4.css.map are dropped: under current targets the stylesheet needs no generated prefixes (the few remaining -webkit-/-moz- occurrences are intentional non-standard properties).

Code style

  • All JS in style/ (including trac/) now passes the stock @wordpress/scripts ESLint ruleset with zero errors, and is Prettier-formatted with a single local override (printWidth: 120).
  • HTML-building string concatenation is converted to template literals; query-string building on the GitHub-PRs endpoint uses URLSearchParams (which also percent-encodes values that previously went onto the wire raw).
  • Removes trac/trac-search.js, dead since its include was removed in r7275 (2018) — its API endpoint no longer exists.

CI

  • New style-lint.yml workflow runs on changes to JS/CSS under style/: ESLint, prettier --check, and a build-drift check that fails when committed build output (wp4-rtl.css, js/navigation.min.js) is out of sync with its source.

Docs

  • Adds README.md, trac/README.md, and AGENTS.md (with a CLAUDE.md wrapper): file inventory, development flow, testing Trac changes via DevTools local overrides, and the deploy flow (commit + sandbox deploy, then the follow-up scripts_version bump in both Trac templates).

Verification

  • wp4.css builds byte-identical under the new pipeline before the browserslist change; the RTL diff beyond that consists of drift the old pipeline had accumulated plus the prefix removal.
  • All converted string sites verified output-equivalent (modulo whitespace between block-level tags) across every conditional branch.
  • npm run lint:js, npx prettier --check ., node --check on all sources, and a full npm run build idempotency check all pass.

Note for deployment: the changes to trac/*.js will need the usual scripts_version bump in site_head.html/site_footer.html as a follow-up commit once the assets are deployed.

🤖 Generated with Claude Code

@obenland
obenland force-pushed the style/modernize-build-tooling branch from d1d8266 to 6b014cc Compare July 25, 2026 00:25
@obenland
obenland force-pushed the style/modernize-build-tooling branch from 7b64e37 to 8de956a Compare July 29, 2026 15:42
obenland added a commit to obenland/wordpress.org that referenced this pull request Aug 3, 2026
Brings trac/ in line with the formatting and lint rules from WordPress#734, ahead of
that PR, so the same files do not need touching again when it lands and the
assets only need deploying once.

Retires the jinja2 compatibility shim: its rules now live in wp-trac.css and
the templates no longer load the removed script and stylesheet. trac-search.js
goes with it, unused since its include was removed in r7275.

Builds markup through the DOM rather than by string concatenation in the
attachment preview, the reopen notice, the non-gardener type field and the
attachment autocomplete, and restores the preserved attribute matches by index
so a comment cannot shift the restore queue.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@obenland
obenland force-pushed the style/modernize-build-tooling branch 3 times, most recently from 06d8578 to 78af7f7 Compare August 4, 2026 01:53
- Swap Grunt/JSHint for @wordpress/scripts (build, lint-js, format), with a
  webpack config that builds js/navigation.min.js in place and a small
  bin/build-rtl.js for the RTL stylesheet, keeping the Dashicons arrow swap
  RTLCSS cannot infer.
- Adopt the default WordPress code style (Prettier at a 120 line length) and
  fix all ESLint errors; convert HTML-building string concatenation to
  template literals and query building to URLSearchParams.
- Update browser targets to @wordpress/browserslist-config, matching the rest
  of WordPress.org, and drop the vendor prefixes nothing supported needs
  anymore, along with the Autoprefixer pass and the self-referential
  wp4.css.map.
- Remove trac/trac-search.js, unused since its include was removed in r7275.
- Document the directory in README.md, trac/README.md, and AGENTS.md (with a
  CLAUDE.md wrapper): file inventory, development flow, testing Trac changes
  via DevTools overrides, and the deploy + scripts_version bump process.
@obenland
obenland force-pushed the style/modernize-build-tooling branch from 78af7f7 to 8cf0c43 Compare August 12, 2026 01:10
obenland and others added 4 commits August 11, 2026 20:11
Runs on changes to JS or CSS under wordpress.org/public_html/style/ and
fails when the tooling wasn't run: ESLint errors, unformatted files, or
committed build output (wp4-rtl.css, js/navigation.min.js) that is out of
sync with its source.
Their behavior now lives in wp-trac.js and wp-trac.css; remove the
files, their template includes, and their README entries.

scripts_version is deliberately untouched: per the documented deploy
flow it gets bumped in a follow-up commit once the merged assets are
deployed, so the CDN never caches a stale file under the new version.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015Nm6k2sd9zv3aRZZZt6XCp
Adds wp-scripts lint-style (the stock @wordpress/stylelint-config) as
npm run lint:css, wired into the CI workflow, and conforms wp4.css and
trac/wp-trac.css to it. Prettier ignores *.css, so stylelint owns CSS
formatting outright.

The fixes are rendering-identical: formatting, notation (::before,
bold=700, named colors to hex, quote style), dropped declarations that
a later duplicate in the same block already overrode, and generic
font-family fallbacks — including 'Open Sans', "sans serif", which
quoted the generic keyword into a nonexistent font name.

Cascade-affecting rules (selector reordering/merging, renaming the
Trac and WP.org markup's own ids and classes, unit conversions) are
disabled in .stylelintrc.js. Vendored, generated, and frozen legacy
stylesheets are excluded via .stylelintignore; wp4-rtl.css is rebuilt
from the conformed wp4.css.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015Nm6k2sd9zv3aRZZZt6XCp
Chrome stores DevTools local overrides with the query string in the
file name and only matches that exact name; hand-placed files without
it are silently ignored, as are tabs without an open DevTools window.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015Nm6k2sd9zv3aRZZZt6XCp
@obenland
obenland force-pushed the style/modernize-build-tooling branch from 8cf0c43 to 00a8621 Compare August 12, 2026 01:11
@obenland
obenland marked this pull request as ready for review August 12, 2026 02:15
Copilot AI lite review requested due to automatic review settings August 12, 2026 02:15
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props obenland.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Modernizes the build and maintenance workflow for wordpress.org/public_html/style/ by migrating from Grunt/JSHint to @wordpress/scripts, regenerating committed build artifacts accordingly, and adding CI checks to prevent drift and enforce lint/format rules for the Style assets.

Changes:

  • Replace Grunt/JSHint tooling with @wordpress/scripts-based build/lint/format commands and updated browser targets.
  • Introduce a custom webpack config and a Node-based RTL build script, committing regenerated outputs (wp4-rtl.css, js/navigation.min.js).
  • Add documentation for the Style and Trac asset workflows plus a dedicated GitHub Actions workflow for lint/format/build-drift checks.

Reviewed changes

Copilot reviewed 17 out of 21 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
wordpress.org/public_html/style/wp4.css.map Removes the committed source map output.
wordpress.org/public_html/style/wp4.css Updates CSS output (formatting/normalization, vendor-prefix removal, mapping comment removal).
wordpress.org/public_html/style/wp4-rtl.css Updates committed RTL build output to match the new pipeline.
wordpress.org/public_html/style/webpack.config.js Customizes @wordpress/scripts webpack output to build js/navigation.min.js in-place.
wordpress.org/public_html/style/trac/README.md Documents Trac-specific static assets and deployment/version-bump workflow.
wordpress.org/public_html/style/README.md Documents Style directory inventory, local dev commands, and deployment workflow.
wordpress.org/public_html/style/package.json Switches to @wordpress/scripts tooling, adds browserslist, and defines build/lint/format scripts.
wordpress.org/public_html/style/js/navigation.min.js Updates committed minified navigation script output.
wordpress.org/public_html/style/js/navigation.js Modernizes the navigation script source to satisfy @wordpress/scripts lint/style expectations.
wordpress.org/public_html/style/Gruntfile.js Removes legacy Grunt build configuration.
wordpress.org/public_html/style/CLAUDE.md Adds a wrapper pointing tooling/agent guidance to AGENTS.md.
wordpress.org/public_html/style/bin/build-rtl.js Adds a Node script to generate wp4-rtl.css from wp4.css (RTL build step).
wordpress.org/public_html/style/AGENTS.md Adds directory-specific contributor/agent workflow rules and commands.
wordpress.org/public_html/style/.stylelintrc.js Adds Stylelint configuration extending WordPress defaults with local rule relaxations.
wordpress.org/public_html/style/.stylelintignore Adds Stylelint ignore rules for vendored/frozen/generated assets.
wordpress.org/public_html/style/.prettierrc.js Adds a Prettier config extending WordPress defaults with printWidth: 120.
wordpress.org/public_html/style/.prettierignore Excludes generated/minified/CSS (and vendored Trac assets) from Prettier formatting.
wordpress.org/public_html/style/.jshintrc Removes legacy JSHint configuration.
wordpress.org/public_html/style/.jshintignore Removes legacy JSHint ignore configuration.
.github/workflows/style-lint.yml Adds CI workflow to lint/format and verify generated files are up-to-date for Style changes.
Suppressed comments (2)

wordpress.org/public_html/style/js/navigation.js:22

  • document.getElementById() returns null when an element is missing, not undefined. The current typeof checks won’t catch a missing #mobile-menu-button or #wporg-header-menu, and the code will then throw when accessing properties on null.
	const button = document.getElementById( 'mobile-menu-button' );
	if ( 'undefined' === typeof button ) {
		return;
	}

	const menu = document.getElementById( 'wporg-header-menu' );

	// Hide menu toggle button if menu is empty and return early.
	if ( 'undefined' === typeof menu ) {
		button.style.display = 'none';
		return;
	}

.github/workflows/style-lint.yml:16

  • Same as the PR trigger: the push path filters should use **/*.js / **/*.css so nested files under style/ are included.
    - 'wordpress.org/public_html/style/**.js'
    - 'wordpress.org/public_html/style/**.css'

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +6 to +7
- 'wordpress.org/public_html/style/**.js'
- 'wordpress.org/public_html/style/**.css'
| `npm run build` | Runs `build:css` and `build:js`. |
| `npm run build:css` | Regenerates `wp4-rtl.css` from `wp4.css` via `bin/build-rtl.js`. The RTL pass includes a plugin that swaps Dashicons left/right arrow glyphs, which RTLCSS cannot infer from the CSS itself. |
| `npm run build:js` | Builds `js/navigation.js` into `js/navigation.min.js` (webpack via `wp-scripts build`, see `webpack.config.js`). Transpilation targets come from the `browserslist` field in `package.json`, which extends the official `@wordpress/browserslist-config`. |
| `npm run format` | Formats all source files with Prettier (`wp-scripts format`). |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants