use displayName instead of name

jestjs · Dec 8, 2019 · f33e371 · f33e371
1 parent c744596
commit f33e371
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 16 deletions.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -250,7 +250,7 @@ Alias: `-i`. Run all tests serially in the current process, rather than creating
 
 ### `--runProjects <project1> ... <projectN>`
 
-Run only the tests of the specified projects. Jest uses the attribute `name` in the configuration to identify each project.
+Run only the tests of the specified projects. Jest uses the attribute `displayName` in the configuration to identify each project.
 
 ### `--runTestsByPath`
 

diff --git a/e2e/run-projects/package.json b/e2e/run-projects/package.json
@@ -2,14 +2,17 @@
   "jest": {
     "projects": [
       {
-        "name": "first-project",
+        "displayName": "first-project",
         "testMatch": [
           "<rootDir>/__tests__/first-project.test.js"
         ],
         "testEnvironment": "node"
       },
       {
-        "name": "second-project",
+        "displayName": {
+          "name": "second-project",
+          "color": "blue"
+        },
         "testMatch": [
           "<rootDir>/__tests__/second-project.test.js"
         ],

diff --git a/packages/jest-core/src/cli/index.ts b/packages/jest-core/src/cli/index.ts
@@ -76,8 +76,9 @@ export const runCLI = async (
 
   const configsOfProjectsToRun = getConfigsOfProjectsToRun(argv, configs);
   if (argv.runProjects) {
-    const projectNames = configsOfProjectsToRun.map(config => config.name);
-    outputStream.write(getProjectsRunningMessage(projectNames) + '\n');
+    outputStream.write(
+      getProjectsRunningMessage(configsOfProjectsToRun) + '\n',
+    );
   }
 
   await _run(

diff --git a/packages/jest-core/src/getConfigsOfProjectsToRun.ts b/packages/jest-core/src/getConfigsOfProjectsToRun.ts
@@ -6,6 +6,7 @@
  */
 
 import {Config} from '@jest/types';
+import getProjectDisplayName from './getProjectDisplayName';
 
 export default function getConfigsOfProjectsToRun(
   argv: Config.Argv,
@@ -14,6 +15,9 @@ export default function getConfigsOfProjectsToRun(
   if (!argv.runProjects) {
     return projectConfigs;
   }
-  const namesOfProjectsToRun = new Set(argv.runProjects);
-  return projectConfigs.filter(config => namesOfProjectsToRun.has(config.name));
+  const namesOfProjectsToRun = new Set<string>(argv.runProjects);
+  return projectConfigs.filter(config => {
+    const name = getProjectDisplayName(config);
+    return name && namesOfProjectsToRun.has(name);
+  });
 }
diff --git a/packages/jest-core/src/getProjectDisplayName.ts b/packages/jest-core/src/getProjectDisplayName.ts
@@ -0,0 +1,24 @@
+import {Config} from '@jest/types';
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export default function getProjectDisplayName(
+  projectConfig: Config.ProjectConfig,
+): string | undefined {
+  const {displayName} = projectConfig;
+  if (!displayName) {
+    return undefined;
+  }
+  if (typeof displayName === 'string') {
+    return displayName;
+  }
+  if (typeof displayName === 'object') {
+    return displayName.name;
+  }
+  return undefined;
+}
diff --git a/packages/jest-core/src/getProjectsRunningMessage.ts b/packages/jest-core/src/getProjectsRunningMessage.ts
@@ -1,3 +1,6 @@
+import {Config} from '@jest/types';
+import getProjectDisplayName from './getProjectDisplayName';
+
 /**
  * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
  *
@@ -6,21 +9,26 @@
  */
 
 export default function getProjectsRunningMessage(
-  projectNames: Array<string>,
+  projectConfigs: Array<Config.ProjectConfig>,
 ): string {
-  if (projectNames.length === 0) {
+  if (projectConfigs.length === 0) {
     return 'No project to run';
   }
-  if (projectNames.length === 1) {
-    return `Will run one project: ${projectNames[0]}`;
+  if (projectConfigs.length === 1) {
+    const name = getProjectDisplayName(projectConfigs[0]);
+    return `Will run one project: ${name}`;
   }
-  const projectsList = projectNames
-    .map(getListElement)
+  const projectsList = projectConfigs
+    .map(getProjectNameListElement)
     .sort()
     .join('\n');
-  return `Will run ${projectNames.length} projects:\n` + projectsList;
+  return `Will run ${projectConfigs.length} projects:\n` + projectsList;
 }
 
-function getListElement(content: string): string {
-  return `- ${content}`;
+function getProjectNameListElement(
+  projectConfig: Config.ProjectConfig,
+): string {
+  const name = getProjectDisplayName(projectConfig);
+  const elementContent = name || '<unnamed project>';
+  return `- ${elementContent}`;
 }