[rush] add support for sharding phases

.gitignore

@@ -81,7 +81,7 @@ common/autoinstallers/*/.npmrc
 # Heft temporary files
 .cache
 .heft
-
+.shards
 
 # Common toolchain intermediate files
 temp

build-tests/heft-jest-shards-test/.eslintrc.js

@@ -0,0 +1,9 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('local-eslint-config/patch/modern-module-resolution');
+// This is a workaround for https://github.com/microsoft/rushstack/issues/3021
+require('local-eslint-config/patch/custom-config-package-names');
+
+module.exports = {
+ extends: ['local-eslint-config/profile/node'],
+ parserOptions: { tsconfigRootDir: __dirname }
+};

build-tests/heft-jest-shards-test/README.md

@@ -0,0 +1,8 @@
+# heft-jest-reporter-test
+
+This project illustrates configuring Jest reporters in a minimal [Heft](https://www.npmjs.com/package/@rushstack/heft) project
+
+
+Please see the [Jest configuration](./config/jest.config.json),
+the [Getting started with Heft](https://rushstack.io/pages/heft_tutorials/getting_started/),
+and ["jest" task](https://rushstack.io/pages/heft_tasks/jest/) articles for more information.

build-tests/heft-jest-shards-test/config/heft.json

@@ -0,0 +1,35 @@
+{
+ "$schema": "../../../apps/heft/src/schemas/heft.schema.json",
+
+ // TODO: Add comments
+ "phasesByName": {
+ "build": {
+ "cleanFiles": [{ "includeGlobs": ["dist", "lib", "lib-commonjs"] }],
+
+ "tasksByName": {
+ "typescript": {
+ "taskPlugin": {
+ "pluginPackage": "@rushstack/heft-typescript-plugin"
+ }
+ },
+ "lint": {
+ "taskDependencies": ["typescript"],
+ "taskPlugin": {
+ "pluginPackage": "@rushstack/heft-lint-plugin"
+ }
+ }
+ }
+ },
+
+ "test": {
+ "phaseDependencies": ["build"],
+ "tasksByName": {
+ "jest": {
+ "taskPlugin": {
+ "pluginPackage": "@rushstack/heft-jest-plugin"
+ }
+ }
+ }
+ }
+ }
+}

build-tests/heft-jest-shards-test/config/jest.config.json

@@ -0,0 +1,15 @@
+{
+ "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json",
+ "coverageDirectory": "<rootDir>/coverage",
+ "collectCoverage": true,
+ "testMatch": ["<rootDir>/lib/**/*.test.cjs"],
+ "collectCoverageFrom": [
+ "lib/**/*.cjs",
+ "!lib/**/*.d.ts",
+ "!lib/**/*.test.cjs",
+ "!lib/**/test/**",
+ "!lib/**/__tests__/**",
+ "!lib/**/__fixtures__/**",
+ "!lib/**/__mocks__/**"
+ ]
+}

build-tests/heft-jest-shards-test/config/rush-project.json

@@ -0,0 +1,17 @@
+{
+ "$schema": "../../../libraries/rush-lib/src/schemas/rush-project.schema.json",
+
+ "operationSettings": [
+ {
+ "operationName": "_phase:build",
+ "outputFolderNames": ["lib", "dist"]
+ },
+ {
+ "operationName": "_phase:test",
+ "outputFolderNames": ["coverage", "temp/coverage"],
+ "sharding": {
+ "count": 6
+ }
+ }
+ ]
+}

build-tests/heft-jest-shards-test/config/typescript.json

@@ -0,0 +1,59 @@
+/**
+ * Configures the TypeScript plugin for Heft. This plugin also manages linting.
+ */
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/typescript.schema.json",
+
+ /**
+ * If provided, emit these module kinds in addition to the modules specified in the tsconfig.
+ * Note that this option only applies to the main tsconfig.json configuration.
+ */
+ "additionalModuleKindsToEmit": [
+ // {
+ // /**
+ // * (Required) Must be one of "commonjs", "amd", "umd", "system", "es2015", "esnext"
+ // */
+ // "moduleKind": "amd",
+ //
+ // /**
+ // * (Required) The name of the folder where the output will be written.
+ // */
+ // "outFolderName": "lib-amd"
+ // }
+ ],
+
+ /**
+ * If true, emit CommonJS module output to the folder specified in the tsconfig "outDir" compiler option with the .cjs extension alongside (or instead of, if TSConfig specifies ESNext) the default compilation output.
+ */
+ "emitCjsExtensionForCommonJS": true,
+
+ /**
+ * If true, emit ESNext module output to the folder specified in the tsconfig "outDir" compiler option with the .mjs extension alongside (or instead of, if TSConfig specifies ESNext) the default compilation output.
+ */
+ // "emitMjsExtensionForESModule": true,
+
+ /**
+ * Describes the way files should be statically coped from src to TS output folders
+ */
+ "staticAssetsToCopy": {
+ /**
+ * File extensions that should be copied from the src folder to the destination folder(s).
+ */
+ "fileExtensions": [".css", ".png"]
+
+ /**
+ * Glob patterns that should be explicitly included.
+ */
+ // "includeGlobs": [
+ // "some/path/*.js"
+ // ],
+
+ /**
+ * Glob patterns that should be explicitly excluded. This takes precedence over globs listed
+ * in "includeGlobs" and files that match the file extensions provided in "fileExtensions".
+ */
+ // "excludeGlobs": [
+ // "some/path/*.css"
+ // ]
+ }
+}

build-tests/heft-jest-shards-test/coverage.json

@@ -0,0 +1,136 @@
+{
+ "/Users/aramis.sennyey/Projects/rushstack/build-tests/heft-jest-shards-test/src/index.ts": {
+ "path": "/Users/aramis.sennyey/Projects/rushstack/build-tests/heft-jest-shards-test/src/index.ts",
+ "all": true,
+ "statementMap": {
+ "0": {
+ "start": {
+ "line": 1,
+ "column": 0
+ },
+ "end": {
+ "line": 1,
+ "column": 92
+ }
+ },
+ "1": {
+ "start": {
+ "line": 2,
+ "column": 0
+ },
+ "end": {
+ "line": 2,
+ "column": 59
+ }
+ },
+ "2": {
+ "start": {
+ "line": 3,
+ "column": 0
+ },
+ "end": {
+ "line": 3,
+ "column": 0
+ }
+ },
+ "3": {
+ "start": {
+ "line": 4,
+ "column": 0
+ },
+ "end": {
+ "line": 4,
+ "column": 51
+ }
+ },
+ "4": {
+ "start": {
+ "line": 5,
+ "column": 0
+ },
+ "end": {
+ "line": 5,
+ "column": 15
+ }
+ },
+ "5": {
+ "start": {
+ "line": 6,
+ "column": 0
+ },
+ "end": {
+ "line": 6,
+ "column": 1
+ }
+ }
+ },
+ "s": {
+ "0": 0,
+ "1": 0,
+ "2": 0,
+ "3": 0,
+ "4": 0,
+ "5": 0
+ },
+ "branchMap": {
+ "0": {
+ "type": "branch",
+ "line": 1,
+ "loc": {
+ "start": {
+ "line": 1,
+ "column": 223
+ },
+ "end": {
+ "line": 6,
+ "column": 1
+ }
+ },
+ "locations": [
+ {
+ "start": {
+ "line": 1,
+ "column": 223
+ },
+ "end": {
+ "line": 6,
+ "column": 1
+ }
+ }
+ ]
+ }
+ },
+ "b": {
+ "0": [0]
+ },
+ "fnMap": {
+ "0": {
+ "name": "(empty-report)",
+ "decl": {
+ "start": {
+ "line": 1,
+ "column": 223
+ },
+ "end": {
+ "line": 6,
+ "column": 1
+ }
+ },
+ "loc": {
+ "start": {
+ "line": 1,
+ "column": 223
+ },
+ "end": {
+ "line": 6,
+ "column": 1
+ }
+ },
+ "line": 1
+ }
+ },
+ "f": {
+ "0": 0
+ }
+ }
+}

build-tests/heft-jest-shards-test/package.json

@@ -0,0 +1,24 @@
+{
+ "name": "heft-jest-shards-test",
+ "description": "This project illustrates configuring Jest sharding in a minimal Heft project",
+ "version": "1.0.0",
+ "private": true,
+ "scripts": {
+ "build": "heft build --clean",
+ "start": "heft build-watch",
+ "_phase:build": "heft run --only build -- --clean",
+ "_phase:test": "heft run --only test -- --clean --max-workers=1"
+ },
+ "devDependencies": {
+ "@jest/types": "29.5.0",
+ "local-eslint-config": "workspace:*",
+ "@rushstack/heft": "workspace:*",
+ "@rushstack/heft-jest-plugin": "workspace:*",
+ "@rushstack/heft-lint-plugin": "workspace:*",
+ "@rushstack/heft-typescript-plugin": "workspace:*",
+ "@types/heft-jest": "1.0.1",
+ "eslint": "~8.7.0",
+ "typescript": "~5.3.3",
+ "@types/node": "18.17.15"
+ }
+}

build-tests/heft-jest-shards-test/src/index.ts

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+export function add(a: number, b: number): number {
+ return a + b;
+}

build-tests/heft-jest-shards-test/src/test/index.test.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('othertests', () => {
+ it.each(new Array(100).fill(0))('should succeed', async (i) => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ expect(1 + 1).toEqual(2);
+ });
+});

build-tests/heft-jest-shards-test/src/test/othertests.test.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('index.test', () => {
+ it.each(new Array(100).fill(0))('should succeed', async () => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ expect(1 + 1).toEqual(2);
+ });
+});

build-tests/heft-jest-shards-test/src/test/test.test.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('tests', () => {
+ it.each(new Array(100).fill(0))('should succeed', async (i) => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ // comment
+ expect(1 + 1).toEqual(2);
+ });
+});

build-tests/heft-jest-shards-test/src/test/test2.test.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('othertests', () => {
+ it.each(new Array(100).fill(0))('should succeed', async (i) => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ expect(1 + 1).toEqual(2);
+ });
+});

build-tests/heft-jest-shards-test/src/test/test3.test.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('othertests', () => {
+ it.each(new Array(100).fill(0))('should succeed', async (i) => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ expect(1 + 1).toEqual(2);
+ });
+});

build-tests/heft-jest-shards-test/src/test/test4.test.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+describe('othertests', () => {
+ it.each(new Array(100).fill(0))('should succeed', async (i) => {
+ await new Promise((resolve) => setTimeout(resolve, 10));
+ expect(1 + 1).toEqual(2);
+ });
+});