@carbon/cli 10.29.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2015 IBM Corp.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,57 @@
+# @carbon/cli
+
+> Task automation for working with the Carbon Design System
+
+## Getting started
+
+To install `@carbon/cli` in your project, you will need to run the following
+command using [npm](https://www.npmjs.com/):
+
+```bash
+npm install -S @carbon/cli
+```
+
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
+instead:
+
+```bash
+yarn add @carbon/cli
+```
+
+## Usage
+
+You can install `@carbon/cli` in your project, or use a tool like
+[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
+by running the following command in your project:
+
+```bash
+npx @carbon/cli --help
+```
+
+The output of the `--help` option is:
+
+```bash
+Usage: @carbon/cli [options]
+
+Commands:
+  cli ci-check              run CI checks
+  cli contribute <command>  get started contributing with Carbon
+  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]
+  --version  Show version number                                       [boolean]
+```
+
+## 🙌 Contributing
+
+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 [Contributing Guide](/.github/CONTRIBUTING.md)! 👀
+
+## 📝 License
+
+Licensed under the [Apache 2.0 License](/LICENSE).

package/bin/carbon-cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+/**
+ * Copyright IBM Corp. 2019, 2019
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/* eslint-disable no-console */
+
+'use strict';
+
+// Inspired by Create React App
+// https://github.com/facebook/create-react-app/blob/next/packages/create-react-app/index.js
+
+// Makes the script crash on unhandled rejections instead of silently
+// ignoring them. In the future, promise rejections that are not handled will
+// terminate the Node.js process with a non-zero exit code.
+process.on('unhandledRejection', (error) => {
+  console.error(error);
+});
+
+var chalk = require('chalk');
+
+var currentNodeVersion = process.versions.node;
+var semver = currentNodeVersion.split('.');
+var major = semver[0];
+
+if (major < 8) {
+  console.error(
+    chalk.red(
+      `You are running Node ${currentNodeVersion}.\n` +
+        `carbon-upgrade requires Node 8 or higher, please update your ` +
+        `version of Node.`
+    )
+  );
+  process.exit(1);
+}
+
+var main = require('../src/cli');
+
+main(process).catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3'
+
+services:
+  verdaccio:
+    image: verdaccio/verdaccio:4
+    ports:
+      - "4873:4873"
+    volumes:
+      - verdaccio:/verdaccio
+
+volumes:
+  verdaccio:
+    driver: local

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@carbon/cli",
+  "description": "Task automation for working with the Carbon Design System",
+  "version": "10.29.0",
+  "license": "Apache-2.0",
+  "bin": {
+    "carbon-cli": "./bin/carbon-cli.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/carbon-design-system/carbon.git",
+    "directory": "packages/cli"
+  },
+  "bugs": "https://github.com/carbon-design-system/carbon/issues",
+  "keywords": [
+    "ibm",
+    "carbon",
+    "carbon-design-system",
+    "components",
+    "react"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@babel/core": "^7.14.6",
+    "@carbon/cli-reporter": "^10.5.0",
+    "@octokit/plugin-retry": "^3.0.7",
+    "@octokit/plugin-throttling": "^2.6.0",
+    "@octokit/rest": "^16.28.1",
+    "@rollup/plugin-babel": "^5.3.0",
+    "@rollup/plugin-commonjs": "^18.0.0",
+    "@rollup/plugin-node-resolve": "^11.2.1",
+    "chalk": "^4.1.1",
+    "change-case": "^4.1.2",
+    "child-process-promise": "^2.2.1",
+    "clipboardy": "^2.1.0",
+    "enquirer": "^2.3.6",
+    "fast-glob": "^3.2.7",
+    "fs-extra": "^8.0.1",
+    "inquirer": "^6.4.1",
+    "klaw-sync": "^6.0.0",
+    "lodash.template": "^4.5.0",
+    "markdown-toc": "^1.2.0",
+    "prettier": "^2.2.1",
+    "prettier-config-carbon": "^0.6.0",
+    "progress-estimator": "^0.2.2",
+    "remark": "^10.0.1",
+    "replace-in-file": "^6.1.0",
+    "rollup": "^2.46.0",
+    "sass": "^1.41.0",
+    "sassdoc": "^2.7.3",
+    "yargs": "^17.0.1"
+  },
+  "gitHead": "3dd237d343adc0b378d12e933bd99b8beca7b250"
+}

package/src/changelog.js

@@ -0,0 +1,217 @@
+/**
+ * Copyright IBM Corp. 2019, 2019
+ *
+ * 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 { default: parse } = require('@commitlint/parse');
+const execa = require('execa');
+
+// We keep a list of commits that are process-oriented that we never want to
+// show up in generated changelogs
+const headerDenyList = new Set([
+  'chore(project): sync generated files [skip ci]',
+  'chore(release): update package versions',
+]);
+
+/**
+ * @typedef PackageInfo
+ * @property {string} name
+ * @property {string} version
+ * @property {boolean} private
+ * @property {string} location
+ */
+
+/**
+ * Generate the contents of a CHANGELOG for a given list of packages between two
+ * tagged git objects. For example, if updating from v1.0.0 to v1.1.0, this
+ * method would generate a changelog for all commits in the range
+ * v1.0.0...v1.1.0 and group them based on the given packages.
+ *
+ * @param {Array<PackageInfo>} packages
+ * @param {string} lastTag
+ * @param {string} latestTag
+ * @returns {string}
+ */
+async function generate(packages, lastTag, latestTag) {
+  const packageCommitsInRange = await Promise.all(
+    packages.map((pkg) => getCommitsInRange(pkg, `${lastTag}...${latestTag}`))
+  );
+  const packageCommitsToInclude = packageCommitsInRange.filter(
+    ({ commits }) => {
+      return commits.length > 0;
+    }
+  );
+
+  return [
+    getMarkdownTitle(lastTag, latestTag),
+    ...getMarkdownSections(packageCommitsToInclude),
+  ].join('\n');
+}
+
+const sectionTypes = [
+  {
+    title: 'New features :rocket:',
+    types: ['feat'],
+  },
+  {
+    title: 'Bug fixes :bug:',
+    types: ['fix'],
+  },
+  {
+    title: 'Documentation :memo:',
+    types: ['docs'],
+  },
+  {
+    title: 'Housekeeping :house:',
+    types: ['build', 'ci', 'chore', 'perf', 'refactor', 'revert', 'test'],
+  },
+];
+
+const commitUrl = 'https://github.com/carbon-design-system/carbon/commit';
+
+/**
+ * Get the sections to be rendered in our changelog for the given packages and
+ * their associated commits. Our plan is to group the commits for each package
+ * under various section types and build up the lists accordingly.
+ *
+ * @param {Array} packages
+ * @returns {Array}
+ */
+function getMarkdownSections(packages) {
+  return packages.map(({ name, version, commits }) => {
+    let section = `## \`${name}@${version}\`\n`;
+
+    for (const { title, types } of sectionTypes) {
+      const commitsForSection = commits.filter((commit) => {
+        return types.includes(commit.info.type);
+      });
+
+      if (commitsForSection.length === 0) {
+        continue;
+      }
+
+      let subsection = `### ${title}\n`;
+
+      for (const commit of commitsForSection) {
+        const { hash, info } = commit;
+        const url = `${commitUrl}/${hash}`;
+        subsection += `- ${info.header} ([\`${hash}\`](${url}))\n`;
+      }
+
+      section += '\n' + subsection;
+    }
+
+    return section;
+  });
+}
+
+const compareUrl = 'https://github.com/carbon-design-system/carbon/compare';
+
+/**
+ * Get the markdown title for the given lastTag and latestTag. This title is
+ * used at the top of a given GitHub release.
+ *
+ * @param {string} lastTag
+ * @param {string} latestTag
+ * @returns {string}
+ */
+function getMarkdownTitle(lastTag, latestTag) {
+  const now = new Date();
+  const year = now.getFullYear();
+  const day = now.getDate();
+  const month = now.getMonth() + 1;
+  const url = `${compareUrl}/${lastTag}...${latestTag}`;
+
+  return `# [${latestTag}](${url}) (${year}-${month}-${day})`;
+}
+
+/**
+ * Retrieves the commits from the given range for the particular package.
+ * Specifically, we're going to find commits that are in the package folder so
+ * that we can group them later on when generating the changelog.
+ *
+ * @param {PackageInfo} pkg
+ * @param {string} range
+ * @returns {Array}
+ */
+async function getCommitsInRange(pkg, range) {
+  // Using the `rev-list` sub-command of `git` we can list out all of the commits
+  // for the given range inside of the package's location. This will allow us to
+  // find all the commits associated with this package that we'll display in the
+  // changelog
+  const { stdout } = await execa('git', [
+    'rev-list',
+    range,
+    '--oneline',
+    '--',
+    pkg.location,
+  ]);
+
+  // If the git sub-command returns nothing, then no commits have occurred for
+  // this package in the given commit range
+  if (stdout === '') {
+    return {
+      ...pkg,
+      commits: [],
+    };
+  }
+
+  const commitsInFolder = await Promise.all(
+    stdout.split('\n').map(async (commit) => {
+      // The output from `git rev-list` follows the pattern: `HASH <header>`, so
+      // we will need to trim the string to get the appropriate hash and text
+      // values for `parse` to consume.
+      const hash = commit.slice(0, 9);
+      const text = commit.slice(10);
+      // Just in case, we'll trim the header value as sometimes the commit gets
+      // an extra space that's unnecessary
+      const info = await parse(text.trim());
+
+      return {
+        info,
+        hash,
+        text,
+      };
+    })
+  );
+
+  const headers = new Set();
+  // There are certain conditions where we don't want a commit visible in the
+  // CHANGELOG, namely when we cannot parse the commit info type or when the
+  // commit header is in our deny list
+  const commits = commitsInFolder
+    .filter((commit) => {
+      if (commit.info.type === null) {
+        return false;
+      }
+
+      if (headerDenyList.has(commit.info.header)) {
+        return false;
+      }
+
+      return true;
+    })
+    .filter((commit) => {
+      // Running into an issue with duplicate headers when viewing "committed by"
+      // and "committed and authored by", as a result we'll keep a set of all
+      // headers and exclude the commit if we've seen it already
+      if (headers.has(commit.info.header)) {
+        return false;
+      }
+      headers.add(commit.info.header);
+      return true;
+    });
+
+  return {
+    ...pkg,
+    commits,
+  };
+}
+
+module.exports = {
+  generate,
+};

package/src/cli.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright IBM Corp. 2019, 2019
+ *
+ * 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 cli = require('yargs');
+const packageJson = require('../package.json');
+
+async function main({ argv }) {
+  cli
+    .scriptName(packageJson.name)
+    .version(packageJson.version)
+    .usage('Usage: $0 [options]');
+
+  cli
+    .commandDir('commands')
+    .strict()
+    .fail((message, error, yargs) => {
+      if (error) {
+        if (error.stderr) {
+          console.error(error.stderr);
+          process.exit(1);
+        }
+        console.error(error);
+        process.exit(1);
+        return;
+      }
+      console.log(message);
+      console.log(yargs.help());
+      process.exit(1);
+    })
+    .parse(argv.slice(2)).argv;
+}
+
+module.exports = main;

package/src/commands/bundle/bundlers.js

@@ -0,0 +1,14 @@
+/**
+ * Copyright IBM Corp. 2018, 2018
+ *
+ * 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 javascript = require('./javascript');
+
+const bundlers = new Map([['.js', javascript]]);
+
+module.exports = bundlers;