@carbon/cli 11.32.0-rc.0 → 11.32.0

package/src/commands/contribute/setup.js

@@ -1,18 +1,16 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const chalk = require('chalk');
-const { exec } = require('child-process-promise');
-const { prompt } = require('inquirer');
-const path = require('path');
-const createLogger = require('progress-estimator');
-const getGitHubClient = require('./tools/getGitHubClient');
+import chalk from 'chalk';
+import { exec } from 'child-process-promise';
+import inquirer from 'inquirer';
+import path from 'path';
+import createLogger from 'progress-estimator';
+import getGitHubClient from './tools/getGitHubClient.js';
 
 const logger = createLogger();
 
@@ -22,13 +20,13 @@ chalk.dimmed = chalk.dim.italic;
 async function setup() {
   console.log(chalk`
 {bold Hi there!} 👋
-This tools is built for people looking to contribute to carbon.`);
+This tool is built for people looking to contribute to carbon.`);
 
   if (!process.env.GH_TOKEN) {
     console.log(chalk`
 To get started, you will need a GitHub account {link (https://github.com/)}
 
-Once you have an account you will need to setup a GitHub access token
+Once you have an account you will need to set up a GitHub access token
 {link (https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)}
 `);
   }
@@ -43,7 +41,7 @@ Once you have an account you will need to setup a GitHub access token
 Our first step is going to be to create a fork for each project you want to work on.
 `);
 
-  const { projects } = await prompt([
+  const { projects } = await inquirer.prompt([
     {
       type: 'checkbox',
       name: 'projects',
@@ -81,11 +79,11 @@ async function fork(client, cwd, project) {
   );
 
   console.log(
-    `Your fork is done! Now let's setup the project on your computer.`
+    `Your fork is done! Now let's set up the project on your computer.`
   );
   console.log();
 
-  const { folder } = await prompt([
+  const { folder } = await inquirer.prompt([
     {
       type: 'input',
       name: 'folder',
@@ -223,8 +221,6 @@ const availableProjects = [
   },
 ];
 
-module.exports = {
-  command: 'setup',
-  desc: 'setup your environment',
-  handler: wrap(setup),
-};
+export const command = 'setup';
+export const desc = 'setup your environment';
+export const handler = wrap(setup);

package/src/commands/contribute/tools/getGitHubClient.js

@@ -5,17 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const Octokit = require('@octokit/rest');
-const { prompt } = require('inquirer');
+import inquirer from 'inquirer';
+import { Octokit } from '@octokit/rest';
 
 const CustomOctokit = Octokit.plugin([
-  require('@octokit/plugin-throttling'),
-  require('@octokit/plugin-retry'),
+  import('@octokit/plugin-throttling'),
+  import('@octokit/plugin-retry'),
 ]);
 
-async function getGitHubClient() {
+export default async function getGitHubClient() {
   let { GH_TOKEN } = process.env;
 
   if (!GH_TOKEN) {
@@ -27,7 +25,7 @@ async function getGitHubClient() {
         hint: 'Help: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line',
       },
     ];
-    const answers = await prompt(question);
+    const answers = await inquirer.prompt(question);
     GH_TOKEN = answers.token;
   }
 
@@ -67,5 +65,3 @@ async function getGitHubClient() {
     throw new Error('Invalid GitHub token');
   }
 }
-
-module.exports = getGitHubClient;

package/src/commands/contribute.js

@@ -1,16 +1,13 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
+export const command = 'contribute <command>';
+export const desc = 'get started contributing with Carbon';
 
-module.exports = {
-  command: 'contribute <command>',
-  desc: 'get started contributing with Carbon',
-  builder(yargs) {
-    yargs.commandDir('contribute');
-  },
+export const builder = (yargs) => {
+  yargs.commandDir('contribute');
 };

package/src/commands/inline.js

@@ -1,18 +1,16 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const fs = require('fs-extra');
-const klaw = require('klaw-sync');
-const os = require('os');
-const path = require('path');
-const replace = require('replace-in-file');
-const { createLogger } = require('../logger');
+import fs from 'fs-extra';
+import klaw from 'klaw-sync';
+import os from 'os';
+import path from 'path';
+import { replaceInFile } from 'replace-in-file';
+import { createLogger } from '../logger.js';
 
 const logger = createLogger('inline');
 const isWin = process.platform === 'win32';
@@ -121,7 +119,7 @@ async function inlineSassDependencies(
         vendorFolder
       );
 
-      await replace({
+      await replaceInFile({
         files: file.path,
         from: REPLACE_REGEX,
         glob: { windowsPathsNoEscape: true },
@@ -154,18 +152,18 @@ function findSassModule(packageName, cwd) {
   return false;
 }
 
-module.exports = {
-  command: 'inline',
-  desc: 'inline sass dependencies from package.json in a target folder',
-  builder(yargs) {
-    yargs.options({
-      o: {
-        alias: 'output',
-        describe: 'the directory to output inlined sass dependencies',
-        type: 'string',
-        default: 'scss',
-      },
-    });
-  },
-  handler: inline,
+export const builder = (yargs) => {
+  yargs.options({
+    o: {
+      alias: 'output',
+      describe: 'the directory to output inlined sass dependencies',
+      type: 'string',
+      default: 'scss',
+    },
+  });
 };
+
+export const command = 'inline';
+export const desc =
+  'inline sass dependencies from package.json in a target folder';
+export const handler = inline;

package/src/commands/publish.js

@@ -1,27 +1,27 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const execa = require('execa');
-const { prompt } = require('inquirer');
-const semver = require('semver');
-const { generate } = require('../changelog');
-const { fetchLatestFromUpstream } = require('../git');
-const { createLogger, displayBanner } = require('../logger');
-const { getPackages } = require('../workspace');
+import { execa } from 'execa';
+import inquirer from 'inquirer';
+import semver from 'semver';
+import { generate } from '../changelog.js';
+import { fetchLatestFromUpstream } from '../git.js';
+import { createLogger, displayBanner } from '../logger.js';
+import { getPackages } from '../workspace.js';
 
 const logger = createLogger('publish');
+
 // Enqueue tasks to run at the end of the command where we want to "clean-up"
 // the environment
 const deferred = [];
 function defer(thunk) {
   deferred.push(thunk);
 }
+
 async function cleanup() {
   for (let i = deferred.length - 1; i >= 0; i--) {
     const task = deferred[i];
@@ -144,7 +144,7 @@ async function publish({ tag, ...flags }) {
 
   // We specify a stopping point so that the operator can verify the packages
   // published as intended before setting the `latest` dist-tag
-  const answers = await prompt([
+  const answers = await inquirer.prompt([
     {
       type: 'confirm',
       name: 'tags',
@@ -170,7 +170,7 @@ async function publish({ tag, ...flags }) {
   }
 
   if (!noPush) {
-    const { remote } = await prompt([
+    const { remote } = await inquirer.prompt([
       {
         type: 'confirm',
         name: 'remote',
@@ -191,7 +191,7 @@ async function publish({ tag, ...flags }) {
   const changelog = await generate(packages, lastTag, tag);
   logger.stop();
 
-  const { display } = await prompt([
+  const { display } = await inquirer.prompt([
     {
       type: 'confirm',
       name: 'display',
@@ -218,55 +218,55 @@ async function getLastGitTag() {
   return tags[0];
 }
 
-module.exports = {
-  command: 'publish <tag>',
-  desc: 'publish packages that have different versions from the package registry',
-  builder(yargs) {
-    yargs.positional('tag', {
-      describe: 'the version tag associated with the release',
-      type: 'string',
-    });
-
-    yargs.option('skip-reset', {
-      demandOption: false,
-      default: false,
-      describe: 'Skip the project reset step',
-      type: 'boolean',
-    });
-
-    yargs.option('registry', {
-      demandOption: false,
-      describe: 'Specify registry URL',
-      default: 'https://registry.npmjs.org/',
-      type: 'string',
-    });
-
-    yargs.option('no-git-tag-version', {
-      demandOption: false,
-      describe: 'Do not commit or tag version changes.',
-      default: false,
-      type: 'boolean',
-    });
-
-    yargs.option('git-remote', {
-      demandOption: false,
-      describe: 'Push git changes to the specified remote.',
-      default: 'upstream',
-      type: 'string',
-    });
+export const builder = (yargs) => {
+  yargs.positional('tag', {
+    describe: 'the version tag associated with the release',
+    type: 'string',
+  });
+
+  yargs.option('skip-reset', {
+    demandOption: false,
+    default: false,
+    describe: 'Skip the project reset step',
+    type: 'boolean',
+  });
+
+  yargs.option('registry', {
+    demandOption: false,
+    describe: 'Specify registry URL',
+    default: 'https://registry.npmjs.org/',
+    type: 'string',
+  });
+
+  yargs.option('no-git-tag-version', {
+    demandOption: false,
+    describe: 'Do not commit or tag version changes.',
+    default: false,
+    type: 'boolean',
+  });
+
+  yargs.option('git-remote', {
+    demandOption: false,
+    describe: 'Push git changes to the specified remote.',
+    default: 'upstream',
+    type: 'string',
+  });
+
+  yargs.option('no-push', {
+    demandOption: false,
+    describe: 'Do not push tagged commit to git remote.',
+    default: false,
+    type: 'boolean',
+  });
+};
 
-    yargs.option('no-push', {
-      demandOption: false,
-      describe: 'Do not push tagged commit to git remote.',
-      default: false,
-      type: 'boolean',
-    });
-  },
-  async handler(...args) {
-    try {
-      await publish(...args);
-    } finally {
-      await cleanup();
-    }
-  },
+export const command = 'publish <tag>';
+export const desc =
+  'publish packages that have different versions from the package registry';
+export const handler = async (...args) => {
+  try {
+    await publish(...args);
+  } finally {
+    await cleanup();
+  }
 };

package/src/commands/release.js

@@ -1,18 +1,16 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const parse = require('@commitlint/parse');
-const execa = require('execa');
-const { prompt } = require('inquirer');
-const semver = require('semver');
-const { fetchLatestFromUpstream } = require('../git');
-const { createLogger, displayBanner } = require('../logger');
+import parse from '@commitlint/parse';
+import { execa } from 'execa';
+import inquirer from 'inquirer';
+import semver from 'semver';
+import { fetchLatestFromUpstream } from '../git.js';
+import { createLogger, displayBanner } from '../logger.js';
 
 // All supported commit types from our conventional-changelog preset
 const types = [
@@ -166,7 +164,7 @@ async function cherryPickCommitsFrom(commitRange, bump) {
     // If we cannot derive the commit type, we'll need to manually confirm if we
     // should include the commit
     if (info.type === null) {
-      const answers = await prompt([
+      const answers = await inquirer.prompt([
         {
           type: 'confirm',
           name: 'confirmed',
@@ -207,7 +205,7 @@ async function cherryPickCommitsFrom(commitRange, bump) {
       if (!error.stderr.startsWith('error: could not apply')) {
         throw error;
       }
-      const answers = await prompt([
+      const answers = await inquirer.prompt([
         {
           type: 'confirm',
           name: 'proceed',
@@ -267,7 +265,7 @@ async function resetProjectState() {
 async function checkIfBranchIsDirty() {
   const { stdout } = await execa('git', ['status', '--porcelain']);
   if (stdout !== '') {
-    const { confirmed } = await prompt([
+    const { confirmed } = await inquirer.prompt([
       {
         type: 'confirm',
         name: 'confirmed',
@@ -288,15 +286,14 @@ async function checkIfBranchIsDirty() {
   }
 }
 
-module.exports = {
-  command: 'release [bump]',
-  desc: 'run the release step for the given version bump',
-  builder(yargs) {
-    yargs.positional('bump', {
-      describe: 'choose a release version to bump',
-      choices: ['minor', 'patch'],
-      default: 'patch',
-    });
-  },
-  handler: release,
+export const builder = (yargs) => {
+  yargs.positional('bump', {
+    describe: 'choose a release version to bump',
+    choices: ['minor', 'patch'],
+    default: 'patch',
+  });
 };
+
+export const command = 'release [bump]';
+export const desc = 'run the release step for the given version bump';
+export const handler = release;

package/src/commands/sync/npm.js

@@ -1,14 +1,12 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const fs = require('fs-extra');
-const path = require('path');
+import fs from 'fs-extra';
+import path from 'path';
 
 const defaultIgnorePatterns = [
   '**/__mocks__/**',
@@ -17,7 +15,7 @@ const defaultIgnorePatterns = [
   '**/tasks/**',
 ];
 
-function run({ packagePaths }) {
+export default async function run({ packagePaths }) {
   return Promise.all(
     packagePaths.map(async ({ packagePath }) => {
       const ignorePath = path.join(packagePath, '.npmignore');
@@ -37,7 +35,4 @@ function run({ packagePaths }) {
   );
 }
 
-module.exports = {
-  name: 'npm',
-  run,
-};
+export const name = 'npm';

package/src/commands/sync/package.js

@@ -1,13 +1,11 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const fs = require('fs-extra');
+import fs from 'fs-extra';
 
 // This is our default set of keywords to include in each `package.json` packageJson
 const DEFAULT_KEYWORDS = [
@@ -69,7 +67,7 @@ function sortFields(a, b) {
   return aValue - bValue;
 }
 
-function run({ packagePaths }) {
+export default async function run({ packagePaths }) {
   return Promise.all(
     packagePaths.map(
       async ({ packageJsonPath, packageJson, packageFolder }) => {
@@ -117,7 +115,4 @@ function run({ packagePaths }) {
   );
 }
 
-module.exports = {
-  name: 'package',
-  run,
-};
+export const name = 'package';

package/src/commands/sync/readme.js

@@ -1,18 +1,16 @@
 /**
- * Copyright IBM Corp. 2019, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
-
-const fs = require('fs-extra');
-const path = require('path');
-const prettier = require('prettier2');
-const prettierConfig = require('prettier-config-carbon');
-const createRemark = require('remark');
-const monorepo = require('./remark/remark-monorepo');
+import fs from 'fs-extra';
+import path from 'path';
+import prettier from 'prettier';
+import prettierConfig from 'prettier-config-carbon';
+import { remark } from 'remark';
+import monorepo from './remark/remark-monorepo.js';
 
 const packageDenyList = new Set([
   'carbon-components',
@@ -21,8 +19,8 @@ const packageDenyList = new Set([
   '@carbon/styles',
 ]);
 
-function run({ root, packagePaths }) {
-  const remark = createRemark().use(monorepo, {
+export default async function run({ root, packagePaths }) {
+  const remarkInstance = remark().use(monorepo, {
     root: root.directory,
   });
   const prettierOptions = {
@@ -40,7 +38,7 @@ function run({ root, packagePaths }) {
         }
 
         const readme = await fs.readFile(README_PATH, 'utf8');
-        const file = await process(remark, packagePath, readme);
+        const file = await process(remarkInstance, packagePath, readme);
         await fs.writeFile(
           README_PATH,
           prettier.format(String(file), prettierOptions)
@@ -49,9 +47,9 @@ function run({ root, packagePaths }) {
   );
 }
 
-function process(remark, cwd, contents) {
+function process(remarkInstance, cwd, contents) {
   return new Promise((resolve, reject) => {
-    remark.process({ cwd, contents }, (error, file) => {
+    remarkInstance.process({ cwd, contents }, (error, file) => {
       if (error) {
         reject(error);
         return;
@@ -61,7 +59,4 @@ function process(remark, cwd, contents) {
   });
 }
 
-module.exports = {
-  name: 'readme',
-  run,
-};
+export const name = 'readme';

package/src/commands/sync/remark/remark-monorepo.js

@@ -1,16 +1,14 @@
 /**
- * Copyright IBM Corp. 2018, 2023
+ * Copyright IBM Corp. 2019, 2025
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
-
-function monorepo() {
+export default function monorepo() {
   async function transformer(tree, file) {
     const { cwd } = file;
     const localPackageJsonPath = path.join(cwd, 'package.json');
@@ -421,5 +419,3 @@ function createLicense() {
     },
   ];
 }
-
-module.exports = monorepo;