@carbon/cli 11.34.0 → 11.35.0

package/README.md

@@ -39,7 +39,6 @@ Commands:
   cli publish <tag>         publish packages that have different versions from
                             the package registry
   cli release [bump]        run the release step for the given version bump
-  cli sync [target]         sync files across workspaces
 
 Options:
   --help     Show help                                                 [boolean]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/cli",
   "description": "Task automation for working with the Carbon Design System",
-  "version": "11.34.0",
+  "version": "11.35.0",
   "license": "Apache-2.0",
   "type": "module",
   "bin": {
@@ -57,5 +57,5 @@
     "typescript-config-carbon": "^0.7.0",
     "yargs": "^17.7.2"
   },
-  "gitHead": "c76188a59aad432ce28e79b1a8a6b95457ba2cce"
+  "gitHead": "8f9dd77c8055a1a1ce36af55298c19c9f8966ab9"
 }

package/src/cli.js

@@ -19,7 +19,6 @@ import * as contribute from './commands/contribute.js';
 import * as inline from './commands/inline.js';
 import * as publish from './commands/publish.js';
 import * as release from './commands/release.js';
-import * as sync from './commands/sync.js';
 
 const require = createRequire(import.meta.url);
 
@@ -53,7 +52,6 @@ export async function main({ argv }) {
     .command(createCommand(inline))
     .command(createCommand(publish))
     .command(createCommand(release))
-    .command(createCommand(sync))
     .strict()
     .fail((message, error, yargs) => {
       if (error) {

package/src/commands/sync/npm.js

@@ -1,38 +0,0 @@
-/**
- * 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.
- */
-
-import fs from 'fs-extra';
-import path from 'path';
-
-const defaultIgnorePatterns = [
-  '**/__mocks__/**',
-  '**/__tests__/**',
-  '**/examples/**',
-  '**/tasks/**',
-];
-
-export default async function run({ packagePaths }) {
-  return Promise.all(
-    packagePaths.map(async ({ packagePath }) => {
-      const ignorePath = path.join(packagePath, '.npmignore');
-      const ignorePatterns = defaultIgnorePatterns.slice();
-
-      if (await fs.pathExists(ignorePath)) {
-        const ignoreFile = await fs.readFile(ignorePath, 'utf8');
-        const localIgnorePatterns = ignoreFile.split('\n').filter((pattern) => {
-          return ignorePatterns.indexOf(pattern) === -1;
-        });
-
-        ignorePatterns.push(...localIgnorePatterns);
-      }
-
-      await fs.writeFile(ignorePath, ignorePatterns.join('\n'));
-    })
-  );
-}
-
-export const name = 'npm';

package/src/commands/sync/package.js

@@ -1,118 +0,0 @@
-/**
- * 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.
- */
-
-import fs from 'fs-extra';
-
-// This is our default set of keywords to include in each `package.json` packageJson
-const DEFAULT_KEYWORDS = [
-  'ibm',
-  'carbon',
-  'carbon-design-system',
-  'components',
-  'react',
-];
-
-// We're going to use this in our `sortFields` method. The idea is that we want
-// our `package.json` files to be ordered in the order given in this array. To
-// accomplish this, we create an object where we can reference the value
-// assigned to a field when sorting. By default, highest priority fields start
-// with 1 and go up. Unknown fields are all given the same priority, which is
-// just the length of the array + 1. When we use `sortFields` we are checking
-// for the value from `packageJsonFields` and comparing it with the other value.
-const packageJsonFields = [
-  'name',
-  'private',
-  'description',
-  'version',
-  'license',
-  'bin',
-  'main',
-  'module',
-  'type',
-  'exports',
-  'repository',
-  'sideEffects',
-  'bugs',
-  'homepage',
-  'engines',
-  'files',
-  'keywords',
-  'publishConfig',
-  'scripts',
-  'resolutions',
-  'peerDependencies',
-  'dependencies',
-  'devDependencies',
-  'sideEffects',
-  'eyeglass',
-  'eslintConfig',
-  'prettier',
-  'babel',
-  'jest',
-].reduce(
-  (acc, key, index) => ({
-    ...acc,
-    [key]: index + 1,
-  }),
-  {}
-);
-const UNKNOWN_FIELD = Object.keys(packageJsonFields).length + 1;
-function sortFields(a, b) {
-  const aValue = packageJsonFields[a] || UNKNOWN_FIELD;
-  const bValue = packageJsonFields[b] || UNKNOWN_FIELD;
-  return aValue - bValue;
-}
-
-export default async function run({ packagePaths }) {
-  return Promise.all(
-    packagePaths.map(
-      async ({ packageJsonPath, packageJson, packageFolder }) => {
-        packageJson.repository = {
-          type: 'git',
-          url: 'https://github.com/carbon-design-system/carbon.git',
-          directory: packageFolder,
-        };
-        packageJson.bugs =
-          'https://github.com/carbon-design-system/carbon/issues';
-        packageJson.license = 'Apache-2.0';
-
-        if (!packageJson.private) {
-          packageJson.publishConfig = {
-            access: 'public',
-            provenance: 'true',
-          };
-        }
-
-        if (Array.isArray(packageJson.keywords)) {
-          const keywordsToAdd = DEFAULT_KEYWORDS.filter((keyword) => {
-            return packageJson.keywords.indexOf(keyword) === -1;
-          });
-          if (keywordsToAdd.length > 0) {
-            packageJson.keywords = [...packageJson.keywords, ...keywordsToAdd];
-          }
-        } else {
-          packageJson.keywords = DEFAULT_KEYWORDS;
-        }
-
-        // Construct our new packageJson packageJson with sorted fields
-        const file = Object.keys(packageJson)
-          .sort(sortFields)
-          .reduce(
-            (acc, key) => ({
-              ...acc,
-              [key]: packageJson[key],
-            }),
-            {}
-          );
-
-        await fs.writeJson(packageJsonPath, file, { spaces: 2 });
-      }
-    )
-  );
-}
-
-export const name = 'package';

package/src/commands/sync/readme.js

@@ -1,62 +0,0 @@
-/**
- * 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.
- */
-
-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',
-  'carbon-components-react',
-  '@carbon/react',
-  '@carbon/styles',
-]);
-
-export default async function run({ root, packagePaths }) {
-  const remarkInstance = remark().use(monorepo, {
-    root: root.directory,
-  });
-  const prettierOptions = {
-    ...prettierConfig,
-    parser: 'markdown',
-  };
-
-  return Promise.all(
-    packagePaths
-      .filter((pkg) => !packageDenyList.has(pkg.packageJson.name))
-      .map(async ({ packagePath }) => {
-        const README_PATH = path.join(packagePath, 'README.md');
-        if (!(await fs.pathExists(README_PATH))) {
-          return;
-        }
-
-        const readme = await fs.readFile(README_PATH, 'utf8');
-        const file = await process(remarkInstance, packagePath, readme);
-        await fs.writeFile(
-          README_PATH,
-          prettier.format(String(file), prettierOptions)
-        );
-      })
-  );
-}
-
-function process(remarkInstance, cwd, contents) {
-  return new Promise((resolve, reject) => {
-    remarkInstance.process({ cwd, contents }, (error, file) => {
-      if (error) {
-        reject(error);
-        return;
-      }
-      resolve(file);
-    });
-  });
-}
-
-export const name = 'readme';

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

@@ -1,421 +0,0 @@
-/**
- * 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.
- */
-
-import fs from 'fs-extra';
-import path from 'path';
-
-export default function monorepo() {
-  async function transformer(tree, file) {
-    const { cwd } = file;
-    const localPackageJsonPath = path.join(cwd, 'package.json');
-    const localPackageJson = await fs.readJson(localPackageJsonPath);
-    const { name, description } = localPackageJson;
-
-    if (!name) {
-      return new Error(
-        `Expected a name to be defined for the package at: ${cwd}`
-      );
-    }
-    if (!description) {
-      return new Error(
-        `Expected a description to be defined for the package at: ${cwd}`
-      );
-    }
-
-    // Grab all sections under `## Usage` as these are custom for each project
-    const usage = [];
-    let usageHeadingFound = false;
-
-    for (const child of tree.children) {
-      if (usageHeadingFound) {
-        if (child.type === 'heading' && child.depth <= 2) {
-          break;
-        }
-        usage.push(child);
-      }
-
-      if (
-        child.type === 'heading' &&
-        child.depth === 2 &&
-        child.children[0].value === 'Usage'
-      ) {
-        usageHeadingFound = true;
-        usage.push(child);
-      }
-    }
-
-    // [x] Title
-    // [x] Getting Started
-    // [x] Usage
-    // [x] Examples
-    // [ ] Contributors
-    // [x] Contributing
-    // [x] License
-    // eslint-disable-next-line require-atomic-updates
-    tree.children = [
-      ...createTitle(localPackageJson.name, localPackageJson.description),
-      ...createGettingStarted(localPackageJson.name),
-      ...usage,
-      ...(await createAPIDoc(localPackageJson.name, path.join(cwd, 'docs'))),
-      ...(await createExamples(
-        localPackageJson.name,
-        path.join(cwd, 'examples')
-      )),
-      ...createContributing(),
-      ...createLicense(),
-    ];
-  }
-
-  return transformer;
-}
-
-function createTitle(name, description) {
-  return [
-    {
-      type: 'heading',
-      depth: 1,
-      children: [
-        {
-          type: 'text',
-          value: name,
-        },
-      ],
-    },
-    {
-      type: 'blockquote',
-      children: [
-        {
-          type: 'paragraph',
-          children: [
-            {
-              type: 'text',
-              value: description,
-            },
-          ],
-        },
-      ],
-    },
-  ];
-}
-
-function createGettingStarted(name) {
-  return [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [
-        {
-          type: 'text',
-          value: 'Getting started',
-        },
-      ],
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value: 'To install ',
-        },
-        {
-          type: 'inlineCode',
-          value: name,
-        },
-        {
-          type: 'text',
-          value:
-            ' in your project, you will need to run the following command using ',
-        },
-        {
-          type: 'link',
-          title: null,
-          url: 'https://www.npmjs.com/',
-          children: [
-            {
-              type: 'text',
-              value: 'npm',
-            },
-          ],
-        },
-        {
-          type: 'text',
-          value: ':',
-        },
-      ],
-    },
-    {
-      type: 'code',
-      lang: 'bash',
-      value: `npm install -S ${name}`,
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value: 'If you prefer ',
-        },
-        {
-          type: 'link',
-          title: null,
-          url: 'https://yarnpkg.com/en/',
-          children: [
-            {
-              type: 'text',
-              value: 'Yarn',
-            },
-          ],
-        },
-        {
-          type: 'text',
-          value: ', use the following command\ninstead:',
-        },
-      ],
-    },
-    {
-      type: 'code',
-      lang: 'bash',
-      meta: null,
-      value: `yarn add ${name}`,
-    },
-  ];
-}
-
-async function createAPIDoc(name, docsDir) {
-  // No docs to list
-  if (!(await fs.pathExists(docsDir))) {
-    return [];
-  }
-
-  const docs = (await fs.readdir(docsDir)).filter((name) => {
-    // Ignore dotfiles and json files
-    return !(name[0] === '.' || name === 'sass.json');
-  });
-
-  if (docs.length === 0) {
-    return [];
-  }
-
-  return [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [
-        {
-          type: 'text',
-          value: '📖 API Documentation',
-        },
-      ],
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value: "If you're looking for ",
-        },
-        {
-          type: 'inlineCode',
-          value: name,
-        },
-        {
-          type: 'text',
-          value: ' API documentation, check out:',
-        },
-      ],
-    },
-    {
-      type: 'list',
-      ordered: false,
-      spread: false,
-      children: docs.map((doc) => ({
-        type: 'listItem',
-        spread: false,
-        checked: null,
-        children: [
-          {
-            type: 'paragraph',
-            children: [
-              {
-                type: 'link',
-                title: null,
-                url: `./docs/${doc}`,
-                children: [
-                  {
-                    type: 'text',
-                    value: `${
-                      doc[0].toUpperCase() +
-                      doc.slice(1).replace(/\.[^/.]+$/, '')
-                    }`,
-                  },
-                ],
-              },
-            ],
-          },
-        ],
-      })),
-    },
-  ];
-}
-
-async function createExamples(name, examplesDir) {
-  // No examples to list
-  if (!(await fs.pathExists(examplesDir))) {
-    return [];
-  }
-
-  const examples = (await fs.readdir(examplesDir)).filter((name) => {
-    // Ignore dotfiles and special cases `codesandbox` and `storybook`
-    return !(
-      name[0] === '.' ||
-      name === 'codesandbox' ||
-      name === 'storybook' ||
-      name === 'preview'
-    );
-  });
-
-  if (examples.length === 0) {
-    return [];
-  }
-
-  return [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [
-        {
-          type: 'text',
-          value: '📚 Examples',
-        },
-      ],
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value: "If you're looking for more examples on how to use ",
-        },
-        {
-          type: 'inlineCode',
-          value: name,
-        },
-        {
-          type: 'text',
-          value: ', we have some examples that you can check out:',
-        },
-      ],
-    },
-    {
-      type: 'list',
-      ordered: false,
-      spread: false,
-      children: examples.map((example) => ({
-        type: 'listItem',
-        spread: false,
-        checked: null,
-        children: [
-          {
-            type: 'paragraph',
-            children: [
-              {
-                type: 'link',
-                title: null,
-                url: `./examples/${example}`,
-                children: [
-                  {
-                    type: 'text',
-                    value: example,
-                  },
-                ],
-              },
-            ],
-          },
-        ],
-      })),
-    },
-  ];
-}
-
-function createContributing() {
-  return [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [
-        {
-          type: 'text',
-          value: '🙌 Contributing',
-        },
-      ],
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value:
-            "We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our ",
-        },
-        {
-          type: 'link',
-          title: null,
-          url: '/.github/CONTRIBUTING.md',
-          children: [
-            {
-              type: 'text',
-              value: 'Contributing Guide',
-            },
-          ],
-        },
-        {
-          type: 'text',
-          value: '! 👀',
-        },
-      ],
-    },
-  ];
-}
-
-function createLicense() {
-  return [
-    {
-      type: 'heading',
-      depth: 2,
-      children: [
-        {
-          type: 'text',
-          value: '📝 License',
-        },
-      ],
-    },
-    {
-      type: 'paragraph',
-      children: [
-        {
-          type: 'text',
-          value: 'Licensed under the ',
-        },
-        {
-          type: 'link',
-          title: null,
-          url: '/LICENSE',
-          children: [
-            {
-              type: 'text',
-              value: 'Apache 2.0 License',
-            },
-          ],
-        },
-        {
-          type: 'text',
-          value: '.',
-        },
-      ],
-    },
-  ];
-}

package/src/commands/sync.js

@@ -1,39 +0,0 @@
-/**
- * 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.
- */
-
-import { workspace } from '../workspace.js';
-import npmTask from './sync/npm.js';
-import packageTask from './sync/package.js';
-import readmeTask from './sync/readme.js';
-
-const tasks = {
-  npm: npmTask,
-  package: packageTask,
-  readme: readmeTask,
-};
-
-async function sync(args, env) {
-  const { target } = args;
-  const tasksToRun = target === 'all' ? Object.keys(tasks) : [target];
-
-  for (const name of tasksToRun) {
-    const task = tasks[name];
-    await task(env);
-  }
-}
-
-export function builder(yargs) {
-  yargs.positional('target', {
-    describe: 'choose a target to sync',
-    choices: ['all', 'npm', 'package', 'readme'],
-    default: 'all',
-  });
-}
-
-export const command = 'sync [target]';
-export const desc = 'sync files across workspaces';
-export const handler = workspace(sync);