@itwin/build-tools 3.0.0-dev.81 → 3.0.0-dev.85

package/README.md

@@ -1,59 +1,59 @@
-# @itwin/build-tools
-
-Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
-
-## Description
-
-The **@itwin/build-tools** is a package for developers to consolidate the steps for building TypeScript-based packages. The tools contained in this package are written in either Typescript or Javascript within the src/ directory, and compiled for use into the lib/ directory. As a developer package, this package has only dependencies, no devDependencies.
-
-### tsconfig-base
-
-Location: tsconfig-base.json\
-Requires build: no
-
-This file contains common tsconfig settings across all iTwin.js packages. Packages should extend this file in their own tsconfig.json file, and then overwrite and set new properties as needed. Note that this file is different from the tsconfig.json file for this package, as that contains different settings for bentleyjs-tools only.
-
-### NPM Scripts
-
-Location: scripts/\
-Requires build: no
-
-The following node scripts are delivered in this package's scripts folder in order to ease development of iTwin.js packages with npm scripts. These scripts may require that additional packages be installed as dependencies of your package.
-
-The default behaviors of the scripts (without parameters) assume that the directory structure of your package mirrors the following:
-
-- root
-  - source
-    - test
-      - assets
-  - lib
-  - package.json
-  - tsconfig.json
-
-The following is a list of some of the most commonly used scripts within this package:
-
-#### docs.js
-
-This script runs a TypeDoc command, with specific parameters, to generate html TypeScript documentation as well as a json representation of the documentation to be consumed for other purposes. It includes the following parameters:
-
-- source - specify the TypeScript source directory
-- out - specify the directory of the html output
-- json - specify the directory and filename of the json output
-- baseUrl - specify a baseUrl to resolve modules
-- onlyJson - including this option will skip the html output and only output the json file
-- includes - directory of files to include in documentation (ex: for sample code)
-- excludes - name of directory, files, or file extensions to exclude.
-  - A list can be provided using a `,` as a separator
-  - Each of the provided to exclude is added to a glob pattern which checks all directories within the source.
-    - i.e `--excludes=test,docs/*.md` will translate to `**/{test,docs/*.md}/**/*`
-
-#### extract.js
-
-This is a script designed to extract sample code from test.ts files in a specific directory. The sample code should be surrounded by comments containing "\_\_PUBLISH_EXTRACT_START\_\_" and "\_\_PUBLISH_EXTRACT_END\_\_" directives.
-
-- extractDir - the path at which the sample code files are located
-- outDir - the path at which to output the selected code
-
-#### pseudolocalize.js
-
-This script handles translating an English localization JSON file into a pseudoLocalization file.
+# @itwin/build-tools
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+## Description
+
+The **@itwin/build-tools** is a package for developers to consolidate the steps for building TypeScript-based packages. The tools contained in this package are written in either Typescript or Javascript within the src/ directory, and compiled for use into the lib/ directory. As a developer package, this package has only dependencies, no devDependencies.
+
+### tsconfig-base
+
+Location: tsconfig-base.json\
+Requires build: no
+
+This file contains common tsconfig settings across all iTwin.js packages. Packages should extend this file in their own tsconfig.json file, and then overwrite and set new properties as needed. Note that this file is different from the tsconfig.json file for this package, as that contains different settings for bentleyjs-tools only.
+
+### NPM Scripts
+
+Location: scripts/\
+Requires build: no
+
+The following node scripts are delivered in this package's scripts folder in order to ease development of iTwin.js packages with npm scripts. These scripts may require that additional packages be installed as dependencies of your package.
+
+The default behaviors of the scripts (without parameters) assume that the directory structure of your package mirrors the following:
+
+- root
+  - source
+    - test
+      - assets
+  - lib
+  - package.json
+  - tsconfig.json
+
+The following is a list of some of the most commonly used scripts within this package:
+
+#### docs.js
+
+This script runs a TypeDoc command, with specific parameters, to generate html TypeScript documentation as well as a json representation of the documentation to be consumed for other purposes. It includes the following parameters:
+
+- source - specify the TypeScript source directory
+- out - specify the directory of the html output
+- json - specify the directory and filename of the json output
+- baseUrl - specify a baseUrl to resolve modules
+- onlyJson - including this option will skip the html output and only output the json file
+- includes - directory of files to include in documentation (ex: for sample code)
+- excludes - name of directory, files, or file extensions to exclude.
+  - A list can be provided using a `,` as a separator
+  - Each of the provided to exclude is added to a glob pattern which checks all directories within the source.
+    - i.e `--excludes=test,docs/*.md` will translate to `**/{test,docs/*.md}/**/*`
+
+#### extract.js
+
+This is a script designed to extract sample code from test.ts files in a specific directory. The sample code should be surrounded by comments containing "\_\_PUBLISH_EXTRACT_START\_\_" and "\_\_PUBLISH_EXTRACT_END\_\_" directives.
+
+- extractDir - the path at which the sample code files are located
+- outDir - the path at which to output the selected code
+
+#### pseudolocalize.js
+
+This script handles translating an English localization JSON file into a pseudoLocalization file.

package/bin/betools.js

@@ -1,148 +1,148 @@
-#! /usr/bin/env node
-
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-"use strict"
-const yargs = require("yargs");
-var path = require("path");
-var child_process = require("child_process");
-
-yargs.strict(true)
-  .wrap(Math.min(150, yargs.terminalWidth()))
-  .version("2.0.0")
-  .usage("Bentley Scripts Utility\n\n These scripts consist of several standard npm tasks an app may want to make use of.")
-  .command("test", false, {}, () => { testCommand() })
-  .command("test-tsnode", false, {}, () => { testCommand() })
-  .command("docs", "Generate TypeDoc documentation by using the provided parameters to pass to TypeDoc.  Supports generating html TypeScript documentation as well as a json representation of the documentation.",
-    function (yargs) {
-      return yargs.options({
-        "source": {
-          describe: "Specify the TypeScript source directory"
-        },
-        "out": {
-          describe: "Specify the directory of the html output"
-        },
-        "json": {
-          describe: "Specify the directory and filename of the json output"
-        },
-        "baseUrl": {
-          describe: "Specify a baseUrl to resolve modules"
-        },
-        "includes": {
-          describe: "Specify a baseUrl to resolve modules"
-        },
-        "excludes": {
-          describe: "Specify a directory, filename, or pattern to be excluded"
-        },
-        "excludeGlob": {
-          describe: "Specify a directory, filename, or pattern to be excluded"
-        },
-        "tsIndexFile": {
-          describe: "The barrel file containing the module documentation. This file is copied to the output folder for parsing."
-        },
-        "onlyJson": {
-          describe: "Specify a baseUrl to resolve modules"
-        }
-      })
-    },
-    (argv) => { docsCommand(argv) })
-  .command("extract", "Extract sample code from test files in a specific directory",
-    function (yargs) {
-      return yargs.options({
-        "extractFrom": {
-          describe: "The path at which the sample code files are located"
-        },
-        "out": {
-          describe: "The path at which to output the selected code"
-        },
-        "fileExt": {
-          describe: "The extension of the files to include"
-        },
-        "recursive": {
-          alias: "r",
-          describe: "Recursively search subdirectories from"
-        }
-      })
-    },
-    (argv) => { extractCommand(argv) })
-  .command("extract-api", "Extracts the API of the Typescript library starting from an entry file with a default presets.  Powered by @microsoft/api-extractor (https://api-extractor.com)",
-    function (yargs) {
-      return yargs.options({
-        "entry": {
-          describe: "The main Typescript entry point for the library which is compiled to the 'main' field in the package.json"
-        },
-        "ignoreMissingTags": {
-          describe: "Turns off the 'ae-missing-release-tag' option which returns an error when a missing release tag is detected"
-        }
-      })
-    },
-    (argv) => { extractApiCommand(argv) })
-  .command("pseudolocalize", "Pseudo-localizes an english localization JSON file.",
-    function (yargs) {
-      return yargs.options({
-        "englishDir": {
-          describe: "The path to the English localization folder.  Default is `./public/locales/en`"
-        },
-        "out": {
-          describe: "The output path to put the pseudo-localized files.  Default is `./public/locales/en-pseudo`"
-        }
-      })
-    },
-    (argv) => { pseudolocalizeCommand(argv) })
-  .help()
-  .argv;
-
-function testCommand(options) {
-  console.error("ERROR: The test and test-tsnode commands have been removed from betools.  Please use mocha directly instead.");
-  process.exit(1);
-}
-
-function docsCommand(options) {
-  const sourceOpt = options.source ? ["--source", options.source] : [];
-  const outOpt = options.out ? ["--out", options.out] : [];
-  const jsonOpt = options.json ? ["--json", options.json] : [];
-  const baseUrlOpt = options.baseUrl ? ["--baseUrl", options.baseUrl] : [];
-  const includesOpt = options.includes ? ["--includes", options.includes] : [];
-  const excludesOpt = options.excludes ? ["--excludes", options.excludes] : [];
-  const excludesGlobOpt = options.excludes ? ["--excludeGlob", options.excludeGlob] : [];
-  const indexFileOpt = options.tsIndexFile ? ["--tsIndexFile", options.tsIndexFile] : [];
-  const onlyJsonOpt = options.onlyJson ? ["--onlyJson"] : [];
-  exec(["node", path.resolve(__dirname, "../scripts/docs.js"),
-    ...sourceOpt, ...outOpt, ...jsonOpt, ...baseUrlOpt, ...includesOpt,
-    ...excludesOpt, ...excludesGlobOpt, ...indexFileOpt, ...onlyJsonOpt]);
-}
-
-function extractCommand(options) {
-  const extractOpt = options.extractFrom ? ["--extractFrom", options.extractFrom] : [];
-  const outOpt = options.out ? ["--out", options.out] : [];
-  const fileExt = options.fileExt ? ["--fileExt", options.fileExt] : [];
-  const recursive = options.recursive ? ["--recursive"] : [];
-  exec(["node", path.resolve(__dirname, "../scripts/extract.js"), ...extractOpt, ...outOpt, ...fileExt, ...recursive]);
-}
-
-function extractApiCommand(options) {
-  const entryOpt = options.entry ? ["--entry", options.entry] : [];
-  const ignoreTagsOpt = options.ignoreMissingTags ? ["--ignoreMissingTags"] : [];
-  exec(["node", path.resolve(__dirname, "../scripts/extract-api.js"), ...entryOpt, ...ignoreTagsOpt]);
-}
-
-function pseudolocalizeCommand(options) {
-  const englishDir = options.englishDir ? ["--englishDir", options.englishDir] : [];
-  const outOpt = options.out ? ["--out", options.out] : [];
-  exec(["node", path.resolve(__dirname, "../scripts/pseudolocalize"), ...englishDir, ...outOpt]);
-}
-
-function exec(cmd) {
-  console.log("Running command:");
-  console.log(cmd.join(" "));
-  try {
-    return child_process.execSync(cmd.join(" "), { encoding: "utf8", stdio: 'inherit' });
-  } catch (error) {
-    if (error.status)
-      process.exit(error.status);
-    throw error;
-  }
-}
+#! /usr/bin/env node
+
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+"use strict"
+const yargs = require("yargs");
+var path = require("path");
+var child_process = require("child_process");
+
+yargs.strict(true)
+  .wrap(Math.min(150, yargs.terminalWidth()))
+  .version("2.0.0")
+  .usage("Bentley Scripts Utility\n\n These scripts consist of several standard npm tasks an app may want to make use of.")
+  .command("test", false, {}, () => { testCommand() })
+  .command("test-tsnode", false, {}, () => { testCommand() })
+  .command("docs", "Generate TypeDoc documentation by using the provided parameters to pass to TypeDoc.  Supports generating html TypeScript documentation as well as a json representation of the documentation.",
+    function (yargs) {
+      return yargs.options({
+        "source": {
+          describe: "Specify the TypeScript source directory"
+        },
+        "out": {
+          describe: "Specify the directory of the html output"
+        },
+        "json": {
+          describe: "Specify the directory and filename of the json output"
+        },
+        "baseUrl": {
+          describe: "Specify a baseUrl to resolve modules"
+        },
+        "includes": {
+          describe: "Specify a baseUrl to resolve modules"
+        },
+        "excludes": {
+          describe: "Specify a directory, filename, or pattern to be excluded"
+        },
+        "excludeGlob": {
+          describe: "Specify a directory, filename, or pattern to be excluded"
+        },
+        "tsIndexFile": {
+          describe: "The barrel file containing the module documentation. This file is copied to the output folder for parsing."
+        },
+        "onlyJson": {
+          describe: "Specify a baseUrl to resolve modules"
+        }
+      })
+    },
+    (argv) => { docsCommand(argv) })
+  .command("extract", "Extract sample code from test files in a specific directory",
+    function (yargs) {
+      return yargs.options({
+        "extractFrom": {
+          describe: "The path at which the sample code files are located"
+        },
+        "out": {
+          describe: "The path at which to output the selected code"
+        },
+        "fileExt": {
+          describe: "The extension of the files to include"
+        },
+        "recursive": {
+          alias: "r",
+          describe: "Recursively search subdirectories from"
+        }
+      })
+    },
+    (argv) => { extractCommand(argv) })
+  .command("extract-api", "Extracts the API of the Typescript library starting from an entry file with a default presets.  Powered by @microsoft/api-extractor (https://api-extractor.com)",
+    function (yargs) {
+      return yargs.options({
+        "entry": {
+          describe: "The main Typescript entry point for the library which is compiled to the 'main' field in the package.json"
+        },
+        "ignoreMissingTags": {
+          describe: "Turns off the 'ae-missing-release-tag' option which returns an error when a missing release tag is detected"
+        }
+      })
+    },
+    (argv) => { extractApiCommand(argv) })
+  .command("pseudolocalize", "Pseudo-localizes an english localization JSON file.",
+    function (yargs) {
+      return yargs.options({
+        "englishDir": {
+          describe: "The path to the English localization folder.  Default is `./public/locales/en`"
+        },
+        "out": {
+          describe: "The output path to put the pseudo-localized files.  Default is `./public/locales/en-pseudo`"
+        }
+      })
+    },
+    (argv) => { pseudolocalizeCommand(argv) })
+  .help()
+  .argv;
+
+function testCommand(options) {
+  console.error("ERROR: The test and test-tsnode commands have been removed from betools.  Please use mocha directly instead.");
+  process.exit(1);
+}
+
+function docsCommand(options) {
+  const sourceOpt = options.source ? ["--source", options.source] : [];
+  const outOpt = options.out ? ["--out", options.out] : [];
+  const jsonOpt = options.json ? ["--json", options.json] : [];
+  const baseUrlOpt = options.baseUrl ? ["--baseUrl", options.baseUrl] : [];
+  const includesOpt = options.includes ? ["--includes", options.includes] : [];
+  const excludesOpt = options.excludes ? ["--excludes", options.excludes] : [];
+  const excludesGlobOpt = options.excludes ? ["--excludeGlob", options.excludeGlob] : [];
+  const indexFileOpt = options.tsIndexFile ? ["--tsIndexFile", options.tsIndexFile] : [];
+  const onlyJsonOpt = options.onlyJson ? ["--onlyJson"] : [];
+  exec(["node", path.resolve(__dirname, "../scripts/docs.js"),
+    ...sourceOpt, ...outOpt, ...jsonOpt, ...baseUrlOpt, ...includesOpt,
+    ...excludesOpt, ...excludesGlobOpt, ...indexFileOpt, ...onlyJsonOpt]);
+}
+
+function extractCommand(options) {
+  const extractOpt = options.extractFrom ? ["--extractFrom", options.extractFrom] : [];
+  const outOpt = options.out ? ["--out", options.out] : [];
+  const fileExt = options.fileExt ? ["--fileExt", options.fileExt] : [];
+  const recursive = options.recursive ? ["--recursive"] : [];
+  exec(["node", path.resolve(__dirname, "../scripts/extract.js"), ...extractOpt, ...outOpt, ...fileExt, ...recursive]);
+}
+
+function extractApiCommand(options) {
+  const entryOpt = options.entry ? ["--entry", options.entry] : [];
+  const ignoreTagsOpt = options.ignoreMissingTags ? ["--ignoreMissingTags"] : [];
+  exec(["node", path.resolve(__dirname, "../scripts/extract-api.js"), ...entryOpt, ...ignoreTagsOpt]);
+}
+
+function pseudolocalizeCommand(options) {
+  const englishDir = options.englishDir ? ["--englishDir", options.englishDir] : [];
+  const outOpt = options.out ? ["--out", options.out] : [];
+  exec(["node", path.resolve(__dirname, "../scripts/pseudolocalize"), ...englishDir, ...outOpt]);
+}
+
+function exec(cmd) {
+  console.log("Running command:");
+  console.log(cmd.join(" "));
+  try {
+    return child_process.execSync(cmd.join(" "), { encoding: "utf8", stdio: 'inherit' });
+  } catch (error) {
+    if (error.status)
+      process.exit(error.status);
+    throw error;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "3.0.0-dev.81",
+  "version": "3.0.0-dev.85",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -39,7 +39,7 @@
     "yargs": "^16.0.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "3.0.0-dev.81",
+    "@itwin/eslint-plugin": "3.0.0-dev.85",
     "@types/node": "14.14.31",
     "eslint": "^7.11.0"
   },

package/scripts/config/paths.js

@@ -1,27 +1,27 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-'use strict';
-
-const path = require('path');
-const fs = require('fs-extra');
-
-// Make sure any symlinks in the project folder are resolved:
-const appDirectory = fs.realpathSync(process.cwd());
-const resolveApp = relativePath => path.resolve(appDirectory, relativePath);
-
-module.exports = {
-  appSrc: resolveApp('src'),
-  appTest: resolveApp('src/test'),
-  appLib: resolveApp('lib'),
-  appLibPublic: resolveApp('lib/cjs/public'),
-  appLibTests: resolveApp('lib/cjs/test'),
-  appPublic: resolveApp('public'),
-  appDocs: resolveApp('lib/cjs/docs'),
-  appJsonDocs: resolveApp('lib/cjs/docs/json/file.json'),
-  appJUnitTestResults: resolveApp('lib/test/junit_results.xml'),
-  libExtract: resolveApp('lib/cjs/extract'),
-  appLocalesEnglish: resolveApp('public/locales/en'),
-  appLocalesPseudolocalize: resolveApp('public/locales/en-pseudo'),
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+'use strict';
+
+const path = require('path');
+const fs = require('fs-extra');
+
+// Make sure any symlinks in the project folder are resolved:
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = relativePath => path.resolve(appDirectory, relativePath);
+
+module.exports = {
+  appSrc: resolveApp('src'),
+  appTest: resolveApp('src/test'),
+  appLib: resolveApp('lib'),
+  appLibPublic: resolveApp('lib/cjs/public'),
+  appLibTests: resolveApp('lib/cjs/test'),
+  appPublic: resolveApp('public'),
+  appDocs: resolveApp('lib/cjs/docs'),
+  appJsonDocs: resolveApp('lib/cjs/docs/json/file.json'),
+  appJUnitTestResults: resolveApp('lib/test/junit_results.xml'),
+  libExtract: resolveApp('lib/cjs/extract'),
+  appLocalesEnglish: resolveApp('public/locales/en'),
+  appLocalesPseudolocalize: resolveApp('public/locales/en-pseudo'),
+};