refactor(icons-react): add TypeScript types to icons-react package (#…

…14714)

* refactor(icons-react): add TypeScript types to icons-react package

* fix(FileUploader.Filename): restore tabIndex on complete icon

* fix(icon-helpers): restore icon-helpers exports

* refactor(typescript): extract common TypeScript config

* fix(typescript): single source of truth for TS version

---------

Co-authored-by: TJ Egan <[email protected]>

config/typescript-config-carbon/.gitignore

@@ -0,0 +1,2 @@
+/index.js
+/index.d.ts

config/typescript-config-carbon/README.md

@@ -0,0 +1,29 @@
+# typescript-config-carbon
+
+> TypeScript configuration and utilities for Carbon
+
+## Getting started
+
+To install `typescript-config-carbon` in your project, you will need to run the
+following command using [npm](https://www.npmjs.com/):
+
+```bash
+npm install -S typescript-config-carbon
+```
+
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
+instead:
+
+```bash
+yarn add typescript-config-carbon
+```
+
+## 🙌 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).

config/typescript-config-carbon/index.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright IBM Corp. 2023
+ *
+ * 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 path from 'path';
+import ts from 'typescript';
+
+const tsConfigFile = path.join(__dirname, 'tsconfig.base.json');
+
+export const diagnosticToMessage = (diagnostic: ts.Diagnostic) => {
+  const { file, messageText } = diagnostic;
+  const filePrefix = file ? `${file.fileName}: ` : '';
+  const text = ts.flattenDiagnosticMessageText(messageText, '\n');
+  return `${filePrefix}${text}`;
+};
+
+export const loadTsCompilerOpts = (path: string) => {
+  const { config, error } = ts.readConfigFile(path, ts.sys.readFile);
+  if (error) {
+    throw new Error(diagnosticToMessage(error));
+  }
+  const opts = ts.convertCompilerOptionsFromJson(config.compilerOptions, '');
+  const { errors } = opts;
+  if (errors.length > 0) {
+    errors.forEach((diagnostic) => {
+      console.log(diagnosticToMessage(diagnostic));
+    });
+    throw new Error('Base TypeScript config file errors found');
+  }
+  return opts.options;
+};
+
+export const loadBaseTsCompilerOpts = () => {
+  return loadTsCompilerOpts(tsConfigFile);
+};

config/typescript-config-carbon/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "typescript-config-carbon",
+  "description": "TypeScript configuration for Carbon",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/carbon-design-system/carbon.git",
+    "directory": "config/typescript-config-carbon"
+  },
+  "bugs": "https://github.com/carbon-design-system/carbon/issues",
+  "keywords": [
+    "carbon",
+    "carbon-design-system",
+    "components",
+    "react",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "clean": "rimraf index.js index.d.ts",
+    "build": "yarn clean && tsc"
+  },
+  "dependencies": {
+    "typescript": "^4.8.4"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.0"
+  }
+}

config/typescript-config-carbon/tsconfig.base.json

@@ -0,0 +1,106 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es6",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": ["dom", "dom.iterable", "esnext"],            /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "jsx": "react-jsx",                                  /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "esnext",                                  /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node",                          /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    "resolveJsonModule": true,                           /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    "emitDeclarationOnly": true,                         /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    "isolatedModules": true,                             /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /*
+     * Type Checking
+     * Note: some checks are set to false since linting takes care of them
+     */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": false,                             /* Enable error reporting when local variables aren't read. */
+    "noUnusedParameters": false,                         /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    "noFallthroughCasesInSwitch": false,                 /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

config/typescript-config-carbon/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "emitDeclarationOnly": false,
+    "module": "commonjs"
+  },
+  "include": ["index.ts"]
+}

packages/cli/package.json

@@ -51,6 +51,7 @@
     "rollup": "^2.79.1",
     "sass": "^1.51.0",
     "sassdoc": "^2.7.3",
+    "typescript-config-carbon": "^0.1.0",
     "yargs": "^17.0.1"
   }
 }

packages/cli/src/commands/bundle/bundlers.js

@@ -8,7 +8,11 @@
 'use strict';
 
 const javascript = require('./javascript');
+const typescript = require('./typescript');
 
-const bundlers = new Map([['.js', javascript]]);
+const bundlers = new Map([
+  ['.js', javascript],
+  ['.ts', typescript],
+]);
 
 module.exports = bundlers;

packages/cli/src/commands/bundle/javascript.js

@@ -10,10 +10,14 @@
 const { babel } = require('@rollup/plugin-babel');
 const commonjs = require('@rollup/plugin-commonjs');
 const { nodeResolve } = require('@rollup/plugin-node-resolve');
-const { pascalCase } = require('change-case');
 const fs = require('fs-extra');
 const path = require('path');
 const { rollup } = require('rollup');
+const {
+  formatGlobals,
+  findPackageFolder,
+  formatDependenciesIntoGlobals,
+} = require('./utils');
 
 async function bundle(entrypoint, options) {
   const globals = options.globals ? formatGlobals(options.globals) : {};
@@ -95,48 +99,4 @@ async function bundle(entrypoint, options) {
   );
 }
 
-function formatGlobals(string) {
-  const mappings = string.split(',').map((mapping) => {
-    return mapping.split('=');
-  });
-  return mappings.reduce(
-    (acc, [pkg, global]) => ({
-      ...acc,
-      [pkg]: global,
-    }),
-    {}
-  );
-}
-
-function formatDependenciesIntoGlobals(dependencies) {
-  return Object.keys(dependencies).reduce((acc, key) => {
-    const parts = key.split('/').map((identifier, i) => {
-      if (i === 0) {
-        return identifier.replace(/@/, '');
-      }
-      return identifier;
-    });
-
-    return {
-      ...acc,
-      [key]: pascalCase(parts.join(' ')),
-    };
-  }, {});
-}
-
-async function findPackageFolder(entrypoint) {
-  let packageFolder = entrypoint;
-
-  while (packageFolder !== '/' && path.dirname(packageFolder) !== '/') {
-    packageFolder = path.dirname(packageFolder);
-    const packageJsonPath = path.join(packageFolder, 'package.json');
-
-    if (await fs.pathExists(packageJsonPath)) {
-      break;
-    }
-  }
-
-  return packageFolder;
-}
-
 module.exports = bundle;