Page MenuHomePhabricator
Create Task
Maniphest T352931

Update all Codex packages to use ESM by default
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

In preparation for Vite 5's deprecation of its CommonJS API, we should update the various Codex packages to use ESM by default. This can be done by adding "type": "module to the package.json file for each workspace.

It's still possible for individual files to opt-in to CJS by using .cjs as their file extension. This workaround will probably be necessary for Jest config files, because Jest still considers ESM support to be experimental.

In the slightly-more-distant-future, we may want to migrate our test suites from Jest to Vitest.

Here's an example of what this change entails (in the codex-docs workspace): https://gerrit.wikimedia.org/r/c/design/codex/+/980943/3

Acceptance Criteria

  • Migrate codex-design-tokens to ESM
  • Migrate codex-icons to ESM
  • Migrate @wikimedia/codex to ESM
  • Migrate codex-docs to ESM

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Update Codex from v1.2.1 to v1.3.0mediawiki/coremaster+10 K -10 K
Update Codex from v1.3.0 to v1.3.1mediawiki/coremaster+9 -9
build: Point "main" to the CJS file rather than the ESM filedesign/codexmain+2 -2
build: Migrate codex-icons package to ESMdesign/codexmain+130 -92
build: Migrate @wikimedia/codex package to ESMdesign/codexmain+7 -6
build: Migrate codex-design-tokens package to ESMdesign/codexmain+51 -35
Update Codex from v1.2.0 to v1.2.1mediawiki/coremaster+742 -886
build: Update custom SVGO plugin to conform to public APIdesign/codexmain+18 -14
Customize query in gerrit

Related Objects
Search...

Event Timeline

egardner created this task.Dec 6 2023, 11:48 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 6 2023, 11:48 PM
egardner added a parent task: T352587: Upgrade Codex to Vite 5.x and Vitepress 1.0.Dec 6 2023, 11:54 PM
tyhopp subscribed.Dec 11 2023, 6:49 AM
CCiufo-WMF moved this task from Up Next to 2024 Quiet Week on the Design-System-Team board.Dec 11 2023, 7:23 PM
gerritbot added a comment.Dec 12 2023, 9:29 AM

Change 982362 had a related patch set uploaded (by Tyhopp; author: Tyhopp):

[design/codex@main] build: Migrate codex-design-tokens package to ESM

https://gerrit.wikimedia.org/r/982362

gerritbot added a project: Patch-For-Review.Dec 12 2023, 9:29 AM
egardner added a comment.Jan 2 2024, 10:28 PM

Here's a useful reference article as we work on this: https://pawelgrzybek.com/all-you-need-to-know-to-move-from-commonjs-to-ecmascript-modules-esm-in-node-js

gerritbot added a comment.Jan 3 2024, 10:34 PM

Change 987496 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[design/codex@main] build: Update custom SVGO plugin to conform to public API

https://gerrit.wikimedia.org/r/987496

gerritbot added a comment.Jan 3 2024, 11:46 PM

Change 987496 merged by jenkins-bot:

[design/codex@main] build: Update custom SVGO plugin to conform to public API

https://gerrit.wikimedia.org/r/987496

gerritbot added a comment.Jan 4 2024, 9:47 PM

Change 987839 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[design/codex@main] build: Migrate codex-icons package to ESM

https://gerrit.wikimedia.org/r/987839

gerritbot added a comment.Jan 4 2024, 11:17 PM

Change 987862 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[design/codex@main] build: Migrate @wikimedia/codex package to ESM

https://gerrit.wikimedia.org/r/987862

AnneT moved this task from 2024 Quiet Week to Up Next on the Design-System-Team board.Jan 8 2024, 5:47 PM
AnneT triaged this task as Medium priority.Jan 8 2024, 6:31 PM
AnneT set the point value for this task to 5.
AnneT moved this task from Up Next to DST-Sprint-14 (2024-01-08 to 2024-01-19) on the Design-System-Team board.
AnneT edited projects, added Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)); removed Design-System-Team.
AnneT moved this task from Committed to Code Review on the Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)) board.
gerritbot added a comment.Jan 9 2024, 8:10 PM

Change 982362 merged by jenkins-bot:

[design/codex@main] build: Migrate codex-design-tokens package to ESM

https://gerrit.wikimedia.org/r/982362

egardner claimed this task.Jan 9 2024, 9:23 PM
egardner updated the task description. (Show Details)Jan 9 2024, 9:25 PM
gerritbot added a comment.Jan 9 2024, 9:41 PM

Change 989250 had a related patch set uploaded (by LWatson; author: LWatson):

[mediawiki/core@master] Update Codex from v1.2.0 to v1.2.1

https://gerrit.wikimedia.org/r/989250

gerritbot added a comment.Jan 9 2024, 10:26 PM

Change 989250 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v1.2.0 to v1.2.1

https://gerrit.wikimedia.org/r/989250

gerritbot added a comment.Jan 17 2024, 11:50 PM

Change 987862 merged by jenkins-bot:

[design/codex@main] build: Migrate @wikimedia/codex package to ESM

https://gerrit.wikimedia.org/r/987862

gerritbot added a comment.Jan 17 2024, 11:50 PM

Change 987839 merged by jenkins-bot:

[design/codex@main] build: Migrate codex-icons package to ESM

https://gerrit.wikimedia.org/r/987839

egardner updated the task description. (Show Details)Jan 17 2024, 11:51 PM
egardner added a comment.Jan 17 2024, 11:54 PM

These changes will be reflected when we make the next Codex release (next week on Tuesday).

When we upgrade the version of Codex that is included with MediaWiki, we'll also need to update foreign-resources.yml to ensure the right files are referenced. Conveniently I'm the one doing the next release so I'll make sure everything is correctly updated.

egardner moved this task from Code Review to Pending Release on the Design-System-Team (DST-Sprint-14 (2024-01-08 to 2024-01-19)) board.Jan 17 2024, 11:55 PM
Maintenance_bot removed a project: Patch-For-Review.Jan 18 2024, 12:30 AM
gerritbot added a comment.Jan 23 2024, 9:22 PM

Change 992533 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[mediawiki/core@master] Update Codex from v1.2.1 to v1.3.0

https://gerrit.wikimedia.org/r/992533

gerritbot added a project: Patch-For-Review.Jan 23 2024, 9:22 PM
gerritbot added a comment.Jan 23 2024, 11:16 PM

Change 992533 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v1.2.1 to v1.3.0

https://gerrit.wikimedia.org/r/992533

egardner closed this task as Resolved.Jan 23 2024, 11:24 PM
Maintenance_bot removed a project: Patch-For-Review.Jan 23 2024, 11:31 PM
gerritbot added a comment.Jan 24 2024, 5:49 PM

Change 992765 had a related patch set uploaded (by Catrope; author: Catrope):

[design/codex@main] build: Point "main" to the CJS file rather than the ESM file

https://gerrit.wikimedia.org/r/992765

gerritbot added a project: Patch-For-Review.Jan 24 2024, 5:49 PM
gerritbot added a comment.Jan 24 2024, 6:16 PM

Change 992765 merged by jenkins-bot:

[design/codex@main] build: Point "main" to the CJS file rather than the ESM file

https://gerrit.wikimedia.org/r/992765

Maintenance_bot removed a project: Patch-For-Review.Jan 24 2024, 6:30 PM
gerritbot added a comment.Jan 24 2024, 7:05 PM

Change 992798 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[mediawiki/core@master] Update Codex from v1.3.0 to v1.3.1

https://gerrit.wikimedia.org/r/992798

gerritbot added a project: Patch-For-Review.Jan 24 2024, 7:05 PM
gerritbot added a comment.Jan 24 2024, 7:28 PM

Change 992798 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v1.3.0 to v1.3.1

https://gerrit.wikimedia.org/r/992798

Maintenance_bot removed a project: Patch-For-Review.Jan 24 2024, 7:31 PM
ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.16; 2024-01-30).Jan 24 2024, 8:00 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits