Normalize the output folders to `lib-commonjs`, `lib-dts`, and `lib-esm` for all projects in this repo. by iclanton · Pull Request #5628 · microsoft/rushstack

iclanton · 2026-02-17T19:46:47Z

Summary

Standardize package output folder naming across all Rush Stack packages to a consistent convention:

lib-commonjs/ — CommonJS JavaScript
lib-esm/ — ESM JavaScript
lib-dts/ — TypeScript declarations

Previously, many packages used lib/ as a catch-all output folder. This change moves to explicit, descriptively-named folders while maintaining backward compatibility: imports to lib/ still resolve correctly via the exports and typesVersions fields in package.json.

Details

Package metadata updates (~65 published packages):

Added exports field with conditional import/require/types mappings
Added typesVersions to redirect lib/* to lib-dts/* for older TypeScript versions
Updated main, module, and types fields to point to new output locations
Updated api-extractor.json mainEntryPointFilePath to reference lib-dts/ or lib-commonjs/ as appropriate

Rig configuration updates (local-node-rig, local-web-rig):

tsconfig-base.json: Set outDir and declarationDir to the new folder names
config/typescript.json: Added additionalModuleKindsToEmit for dual CJS/ESM output

Special handling for rush-lib and rush-sdk:

These packages use intermediate build folders (lib-intermediate-commonjs, lib-intermediate-esm) that are processed by API Extractor before producing the final lib-commonjs/ output
They do not ship lib-esm/ — only CommonJS and declarations are published

Build test and tutorial fixes:

Updated webpack/rspack configs to reference lib-esm/ or lib-commonjs/ entry points
Updated heft scriptPath references from lib/ to lib-commonjs/
Updated heft-plugin.json entry points from lib/ to lib-commonjs/
Updated storybook story globs from lib/ to lib-esm/
Fixed sass plugin cssOutputFolders to target lib-esm/ instead of lib/
Fixed run-scenarios-helpers to use lib-dts/ for declaration entry points
Added additionalModuleKindsToEmit: [] overrides for eslint/localization test projects that set module: "esnext" (to avoid duplicate module kind conflicts with the rig)
Fixed eslint-patch exports for the eslint-bulk-suppressions subdirectory entry point

Clean-up:

Added old lib/ and new output folders to cleanFiles in heft.json configs so that developers' machines are cleaned of stale output from before this change
Updated .prettierignore to include lib-esm/

Backward compatibility: Existing deep imports to <package>/lib/<module> continue to work via the exports wildcard mapping ./lib/*, which redirects to the appropriate output folder. The typesVersions field provides the same mapping for older TypeScript versions that don't support exports.

How it was tested

Ran rush build across all 187 projects and verified all pass (excluding transient Windows filesystem lock errors unrelated to this change). Test suite execution pending final verification.

Impacted documentation

https://rushstack.io/pages/heft/rig_packages/ (rig output folder conventions)

…ugins to support ESM and CommonJS modules - Updated main entry points to use lib-commonjs and lib-esm for better module resolution. - Added exports field to package.json for improved compatibility with module systems. - Adjusted mainEntryPointFilePath in api-extractor.json to point to lib-dts for type definitions. - Enhanced typesVersions to support lib-dts for type definitions across various plugins.

…rush plugins to support ESM and CommonJS modules

- Consolidate "typings" to "types" for consistency - Add leading "./" to "main", "types", and "module" paths - Remove incorrect "main", "module", and "." exports from projects that don't have index entrypoints Co-Authored-By: Claude <noreply@anthropic.com>

…rush plugins to support ESM and CommonJS modules

Set "sideEffects" field in package.json across all published packages to enable webpack tree-shaking optimizations: - Pure libraries: "sideEffects": false - Executable apps with start entrypoints: sideEffects array listing lib-commonjs/ and lib-esm/ start files - eslint-patch: sideEffects array listing side-effectful entry points - webpack4-module-minifier-plugin: updated stale sideEffects path

…ma files - Expose ./heft-plugin.json in all heft plugin packages (17 projects) - Expose ./rush-plugin-manifest.json in all rush plugin packages (8 projects) - Expose ./lib/*.schema.json in all packages with schema files (28 projects) - Schema export placed before ./lib/* for correct Node.js pattern matching

…rush plugins to support ESM and CommonJS modules

…eft.

…cy and not).

…rush plugins to support ESM and CommonJS modules

…e layout

.vscode/launch.json

build-tests/run-scenarios-helpers/src/index.ts

dmichon-msft

Couple things caught earlier, otherwise looks good.

…ltiple rush plugins to support ESM and CommonJS modules

silverwind · 2026-02-19T07:31:05Z

Regression: #5644

github-project-automation bot added this to Bug Triage Feb 17, 2026

github-project-automation bot moved this to Needs triage in Bug Triage Feb 17, 2026

iclanton and others added 27 commits February 17, 2026 13:43

Add pattern to ignore tmpclaude working directory files

42f001a

fixup! feat: update package.json and api-extractor.json for multiple …

0b04151

…rush plugins to support ESM and CommonJS modules

fixup! fix: normalize package.json fields across projects

c71849c

Include lib-esm in the prettierignore.

673032d

Update paths in web projects.

b89c0c5

Clean up output folders in tests.

0e288e8

fixup! Update paths in web projects.

2df340d

fixup! feat: update package.json and api-extractor.json for multiple …

a4764f6

…rush plugins to support ESM and CommonJS modules

fixup! Clean up output folders in tests.

745ff87

fixup! feat: update package.json and api-extractor.json for multiple …

1e57147

…rush plugins to support ESM and CommonJS modules

Fix compatability with legacy globally-installed versions of Heft.

a7a8b39

Fix a few issues linting and cleaning in local projects.

83c67aa

Update rush-lib and rush-sdk to the new convention.

287c713

fixup! feat: update package.json and api-extractor.json for multiple …

07c5752

…rush plugins to support ESM and CommonJS modules

Rush change.

8dec83d

fixup! Clean up output folders in tests.

1b8cb31

fixup! Clean up output folders in tests.

45c2dfe

fixup! feat: update package.json and api-extractor.json for multiple …

7997e61

…rush plugins to support ESM and CommonJS modules

fixup! Update rush-lib and rush-sdk to the new convention.

9443cc5

fixup! Fix a few issues linting and cleaning in local projects.

f4fdcf1

fixup! Rush change.

2075b8d

fixup! Fix a few issues linting and cleaning in local projects.

051fb91

fixup! feat: update package.json and api-extractor.json for multiple …

0dfc71c

…rush plugins to support ESM and CommonJS modules

fixup! Clean up output folders in tests.

fbfdec3

fixup! Clean up output folders in tests.

8a10b9e

iclanton force-pushed the normalize-build-output branch from 10739e8 to 8a10b9e Compare February 17, 2026 21:43

iclanton requested review from TheLarkInn, apostolisms, bmiddha, dmichon-msft and jxanthony as code owners February 17, 2026 23:34

iclanton added 9 commits February 17, 2026 16:10

Reorder export conditions: types, import, require, default

3b681f5

fixup! Rush change.

b18ff16

fixup! feat: update package.json and api-extractor.json for multiple …

0a9158a

…rush plugins to support ESM and CommonJS modules

fixup! Fix compatability with legacy globally-installed versions of H…

23beaa6

…eft.

Fix compatability with globally-installed versions of Rush (both lega…

baed318

…cy and not).

fixup! feat: update package.json and api-extractor.json for multiple …

61ea6c8

…rush plugins to support ESM and CommonJS modules

fixup! feat: update package.json and api-extractor.json for multiple …

8dfe62d

…rush plugins to support ESM and CommonJS modules

iclanton force-pushed the normalize-build-output branch from d289663 to 8dfe62d Compare February 18, 2026 02:45

iclanton added 2 commits February 17, 2026 21:53

Migrate heft-vscode-extension-plugin to local-node-rig and new packag…

302550d

…e layout

Fix storybook tutorial webpack configs: lib -> lib-commonjs

ea5ab30

iclanton moved this from Needs triage to In Progress in Bug Triage Feb 18, 2026

dmichon-msft reviewed Feb 18, 2026

View reviewed changes

.vscode/launch.json Outdated Show resolved Hide resolved

dmichon-msft reviewed Feb 18, 2026

View reviewed changes

build-tests/run-scenarios-helpers/src/index.ts Outdated Show resolved Hide resolved

dmichon-msft approved these changes Feb 18, 2026

View reviewed changes

iclanton added 2 commits February 18, 2026 15:26

fixup! fixup! feat: update package.json and api-extractor.json for mu…

9c08d51

…ltiple rush plugins to support ESM and CommonJS modules

fixup! fixup! feat: update package.json and api-extractor.json for mu…

2f393d6

…ltiple rush plugins to support ESM and CommonJS modules

iclanton enabled auto-merge (squash) February 18, 2026 23:27

iclanton merged commit 6d669f1 into microsoft:main Feb 18, 2026
6 checks passed

github-project-automation bot moved this from In Progress to Closed in Bug Triage Feb 18, 2026

iclanton deleted the normalize-build-output branch February 18, 2026 23:50

awanlin mentioned this pull request Feb 21, 2026

[api-extractor] v7.57.0 no longer exports extends/tsdoc-base.json #5658

Closed

Copilot AI mentioned this pull request Feb 21, 2026

Add missing exports entries for published JSON config files #5659

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Normalize the output folders to `lib-commonjs`, `lib-dts`, and `lib-esm` for all projects in this repo.#5628

Normalize the output folders to `lib-commonjs`, `lib-dts`, and `lib-esm` for all projects in this repo.#5628
iclanton merged 43 commits intomicrosoft:mainfrom
iclanton:normalize-build-output

iclanton commented Feb 17, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

dmichon-msft left a comment

Uh oh!

Uh oh!

silverwind commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

iclanton commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

How it was tested

Impacted documentation

Uh oh!

Uh oh!

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

silverwind commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

iclanton commented Feb 17, 2026 •

edited

Loading