@vscode/telemetry-extractor 1.9.5

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,29 @@
+# Telemetry Extractor for VS Code and associated source repositories
+
+**Note**: This tool currently does not work in Windows CMD prompt or Powershell. On Windows you will need to use WSL or some other linux-like shell.
+
+This tooling allows for the extraction of [GDPR formatted comments](./documentation/comment-code-annotations.md) from the VS Code source repository and
+produces a JSON file containing the telemetry events which are collected.
+
+## Prerequisites
+* Node LTS (12.x) installed and in your path 
+
+## Setup
+```bash
+    npm i vscode-telemetry-extractor
+```
+For the various supported commands please see [**Using the tool**](./documentation/using-the-tool.md)
+
+# Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

package/SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/documentation/comment-code-annotations.md

@@ -0,0 +1,197 @@
+# Annotating your Code
+
+**NOTE**: If using Typescript we recommend annotating your telemetry events with typings as shown [here](typescript-code-annotations.md)
+
+All telemetry events we send need to be described. For each property of each event we need to know what kind of data they contain and for what reason we collect the data.
+
+Let's assume we send the following event and the timer data is dynamic, i.e. the properties of `timer` can not be known statically:
+```ts
+logEvent('E1', {
+    E1P1: 'activitybar',
+    ...f1,
+    ...f4,
+    timer: {
+        waited: 536,
+        processing: 43,
+        queued: 97,
+        elasped: 812
+    }
+});
+```
+
+The event is constructed in multiple steps, normally scattered across several files:
+```ts
+function logEvent(eventName, eventData) {
+    eventData.CP1 = getSQMUserId();
+    service.sendEvent(eventName, eventData);
+}
+
+let f1 : F1 = { F1P1 : 23 };
+
+let f2 : F2 = { F2P1 : document.getLine(1) };
+
+let f3 : F3 = { F3P1: publisher.displayName };
+
+let f4 : F4 = {
+    F4P1: extension.extensionName,
+    F4P2: {
+        ...f2,
+        ...f3
+    }
+};
+
+logEvent('E1', {
+    E1P1: 'activitybar',
+    ...f1,
+    ...f4,
+    timer: {
+        waited: 536,
+        processing: 43,
+        queued: 97,
+        elasped: 812
+    }
+});
+```
+
+In order to extract the event descriptions with simple scanners we use specific comments to describe telemetry events and their properties. We place those comments as close as possible to where the events and properties are generated. The code above would be annotated as follows:
+```ts
+// __GDPR__COMMON__ "CP1" : { "endPoint": "SqmUserId", "classification": "EndUserPseudonymizedInformation", "purpose": "BusinessInsight" }
+function logEvent(eventName, eventData) {
+    eventData.CP1 = getSQMUserId();
+    service.sendEvent(eventName, eventData);
+}
+
+/* __GDPR__FRAGMENT__
+   "F1" : {
+      "F1P1": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+   }
+ */
+let f1 : F1 = { F1P1 : 23 };
+
+/* __GDPR__FRAGMENT__
+   "F2" : {
+      "F2P1" : { "classification": "CustomerContent", "purpose": "PerformanceAndHealth" }
+   }
+ */
+let f2 : F2 = { F2P1 : document.getLine(1) };
+
+/* __GDPR__FRAGMENT__
+   "F3" : {
+      "F3P1" : { "classification": "PublicPersonalData", "purpose": "FeatureInsight" }
+   }
+ */
+let f3 : F3 = { F3P1: publisher.displayName };
+
+/* __GDPR__FRAGMENT__
+   "F4" : {
+      "F4P1" : { "classification": "PublicNonPersonalData", "purpose": "FeatureInsight" },
+      "F4P2": {
+          "${inline}": [
+              "${F2}",
+              "${F3}"
+            ]
+        }
+   }
+ */
+let f4 : F4 = {
+    F4P1: extension.extensionName,
+    F4P2: {
+        ...f2,
+        ...f3
+    }
+};
+
+/* __GDPR__
+   "E1" : {
+      "E1P1" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+      "${include}": [
+          "${F1}",
+          "${F4}"
+        ],
+      "${wildcard}": [
+         {
+            "${prefix}": "timer.",
+            "${classification}": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+         }
+      ]
+   }
+ */
+logEvent('E1', {
+    E1P1: 'activitybar',
+    ...f1,
+    ...f4,
+    timer: {
+        waited: 536,
+        processing: 43,
+        queued: 97,
+        elasped: 812
+    }
+});
+```
+
+The GDPR comments are processed and result in the following final description of the `E1` event. Every property that starts with `timer.` -- such as `timer.waited` -- is classified as system metadata that we collect for gaining insights into how the feature is being used.
+```json
+   "E1" : {
+      "E1P1" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+      "F1P1": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+      "F4P1" : { "classification": "PublicNonPersonalData", "purpose": "FeatureInsight" },
+      "F4P2.F2P1" : { "classification": "CustomerContent", "purpose": "PerformanceAndHealth" },
+      "F4P2.F3P1" : { "classification": "PublicPersonalData", "purpose": "FeatureInsight" },
+      "${wildcard}": [
+         {
+            "${prefix}": "timer.",
+            "${classification}": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+         }
+      ],
+      "CP1" : { "endPoint": "SqmUserId", "classification": "EndUserPseudonymizedInformation", "purpose": "BusinessInsight" }
+   }
+```
+
+# Syntax
+All GDPR comments are tagged with one of the following tags and are otherwise well-formed `JSON`.
+- `__GDPR__` - describes the name and the properties of a telemetry event
+- `__GDPR__FRAGMENT__` - describes the name and the properties of a fragment of the data of an event, fragments are either included or inlined by other fragments or events
+- `__GDPR__COMMON__` - describes a property added to every telemetry event
+
+Each property is described with an object that looks like this:
+```ts
+{
+    endPoint?: "none" | "SqmUserId" | "SqmMachineId",
+    classification: "SystemMetaData" | "CustomerContent" | "EndUserPseudonymizedInformation" | "PublicPersonalData" | "PublicNonPersonalData" | "CallstackOrException",
+    purpose: "FeatureInsight" | "PerformanceAndHealth" | "BusinessInsight" | "SecurityAndAuditing",
+    owner: string,
+    comment: string,
+    expiration?: string,
+    isMeasurement?: Boolean
+}
+```
+
+If `endPoint` is omitted, it defaults to `none`. That's appropriate for pretty much all properties rather than a couple of common properties.
+
+The values for `classification` are mostly self-explaining. `EndUserPseudonymizedInformation` is what allows us to identify a particular user across time, although we don't know the actual identity of the user. `machineId` or `instanceId` fall in this category. `PublicPersonalData` and `PublicNonPersonalData` is information that users provide us with, for example, publisher information on the marketplace. `CustomerContent` is information the user generated such as urls of repositories or custom snippets. `CallstackOrException` is for error data like callbacks and exceptions. Everything else is `SystemMetaData`.
+
+`purpose` is usually `FeatureInsight` or `PerformanceAndHealth`. We only use `BusinessInsight` for events generated by surveys.
+
+`owner` is used to specify who is responsbile for the telemetry event. 
+
+`comment` is used to specify a reason for collecting the event. This is meant to be more descriptive than `classification` and `purpose`.
+
+`expiration` is used if you would like to dictate the max product version this telemetry event should be sent in. This allows external tools to specify which events should be removed from the codebase.
+
+`isMeasurement` is used if the property is a number. Numbers are handled differently in the telemetry system.
+
+For an event with no properties, define an empty event:
+```json
+"event" : { }
+```
+This will be classified as `SystemMetadata` with a purpose of `FeatureInsight`.
+
+## Special constructs
+#### ${include}
+If A includes B, this is equivalent to the union of A and B. Fragments are referenced using `${FragmentName}`.
+
+#### ${inline}
+If A inlines B at property P, all properties of B are added to A under the key `"P.<Name in B>"`. Fragments are referenced using `${FragmentName}`.
+
+#### ${wildcard}
+Wildcards can be used as a **temporary** workaround to describe dynamic properties that have a common prefix. In the long run all dynamic properties need to be removed and be sent as values of a static property. A wild card is an array of wildcard entries. Each entry has a `${prefix}` and a `${classification}` property. The value of `${prefix}` is a string representing the common prefix of all properties it matches. The value of `${classification}` is a property description detailed above.

package/documentation/typescript-code-annotations.md

@@ -0,0 +1,187 @@
+# Using Typescript to annotate your Typescript Code
+
+As shown in [GDPR formatted comments](comment-code-annotations.md) telemetry events can be documented in the form of hand written JSON comments.
+This form of documentation has its pros and cons, one of the major cons which is human error. Comments do not offer any computer assisted protection agianst things like simple typos while typings do.
+
+## Declaring your telemetry handler
+We recommend declaring your telemetry handler the same way VS Code does as the parser explicity looks for a function called publicLog2 which is templated
+and takes two types, the event and the classification.
+
+```typescript
+interface IPropertyData {
+    classification: 'SystemMetaData' | 'CallstackOrException';
+    purpose: 'PerformanceAndHealth' | 'FeatureInsight';
+    owner: string;
+    comment: string;
+    expiration?: string;
+    endpoint?: string;
+    isMeasurement?: boolean;
+}
+
+interface IGDPRProperty {
+    readonly [name: string] : IPropertyData | undefined | IGDPRProperty;
+}
+
+type ClassifiedEvent<T extends IGDPRProperty> = {
+    [k in keyof T]: any
+}
+
+type StrictPropertyCheck<TEvent, TClassifiedEvent, TError> = keyof TEvent extends keyof TClassifiedEvent ? keyof TClassifiedEvent extends keyof TEvent ? TEvent : TError : TError;
+
+function publicLog2<E extends ClassifiedEvent<T> = never, T extends {[_ in keyof T]: IPropertyData | IGDPRProperty | undefined} = never>(name: string, props: StrictPropertyCheck<E, ClassifiedEvent<T>, 'Type of classified event does not match event properties'>) { }
+```
+
+## Simple Events
+Previously the annotation for the event monacoworkbench/packagemetrics looked like this:
+```ts
+    /* __GDPR__
+        "monacoworkbench/packagemetrics" : {
+            "commit" : {"classification": "SystemMetaData", "purpose": "PerformanceAndHealth" },
+            "size" : {"classification": "SystemMetaData", "purpose": "PerformanceAndHealth" },
+            "count" : {"classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }
+        }
+    */
+```
+
+With typescript annotations the event would be annotated like this:
+```ts
+type PackageMetricsClassification =  {
+    commit: { classification: 'SystemMetaData', purpose: 'PerformanceAndHealth' };
+    size: { classification: 'SystemMetaData', purpose: 'PerformanceAndHealth' };
+    count: { classification: 'SystemMetaData', purpose: 'PerformanceAndHealth' };
+};
+```
+
+You would then need to declare a type for the event you're sending and send the event
+
+```ts
+interface PackageMetrics {
+    commit: string;
+    size: number;
+    count: number;
+};
+publicLog2<PackageMetrics, PackageMetricsClassification>('monacoworkbench/packagemetrics', packageMetric);
+// Inline works too
+publicLog2<PackageMetrics, PackageMetricsClassification>('monacoworkbench/packagemetrics', {commit: 'abcdef', size: 10, count: 1});
+```
+
+This form of annotation requires that the type of event sent and its classification match in terms of properties and that the classification is a valid classification.
+
+## Includes
+Includes were previously annotated like this:
+```ts
+    /* __GDPR__FRAGMENT__
+        "TypeScriptCommonProperties" : {
+            "version" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+        }
+    */
+
+    /* __GDPR__
+        "tsserver.exitWithCode" : {
+            "code" : { "classification": "CallstackOrException", "purpose": "PerformanceAndHealth" },
+            "${include}": [
+                "${TypeScriptCommonProperties}"
+            ]
+        }
+    */
+```
+
+With using typings as annotations an include is effectively the extends keyword or an intersect type. The typing annotation is as follows
+
+```ts
+    type TypeScriptCommonPropertiesClassification = {
+        version: {classification: 'SystemMetaData', purpose: 'FeatureInsight'};
+    };
+
+    // The intersect type signifies the include
+    type TSServeExitWithCodeClassification  = {
+        code: {classification: 'CallstackOrException', purpose: 'PerformanceAndHealth'};
+    } & TypeScriptCommonPropertiesClassification;
+```
+
+The event is then given a type and sent just like the event above
+```ts
+    interface TSServerExitCode {
+        code: number;
+        version: number;
+    };
+
+    const tsServerEvent: TSServerExitCode = {
+        code: 0,
+        version: 3.5
+    };
+
+    publicLog2<TSServerExitCode, TSServeExitWithCodeClassification>('tsserver.exitWithCode', tsServerEvent);
+    publicLog2<TSServerExitCode, TSServeExitWithCodeClassification>('tsserver.exitWithCode', {code: 0, version: 3.5});
+```
+
+## Inlines
+Inlines were previously annotated like so:
+```ts
+    /* __GDPR__FRAGMENT__
+        "ExtensionIdentifier" : {
+            "id" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+            "uuid": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+        }
+    */
+
+    /* __GDPR__
+        "disableOtherKeymaps" : {
+            "newKeymap": { "${inline}": [ "${ExtensionIdentifier}" ] },
+            "oldKeymaps": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
+            "confirmed" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true }
+        }
+    */
+```
+
+Inlines can be thought of as composition and therefore can be defined as a type containing another type
+
+```ts
+    type ExtensionIdentifierClassifcation = {
+        id: {classification: 'SystemMetaData', purpose: 'FeatureInsight'};
+        uuid: {classification: 'SystemMetaData', purpose: 'FeatureInsight'};
+    };
+
+    type DisableOtherKeymapsClassification = {
+        newKeyMap: ExtensionIdentifierClassifcation;
+        oldKeyMaps: {classification: 'SystemMetaData', purpose: 'FeatureInsight'};
+        confirmed: {classification: 'SystemMetaData', purpose: 'FeatureInsight', isMeasurement: true};
+    };
+```
+
+The process of defining and sending the event are the same as the previous two
+
+```ts
+    interface ExtensionIdentifier {
+        id: number;
+        uuid: number;
+    };
+
+    interface DisableOtherKeymaps {
+        newKeyMap: ExtensionIdentifier;
+        oldKeyMaps: string;
+        confirmed: boolean;
+    };
+
+    const extensionIdentifierFragment: ExtensionIdentifier = {
+        id: 1,
+        uuid: 1234
+    };
+
+    const disableKeymapsEvent: DisableOtherKeymaps = {
+        newKeyMap: extensionIdentifierFragment,
+        oldKeyMaps: 'abcd',
+        confirmed: true
+    };
+
+    publicLog2<DisableOtherKeymaps, DisableOtherKeymapsClassification>('disableOtherKeymaps', disableKeymapsEvent);
+```
+
+## Currently Not Supported
+
+* Wildcards
+* Common Properties
+* Anything else not defined above
+
+To get around the not supported features we recommend annotating those with comments as the extractor will fall back on those provided no type annotations are provided.
+

package/documentation/using-the-tool.md

@@ -0,0 +1,106 @@
+# Generate Telemetry JSON Files
+
+The inventories will be generated as `json` files. They have the following basic structure:
+```json
+{
+    "events": {
+        "<eventName>": {
+            "<propertyName>": {
+                "classification": "SystemMetaData",
+                "purpose": "FeatureInsight",
+                "endPoint": "none"
+            },
+            "<propertyName>": {
+                "classification": "SystemMetaData",
+                "purpose": "PerformanceAndHealth",
+                "isMeasurement": true,
+                "endPoint": "none"
+            }
+        },
+        ...
+    },
+    "commonProperties": {
+        "<commonPropertyName>": {
+            "classification": "SystemMetaData",
+            "purpose": "FeatureInsight",
+            "endPoint": "none"
+        },
+        ...
+    }
+}
+```
+
+Note: If the code annotations have syntax errors, the inventory generation will fail.
+
+
+## Viewing what the command has to offer
+```bash
+vscode-telemetry-extractor --help
+Allows the extraction of telemetry annotation from code. For more details please read: https://github.com/microsoft/vscode-telemetry-extractor/blob/master/README.md
+
+-s --sourceDir                          The folder which you want to extract telemetry from
+-x --excludedDir                        A subdirectory which you would like to exclude from the extraction
+-c --config                             A JSON Configuration file containing extraction details
+-o --outputDir                          The directory which you would like the outputted JSON file to be placed in
+-p --eventPrefix                        The string you wish to prepend to every telemetry event.
+-h --help                               Displays the help dialog which provides more information on how to use the tool
+```
+
+## Extracting telemetry events
+To extract telemetry events from your code you must provide a source directory and output directory.
+The source directory is the folder containing the code which you wish to extract the events. The output directory is the location which the resulting JSON report will be placed.
+
+```bash
+   vscode-telemetry-extractor -s PATH_TO_YOUR_CODE -o PATH_TO_PLACE_JSON
+```
+This will generate output similar to:
+```bash
+....running.
+...extracting
+...writing <OUTPUTDIR>/declarations-resolved.json
+```
+
+## Using a config file
+The extractor also supports config files which can be passed in via a command line arguments to customize the way the tool parses.
+An example config file can be found below. Note: `sourceDirs` and `excludedDirs` must be made relative to the `workingDir`
+```json
+[
+    {
+        "eventPrefix": "typescript-language-features/",
+        "workingDir": "/Users/lramos/vscode-telemetry-extractor/src/telemetry-sources",
+        "sourceDirs": [
+            "vscode/extensions/typescript-language-features",
+            "Typescript"
+        ],
+        "excludedDirs": [],
+        "applyEndpoints": true
+    },
+    {
+        "eventPrefix": "msjsdiag.chrome/",
+        "workingDir": "/Users/lramos/vscode-telemetry-extractor/src/telemetry-sources",
+        "sourceDirs": [
+            "vscode-chrome-debug-core",
+            "vscode-chrome-debug"
+        ],
+        "excludedDirs": [],
+        "applyEndpoints": true,
+        "lowerCaseEvents": true
+    }
+]
+```
+
+Some defaults:
+1. If no working directory is provided it will use your current working directory
+2. `excludedDirs` defaults to an empty array
+3. If the working directory provided is relative it must be relative to the current working directory
+
+# Other Functionalities
+
+## Running Tests
+
+If you wish to make contributions to this tool, a few tests are provided to ensure there are no regressions. We also urge that you 
+add tests to ensure that any code you add doesn't break as well.
+
+```bash
+    npm run test
+```

package/out/cli-help.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const cli_options_1 = require("./cli-options");
+function buildHelpMessage() {
+    console.log('Allows the extraction of telemetry annotation from code. For more details please read: https://github.com/microsoft/vscode-telemetry-extractor/blob/master/README.md\n');
+    const optionLengths = cli_options_1.optionDefinitions.map((opt) => {
+        if (opt.description) {
+            return opt.name.length;
+        }
+        return -1;
+    });
+    const maxLength = Math.max(...optionLengths);
+    for (const opt of cli_options_1.optionDefinitions) {
+        if (opt.description) {
+            let outputString = '';
+            if (opt.alias) {
+                outputString += `-${opt.alias} `;
+            }
+            // Extra padding if you don't have an alias
+            const extraPadding = opt.alias ? 0 : 3;
+            outputString += `--${opt.name.padEnd(maxLength + extraPadding)}\t\t\t`;
+            outputString += `${opt.description}`;
+            console.log(outputString);
+        }
+    }
+}
+buildHelpMessage();
+//# sourceMappingURL=cli-help.js.map

package/out/cli-help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-help.js","sourceRoot":"","sources":["../src/cli-help.ts"],"names":[],"mappings":";;AAAA,uCAAuC;AACvC,kCAAkC;AAClC,+CAAkD;AAElD,SAAS,gBAAgB;IACrB,OAAO,CAAC,GAAG,CAAC,wKAAwK,CAAC,CAAC;IACtL,MAAM,aAAa,GAAG,+BAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAChD,IAAI,GAAG,CAAC,WAAW,EAAE;YACjB,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,CAAA;SACzB;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;IAC7C,KAAK,MAAM,GAAG,IAAI,+BAAiB,EAAE;QACjC,IAAI,GAAG,CAAC,WAAW,EAAE;YACjB,IAAI,YAAY,GAAG,EAAE,CAAC;YACtB,IAAI,GAAG,CAAC,KAAK,EAAE;gBACX,YAAY,IAAI,IAAI,GAAG,CAAC,KAAK,GAAG,CAAC;aACpC;YACD,2CAA2C;YAC3C,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,YAAY,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC;YACvE,YAAY,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ;AACL,CAAC;AAED,gBAAgB,EAAE,CAAC"}

package/out/cli-options.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.options = exports.optionDefinitions = void 0;
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const command_line_args_1 = __importDefault(require("command-line-args"));
+const path = __importStar(require("path"));
+function resolveDirectories(options) {
+    const cwd = process.cwd();
+    if (options.sourceDir) {
+        options.sourceDir = options.sourceDir.map(d => path.resolve(cwd, d));
+    }
+    if (options.outputDir) {
+        options.outputDir = path.resolve(cwd, options.outputDir);
+    }
+    return options;
+}
+exports.optionDefinitions = [
+    { name: 'sourceDir', alias: 's', description: 'The folder which you want to extract telemetry from (relative to the CWD)', type: String, multiple: true },
+    { name: 'excludedDir', alias: 'x', description: 'A subdirectory which you would like to exclude from the extraction (relative to the CWD)', type: String, multiple: true, defaultValue: [] },
+    { name: 'config', alias: 'c', description: 'A JSON Configuration file containing extraction details', type: String },
+    { name: 'outputDir', alias: 'o', description: 'The directory which you would like the outputted JSON file to be placed in', type: String },
+    { name: 'eventPrefix', alias: 'p', type: String, description: 'The string you wish to prepend to every telemetry event.', defaultValue: '' },
+    { name: 'help', alias: 'h', type: Boolean, description: 'Displays the help dialog which provides more information on how to use the tool', defaultValue: false },
+    { name: 'applyEndpoints', alias: 'e', type: Boolean, defaultValue: false },
+    { name: 'silenceOutput', type: Boolean, description: 'Silences all progress messages.', defaultValue: false },
+    { name: 'verbose', alias: 'v', type: Boolean, defaultValue: false }
+];
+exports.options = resolveDirectories((0, command_line_args_1.default)(exports.optionDefinitions, { partial: true }));
+//# sourceMappingURL=cli-options.js.map