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

package/scripts/utils/validateTags.js

@@ -1,120 +1,120 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-const FS = require('fs-extra');
-const validTags = [
-  "see",
-  "note",
-  "throws",
-  "param",
-  "module",
-  "type",
-  "minimum",
-  "minlength",
-  "default",
-  "example",
-  "pattern",
-
-  // Following flags are added to support API-extractor (https://api-extractor.com/pages/tsdoc/syntax/#release-tags)
-  "alpha",
-  "beta",
-  "deprecated",
-  "internal",
-  "public",
-];
-
-function validateTags(path) {
-  return parseFile(path);
-}
-
-function parseFile(path) {
-  let allTags = {};
-
-  if (FS.existsSync(path) && FS.statSync(path).isFile()) {
-    const contents = FS.readFileSync(path, 'utf-8');
-    let jsonContents = JSON.parse(contents);
-
-    let tags = findValues(jsonContents, 'tags');
-
-    for (let j = 0; j < tags.length; j++) {
-      for (let i = 0; i < tags[j].length; i++)
-        allTags[tags[j][i]['tag']] = allTags[tags[j][i]['tag']] ? allTags[tags[j][i]['tag']] + 1 : 1;
-    }
-
-    let invalidTagObjects = [];
-    for (tag in allTags) {
-      if (!validTags.includes(tag))
-        invalidTagObjects.push(tag, findSource(jsonContents, 'tag', tag));
-    }
-    return invalidTagObjects;
-  }
-}
-
-function findValues(obj, key) {
-  return findValuesHelper(obj, key, []);
-}
-
-function findValuesHelper(obj, key, list) {
-  if (!obj) return list;
-  if (obj instanceof Array) {
-    for (var i in obj)
-      list = list.concat(findValuesHelper(obj[i], key, []));
-    return list;
-  }
-
-  if (obj[key]) list.push(obj[key]);
-
-  if ((typeof obj == "object") && (obj !== null)) {
-    const children = Object.keys(obj);
-    if (children.length > 0) {
-      for (i = 0; i < children.length; i++)
-        list = list.concat(findValuesHelper(obj[children[i]], key, []));
-    }
-  }
-  return list;
-}
-
-function findSource(obj, key, value) {
-  return findSourceHelper(obj, key, value, []);
-}
-
-function findSourceHelper(obj, key, value, list) {
-  if (!obj) return list;
-  if (obj instanceof Array) {
-    for (var i in obj)
-      list = list.concat(findSourceHelper(obj[i], key, value, []));
-    return list;
-  }
-
-  //Look for tag in signature or in comment
-  if (obj['signatures']) {
-    if (obj['signatures'][0] && obj['signatures'][0]['comment'] && obj['signatures'][0]['comment']['tags']) {
-      for (let tag in obj['signatures'][0]['comment']['tags']) {
-        if (obj['signatures'][0]['comment']['tags'][tag].tag === value && obj['sources'] && obj['sources'][0])
-          list.push(obj['sources'][0]);
-      }
-    }
-  }
-
-  if (obj['comment'] && obj['comment']['tags']) {
-    for (let tag in obj['comment']['tags']) {
-      if (obj['comment']['tags'][tag].tag === value && obj['sources'] && obj['sources'][0])
-        list.push(obj['sources'][0]);
-    }
-  }
-
-  if ((typeof obj == "object") && (obj !== null)) {
-    const children = Object.keys(obj);
-    if (children.length > 0) {
-      for (i = 0; i < children.length; i++)
-        list = list.concat(findSourceHelper(obj[children[i]], key, value, []));
-    }
-  }
-  return list;
-}
-
-module.exports = {
-  validateTags: validateTags,
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+const FS = require('fs-extra');
+const validTags = [
+  "see",
+  "note",
+  "throws",
+  "param",
+  "module",
+  "type",
+  "minimum",
+  "minlength",
+  "default",
+  "example",
+  "pattern",
+
+  // Following flags are added to support API-extractor (https://api-extractor.com/pages/tsdoc/syntax/#release-tags)
+  "alpha",
+  "beta",
+  "deprecated",
+  "internal",
+  "public",
+];
+
+function validateTags(path) {
+  return parseFile(path);
+}
+
+function parseFile(path) {
+  let allTags = {};
+
+  if (FS.existsSync(path) && FS.statSync(path).isFile()) {
+    const contents = FS.readFileSync(path, 'utf-8');
+    let jsonContents = JSON.parse(contents);
+
+    let tags = findValues(jsonContents, 'tags');
+
+    for (let j = 0; j < tags.length; j++) {
+      for (let i = 0; i < tags[j].length; i++)
+        allTags[tags[j][i]['tag']] = allTags[tags[j][i]['tag']] ? allTags[tags[j][i]['tag']] + 1 : 1;
+    }
+
+    let invalidTagObjects = [];
+    for (tag in allTags) {
+      if (!validTags.includes(tag))
+        invalidTagObjects.push(tag, findSource(jsonContents, 'tag', tag));
+    }
+    return invalidTagObjects;
+  }
+}
+
+function findValues(obj, key) {
+  return findValuesHelper(obj, key, []);
+}
+
+function findValuesHelper(obj, key, list) {
+  if (!obj) return list;
+  if (obj instanceof Array) {
+    for (var i in obj)
+      list = list.concat(findValuesHelper(obj[i], key, []));
+    return list;
+  }
+
+  if (obj[key]) list.push(obj[key]);
+
+  if ((typeof obj == "object") && (obj !== null)) {
+    const children = Object.keys(obj);
+    if (children.length > 0) {
+      for (i = 0; i < children.length; i++)
+        list = list.concat(findValuesHelper(obj[children[i]], key, []));
+    }
+  }
+  return list;
+}
+
+function findSource(obj, key, value) {
+  return findSourceHelper(obj, key, value, []);
+}
+
+function findSourceHelper(obj, key, value, list) {
+  if (!obj) return list;
+  if (obj instanceof Array) {
+    for (var i in obj)
+      list = list.concat(findSourceHelper(obj[i], key, value, []));
+    return list;
+  }
+
+  //Look for tag in signature or in comment
+  if (obj['signatures']) {
+    if (obj['signatures'][0] && obj['signatures'][0]['comment'] && obj['signatures'][0]['comment']['tags']) {
+      for (let tag in obj['signatures'][0]['comment']['tags']) {
+        if (obj['signatures'][0]['comment']['tags'][tag].tag === value && obj['sources'] && obj['sources'][0])
+          list.push(obj['sources'][0]);
+      }
+    }
+  }
+
+  if (obj['comment'] && obj['comment']['tags']) {
+    for (let tag in obj['comment']['tags']) {
+      if (obj['comment']['tags'][tag].tag === value && obj['sources'] && obj['sources'][0])
+        list.push(obj['sources'][0]);
+    }
+  }
+
+  if ((typeof obj == "object") && (obj !== null)) {
+    const children = Object.keys(obj);
+    if (children.length > 0) {
+      for (i = 0; i < children.length; i++)
+        list = list.concat(findSourceHelper(obj[children[i]], key, value, []));
+    }
+  }
+  return list;
+}
+
+module.exports = {
+  validateTags: validateTags,
+};

package/tsconfig-base.json

@@ -1,28 +1,28 @@
-{
-  "compilerOptions": {
-    "alwaysStrict": true,
-    "declaration": true,
-    "declarationMap": true,
-    "esModuleInterop": false,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "incremental": true,
-    "inlineSources": true,
-    "jsx": "react",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "noFallthroughCasesInSwitch": false,
-    "noImplicitAny": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "stripInternal": false,
-    "target": "ES2019"
-  }
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": false,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "incremental": true,
+    "inlineSources": true,
+    "jsx": "react",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": false,
+    "noImplicitAny": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "stripInternal": false,
+    "target": "ES2019"
+  }
 }

package/tsconfig.json

@@ -1,19 +1,19 @@
-{
-  "extends": "./tsconfig-base.json",
-  "compilerOptions": {
-    "declaration": false,
-    "declarationMap": false,
-    "sourceMap": false,
-    "inlineSources": false,
-    "incremental": false,
-    "rootDir": "./src",
-    "outDir": "." // We want the files to be accessible within a directory at the root alongside the scripts directory
-  },
-  "include": [
-    "./src/**/*.ts"
-  ],
-  "exclude": [
-    "lib",
-    "node_modules"
-  ]
-}
+{
+  "extends": "./tsconfig-base.json",
+  "compilerOptions": {
+    "declaration": false,
+    "declarationMap": false,
+    "sourceMap": false,
+    "inlineSources": false,
+    "incremental": false,
+    "rootDir": "./src",
+    "outDir": "." // We want the files to be accessible within a directory at the root alongside the scripts directory
+  },
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "exclude": [
+    "lib",
+    "node_modules"
+  ]
+}