build: update to chalk version that works in circleci (#17193)

devversion · jelbourn · commit 7cd78ffc59c1 · 2019-09-24T15:56:25.000-07:00
Updates to a chalk version that works in CircleCI (due to a more recent dependency on `supports-color`). Since the latest chalk version brings official typings that do not declare individual colors as ESM exports, we need to go through the default export. This is the official expected behavior with `chalk` according to: chalk/chalk#215.
diff --git a/package.json b/package.json
@@ -78,7 +78,6 @@
     "@octokit/rest": "^16.28.7",
     "@schematics/angular": "^9.0.0-next.5",
     "@types/browser-sync": "^2.26.1",
-    "@types/chalk": "^0.4.31",
     "@types/fs-extra": "^4.0.3",
     "@types/glob": "^5.0.33",
     "@types/gulp": "3.8.32",
@@ -97,7 +96,7 @@
     "autoprefixer": "^6.7.6",
     "axe-webdriverjs": "^1.1.1",
     "browser-sync": "^2.26.7",
-    "chalk": "^1.1.3",
+    "chalk": "^2.4.2",
     "clang-format": "^1.2.4",
     "codelyzer": "^5.1.1",
     "conventional-changelog": "^3.0.5",
diff --git a/scripts/breaking-changes.ts b/scripts/breaking-changes.ts
@@ -1,6 +1,6 @@
 import {join, relative} from 'path';
 import {readFileSync} from 'fs';
-import {bold, red, green} from 'chalk';
+import chalk from 'chalk';
 import * as ts from 'typescript';
 import * as tsutils from 'tsutils';
 
@@ -47,12 +47,12 @@ parsedConfig.fileNames.forEach(fileName => {
 // Go through the summary and log out all of the breaking changes.
 Object.keys(summary).forEach(version => {
   const isExpired = hasExpired(packageVersion, version);
-  const status = isExpired ? red('(expired)') : green('(not expired)');
-  const header = bold(`Breaking changes for ${version} ${status}:`);
+  const status = isExpired ? chalk.red('(expired)') : chalk.green('(not expired)');
+  const header = chalk.bold(`Breaking changes for ${version} ${status}:`);
   const messages = summary[version].join('\n');
 
-  console.log(isExpired ? red(header) : header);
-  console.log(isExpired ? red(messages) : messages, '\n');
+  console.log(isExpired ? chalk.red(header) : header);
+  console.log(isExpired ? chalk.red(messages) : messages, '\n');
 });
 
 /**
diff --git a/src/cdk/schematics/ng-update/index.ts b/src/cdk/schematics/ng-update/index.ts
@@ -7,7 +7,7 @@
  */
 
 import {Rule} from '@angular-devkit/schematics';
-import {green, yellow} from 'chalk';
+import chalk from 'chalk';
 import {TargetVersion} from '../update-tool/target-version';
 import {cdkUpgradeData} from './upgrade-data';
 import {createUpgradeRule} from './upgrade-rules';
@@ -35,11 +35,11 @@ export function updateToV9(): Rule {
 /** Function that will be called when the migration completed. */
 function onMigrationComplete(targetVersion: TargetVersion, hasFailures: boolean) {
   console.log();
-  console.log(green(`  ✓  Updated Angular CDK to ${targetVersion}`));
+  console.log(chalk.green(`  ✓  Updated Angular CDK to ${targetVersion}`));
   console.log();
 
   if (hasFailures) {
-    console.log(yellow(
+    console.log(chalk.yellow(
       '  ⚠  Some issues were detected but could not be fixed automatically. Please check the ' +
       'output above and fix these issues manually.'));
   }
diff --git a/src/cdk/schematics/ng-update/upgrade-rules/class-inheritance-rule.ts b/src/cdk/schematics/ng-update/upgrade-rules/class-inheritance-rule.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {bold, green, red} from 'chalk';
+import chalk from 'chalk';
 import * as ts from 'typescript';
 import {MigrationRule} from '../../update-tool/migration-rule';
 import {PropertyNameUpgradeData} from '../data/property-names';
@@ -54,9 +54,9 @@ export class ClassInheritanceRule extends MigrationRule<RuleUpgradeData> {
       if (data) {
         this.createFailureAtNode(
             node,
-            `Found class "${bold(className)}" which extends class ` +
-                `"${bold(typeName)}". Please note that the base class property ` +
-                `"${red(data.replace)}" has changed to "${green(data.replaceWith)}". ` +
+            `Found class "${chalk.bold(className)}" which extends class ` +
+                `"${chalk.bold(typeName)}". Please note that the base class property ` +
+                `"${chalk.red(data.replace)}" has changed to "${chalk.green(data.replaceWith)}". ` +
                 `You may need to update your class as well.`);
       }
     });
diff --git a/src/material/schematics/BUILD.bazel b/src/material/schematics/BUILD.bazel
@@ -34,6 +34,7 @@ ts_library(
         "@npm//@types/node",
         "@npm//tslint",
         "@npm//typescript",
+        "@npm//chalk",
     ],
 )
 
diff --git a/src/material/schematics/ng-add/setup-project.ts b/src/material/schematics/ng-add/setup-project.ts
@@ -14,7 +14,7 @@ import {
   getProjectStyleFile,
   hasNgModuleImport,
 } from '@angular/cdk/schematics';
-import {red, bold, italic} from 'chalk';
+import chalk from 'chalk';
 import {getWorkspace} from '@schematics/angular/utility/config';
 import {getAppModulePath} from '@schematics/angular/utility/ng-ast-utils';
 import {addFontsToIndex} from './fonts/material-fonts';
@@ -61,9 +61,10 @@ function addAnimationsModule(options: Schema) {
       // animations. If we would add the BrowserAnimationsModule while the NoopAnimationsModule
       // is already configured, we would cause unexpected behavior and runtime exceptions.
       if (hasNgModuleImport(host, appModulePath, noopAnimationsModuleName)) {
-        return console.warn(red(`Could not set up "${bold(browserAnimationsModuleName)}" ` +
-            `because "${bold(noopAnimationsModuleName)}" is already imported. Please manually ` +
-            `set up browser animations.`));
+        return console.warn(chalk.red(
+            `Could not set up "${chalk.bold(browserAnimationsModuleName)}" ` +
+            `because "${chalk.bold(noopAnimationsModuleName)}" is already imported. Please ` +
+            `manually set up browser animations.`));
       }
 
       addModuleImportToRootModule(host, browserAnimationsModuleName,
@@ -90,17 +91,17 @@ function addMaterialAppStyles(options: Schema) {
     const styleFilePath = getProjectStyleFile(project);
 
     if (!styleFilePath) {
-      console.warn(red(`Could not find the default style file for this project.`));
-      console.warn(red(`Please consider manually setting up the Roboto font in your CSS.`));
+      console.warn(chalk.red(`Could not find the default style file for this project.`));
+      console.warn(chalk.red(`Please consider manually setting up the Roboto font in your CSS.`));
       return;
     }
 
     const buffer = host.read(styleFilePath);
 
     if (!buffer) {
-      console.warn(red(`Could not read the default style file within the project ` +
-        `(${italic(styleFilePath)})`));
-      console.warn(red(`Please consider manually setting up the Robot font.`));
+      console.warn(chalk.red(`Could not read the default style file within the project ` +
+        `(${chalk.italic(styleFilePath)})`));
+      console.warn(chalk.red(`Please consider manually setting up the Robot font.`));
       return;
     }
 
diff --git a/src/material/schematics/ng-add/theming/theming.ts b/src/material/schematics/ng-add/theming/theming.ts
@@ -16,7 +16,7 @@ import {
 } from '@angular/cdk/schematics';
 import {InsertChange} from '@schematics/angular/utility/change';
 import {getWorkspace} from '@schematics/angular/utility/config';
-import {bold, red, yellow} from 'chalk';
+import chalk from 'chalk';
 import {join} from 'path';
 import {Schema} from '../schema';
 import {createCustomTheme} from './create-custom-theme';
@@ -71,8 +71,8 @@ function insertCustomTheme(project: WorkspaceProject, projectName: string, host:
     const customThemePath = normalize(join(project.sourceRoot, defaultCustomThemeFilename));
 
     if (host.exists(customThemePath)) {
-      console.warn(yellow(`Cannot create a custom Angular Material theme because
-          ${bold(customThemePath)} already exists. Skipping custom theme generation.`));
+      console.warn(chalk.yellow(`Cannot create a custom Angular Material theme because
+          ${chalk.bold(customThemePath)} already exists. Skipping custom theme generation.`));
       return;
     }
 
@@ -125,10 +125,11 @@ function addThemeStyleToTarget(project: WorkspaceProject, targetName: 'test' | '
       // theme because these files can contain custom styles, while prebuilt themes are
       // always packaged and considered replaceable.
       if (stylePath.includes(defaultCustomThemeFilename)) {
-        console.warn(red(`Could not add the selected theme to the CLI project configuration ` +
-            `because there is already a custom theme file referenced.`));
-        console.warn(red(`Please manually add the following style file to your configuration:`));
-        console.warn(yellow(`    ${bold(assetPath)}`));
+        console.warn(chalk.red(`Could not add the selected theme to the CLI project ` +
+            `configuration because there is already a custom theme file referenced.`));
+        console.warn(chalk.red(
+            `Please manually add the following style file to your configuration:`));
+        console.warn(chalk.yellow(`    ${chalk.bold(assetPath)}`));
         return;
       } else if (stylePath.includes(prebuiltThemePathSegment)) {
         targetOptions.styles.splice(index, 1);
diff --git a/src/material/schematics/ng-update/index.ts b/src/material/schematics/ng-update/index.ts
@@ -8,7 +8,7 @@
 
 import {Rule} from '@angular-devkit/schematics';
 import {createUpgradeRule, TargetVersion} from '@angular/cdk/schematics';
-import {green, yellow} from 'chalk';
+import chalk from 'chalk';
 
 import {materialUpgradeData} from './upgrade-data';
 import {MiscClassInheritanceRule} from './upgrade-rules/misc-checks/misc-class-inheritance-rule';
@@ -58,11 +58,11 @@ export function updateToV9(): Rule {
 /** Function that will be called when the migration completed. */
 function onMigrationComplete(targetVersion: TargetVersion, hasFailures: boolean) {
   console.log();
-  console.log(green(`  ✓  Updated Angular Material to ${targetVersion}`));
+  console.log(chalk.green(`  ✓  Updated Angular Material to ${targetVersion}`));
   console.log();
 
   if (hasFailures) {
-    console.log(yellow(
+    console.log(chalk.yellow(
       '  ⚠  Some issues were detected but could not be fixed automatically. Please check the ' +
       'output above and fix these issues manually.'));
   }
diff --git a/tools/cherry-pick-patch/output-results.ts b/tools/cherry-pick-patch/output-results.ts
@@ -1,5 +1,5 @@
 import {PullsGetResponse} from '@octokit/rest';
-import {cyan} from 'chalk';
+import chalk from 'chalk';
 
 /** Outputs the information of the pull requests to be cherry-picked and the commands to run. */
 export function outputResults(pullRequests: PullsGetResponse[]) {
@@ -9,9 +9,9 @@ export function outputResults(pullRequests: PullsGetResponse[]) {
   }
 
   console.log();
-  console.log(cyan('------------------------'));
-  console.log(cyan('  Results '));
-  console.log(cyan('------------------------'));
+  console.log(chalk.cyan('------------------------'));
+  console.log(chalk.cyan('  Results '));
+  console.log(chalk.cyan('------------------------'));
   console.log();
 
   pullRequests.forEach(p => {
@@ -20,9 +20,9 @@ export function outputResults(pullRequests: PullsGetResponse[]) {
   });
 
   console.log();
-  console.log(cyan('------------------------'));
-  console.log(cyan('  Cherry Pick Commands'));
-  console.log(cyan('------------------------'));
+  console.log(chalk.cyan('------------------------'));
+  console.log(chalk.cyan('  Cherry Pick Commands'));
+  console.log(chalk.cyan('------------------------'));
 
   pullRequests.forEach((pr, index) => {
     if (index % 5 === 0) {
diff --git a/tools/gulp/tasks/default.ts b/tools/gulp/tasks/default.ts
@@ -1,12 +1,13 @@
 import {task} from 'gulp';
-import {yellow} from 'chalk';
+import chalk from 'chalk';
 
 task('default', ['help']);
 
 task('help', function() {
   console.log();
   console.log('Please specify a gulp task you want to run.');
-  console.log(`You're probably looking for ${yellow('test')} or ${yellow('serve:devapp')}.`);
+  console.log(`You're probably looking for ${chalk.yellow('test')} or ` +
+      `${chalk.yellow('serve:devapp')}.`);
   console.log();
 });
 
diff --git a/tools/gulp/tasks/lint.ts b/tools/gulp/tasks/lint.ts
@@ -1,4 +1,4 @@
-import {red} from 'chalk';
+import chalk from 'chalk';
 import {readdirSync, readFileSync, statSync} from 'fs';
 import {task} from 'gulp';
 import {IMinimatch, Minimatch} from 'minimatch';
@@ -62,7 +62,7 @@ task('ownerslint', () => {
         // Report an error for any files that didn't match any owned paths.
         .filter(path => {
           if (statSync(path).isFile()) {
-            console.log(red(`No code owner found for "${path}".`));
+            console.log(chalk.red(`No code owner found for "${path}".`));
             errors++;
             return false;
           }
diff --git a/tools/package-tools/compile-entry-point.ts b/tools/package-tools/compile-entry-point.ts
@@ -1,7 +1,7 @@
 import {join} from 'path';
 import {writeFileSync, readFileSync} from 'fs';
 import {sync as glob} from 'glob';
-import {red} from 'chalk';
+import chalk from 'chalk';
 import {BuildPackage} from './build-package';
 import {tsCompile} from './ts-compile';
 
@@ -20,7 +20,8 @@ export async function compileEntryPoint(buildPackage: BuildPackage, tsconfigName
   }
 
   return tsCompile('ngc', ngcFlags).catch(() => {
-    const error = red(`Failed to compile ${secondaryEntryPoint} using ${entryPointTsconfigPath}`);
+    const error = chalk.red(
+        `Failed to compile ${secondaryEntryPoint} using ${entryPointTsconfigPath}`);
     console.error(error);
     return Promise.reject(error);
   });
diff --git a/tools/package-tools/ts-compile.ts b/tools/package-tools/ts-compile.ts
@@ -1,6 +1,6 @@
 import {resolve as resolvePath} from 'path';
 import {spawn} from 'child_process';
-import {red} from 'chalk';
+import chalk from 'chalk';
 
 /**
  * Spawns a child process that compiles TypeScript using the specified compiler binary.
@@ -15,7 +15,7 @@ export function tsCompile(binary: 'tsc' | 'ngc', flags: string[]) {
 
     // Pipe stdout and stderr from the child process.
     childProcess.stdout.on('data', (data: string|Buffer) => console.log(`${data}`));
-    childProcess.stderr.on('data', (data: string|Buffer) => console.error(red(`${data}`)));
+    childProcess.stderr.on('data', (data: string|Buffer) => console.error(chalk.red(`${data}`)));
     childProcess.on('exit', (exitCode: number) => {
       exitCode === 0 ? resolve() : reject(`${binary} compilation failure`);
     });
diff --git a/tools/package-tools/typescript-transpile.ts b/tools/package-tools/typescript-transpile.ts
@@ -1,7 +1,7 @@
 import * as ts from 'typescript';
 import * as path from 'path';
 import * as fs from 'fs';
-import * as chalk from 'chalk';
+import chalk from 'chalk';
 
 /** Reads a input file and transpiles it into a new file. */
 export function transpileFile(inputPath: string, outputPath: string, options: ts.CompilerOptions) {
diff --git a/tools/release/base-release-task.ts b/tools/release/base-release-task.ts
@@ -1,4 +1,4 @@
-import {green, italic, red, yellow} from 'chalk';
+import chalk from 'chalk';
 import {prompt} from 'inquirer';
 import {GitClient} from './git/git-client';
 import {Version} from './version-name/parse-version';
@@ -20,15 +20,15 @@ export class BaseReleaseTask {
     // If current branch already matches one of the allowed publish branches, just continue
     // by exiting this function and returning the currently used publish branch.
     if (allowedBranches.includes(currentBranchName)) {
-      console.log(green(`  ✓   Using the "${italic(currentBranchName)}" branch.`));
+      console.log(chalk.green(`  ✓   Using the "${chalk.italic(currentBranchName)}" branch.`));
       return currentBranchName;
     }
 
     // In case there are multiple allowed publish branches for this version, we just
     // exit and let the user decide which branch they want to release from.
     if (allowedBranches.length !== 1) {
-      console.warn(yellow('  ✘   You are not on an allowed publish branch.'));
-      console.warn(yellow(`      Please switch to one of the following branches: ` +
+      console.warn(chalk.yellow('  ✘   You are not on an allowed publish branch.'));
+      console.warn(chalk.yellow(`      Please switch to one of the following branches: ` +
         `${allowedBranches.join(', ')}`));
       process.exit(0);
     }
@@ -38,14 +38,15 @@ export class BaseReleaseTask {
     const defaultPublishBranch = allowedBranches[0];
 
     if (!this.git.checkoutBranch(defaultPublishBranch)) {
-      console.error(red(`  ✘   Could not switch to the "${italic(defaultPublishBranch)}" ` +
-        `branch.`));
-      console.error(red(`      Please ensure that the branch exists or manually switch to the ` +
-        `branch.`));
+      console.error(chalk.red(
+          `  ✘   Could not switch to the "${chalk.italic(defaultPublishBranch)}" branch.`));
+      console.error(chalk.red(
+          `      Please ensure that the branch exists or manually switch to the branch.`));
       process.exit(1);
     }
 
-    console.log(green(`  ✓   Switched to the "${italic(defaultPublishBranch)}" branch.`));
+    console.log(chalk.green(
+        `  ✓   Switched to the "${chalk.italic(defaultPublishBranch)}" branch.`));
     return defaultPublishBranch;
   }
 
@@ -56,16 +57,16 @@ export class BaseReleaseTask {
 
     // Check if the current branch is in sync with the remote branch.
     if (upstreamCommitSha !== localCommitSha) {
-      console.error(red(`  ✘ The current branch is not in sync with the remote branch. Please ` +
-        `make sure your local branch "${italic(publishBranch)}" is up to date.`));
+      console.error(chalk.red(`  ✘ The current branch is not in sync with the remote branch. Please ` +
+        `make sure your local branch "${chalk.italic(publishBranch)}" is up to date.`));
       process.exit(1);
     }
   }
 
   /** Verifies that there are no uncommitted changes in the project. */
   protected verifyNoUncommittedChanges() {
     if (this.git.hasUncommittedChanges()) {
-      console.error(red(`  ✘   There are changes which are not committed and should be ` +
+      console.error(chalk.red(`  ✘   There are changes which are not committed and should be ` +
         `discarded.`));
       process.exit(1);
     }
diff --git a/tools/release/changelog.ts b/tools/release/changelog.ts
@@ -1,4 +1,4 @@
-import {bold, green, yellow} from 'chalk';
+import chalk from 'chalk';
 import {createReadStream, createWriteStream, readFileSync} from 'fs';
 import {prompt} from 'inquirer';
 import {join} from 'path';
@@ -115,7 +115,7 @@ function createChangelogWriterOptions(changelogPath: string) {
           // Filter out duplicate commits. Note that we cannot compare the SHA because the commits
           // will have a different SHA if they are being cherry-picked into a different branch.
           if (existingChangelogContent.includes(commit.subject)) {
-            console.log(yellow(`  ↺   Skipping duplicate: "${bold(commit.header)}"`));
+            console.log(chalk.yellow(`  ↺   Skipping duplicate: "${chalk.bold(commit.header)}"`));
             return false;
           }
 
@@ -206,6 +206,6 @@ function getTypeOfCommitGroupDescription(description: string): string {
 /** Entry-point for generating the changelog when called through the CLI. */
 if (require.main === module) {
   promptAndGenerateChangelog(join(__dirname, '../../CHANGELOG.md')).then(() => {
-    console.log(green('  ✓   Successfully updated the changelog.'));
+    console.log(chalk.green('  ✓   Successfully updated the changelog.'));
   });
 }
diff --git a/tools/release/check-release-output.ts b/tools/release/check-release-output.ts
diff --git a/tools/release/publish-release.ts b/tools/release/publish-release.ts
diff --git a/tools/release/release-output/check-package.ts b/tools/release/release-output/check-package.ts
diff --git a/tools/release/stage-release.ts b/tools/release/stage-release.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ ts_library(`
`34`	`34`	`"@npm//@types/node",`
`35`	`35`	`"@npm//tslint",`
`36`	`36`	`"@npm//typescript",`
	`37`	`+ "@npm//chalk",`
`37`	`38`	`],`
`38`	`39`	`)`
`39`	`40`