nativescript 9.0.4-dev.1 → 9.0.4-dev.2

package/lib/common/mobile/mobile-core/android-process-service.js

@@ -71,6 +71,19 @@ class AndroidProcessService {
     async getDebuggableApps(deviceIdentifier) {
         const adb = this.getAdb(deviceIdentifier);
         const androidWebViewPortInformation = (await this.getAbstractPortsInformation(adb)).split(os_1.EOL);
+        // TODO: Add tests and make sure only unique names are returned. Input before groupBy is:
+        // [ { deviceIdentifier: 'SH26BW100473',
+        // 	appIdentifier: 'com.telerik.EmptyNS',
+        // 	framework: 'NativeScript' },
+        // 	{ deviceIdentifier: 'SH26BW100473',
+        // 	appIdentifier: 'com.telerik.EmptyNS',
+        // 	framework: 'Cordova' },
+        // 	{ deviceIdentifier: 'SH26BW100473',
+        // 	appIdentifier: 'chrome',
+        // 	framework: 'Cordova' },
+        // 	{ deviceIdentifier: 'SH26BW100473',
+        // 	appIdentifier: 'chrome',
+        // 	framework: 'Cordova' } ]
         const portInformation = await Promise.all(_.map(androidWebViewPortInformation, async (line) => (await this.getApplicationInfoFromWebViewPortInformation(adb, deviceIdentifier, line)) ||
             (await this.getNativeScriptApplicationInformation(adb, deviceIdentifier, line))));
         return _(portInformation)
@@ -109,6 +122,7 @@ class AndroidProcessService {
         return adb;
     }
     async getApplicationInfoFromWebViewPortInformation(adb, deviceIdentifier, information) {
+        // Need to search by processId to check for old Android webviews (@webview_devtools_remote_<processId>).
         const processIdRegExp = /@webview_devtools_remote_(.+)/g;
         const processIdMatches = processIdRegExp.exec(information);
         let cordovaAppIdentifier;
@@ -117,6 +131,7 @@ class AndroidProcessService {
             cordovaAppIdentifier = await this.getApplicationIdentifierFromPid(adb, processId);
         }
         else {
+            // Search for appIdentifier (@<appIdentifier>_devtools_remote).
             const chromeAppIdentifierRegExp = /@(.+)_devtools_remote\s?/g;
             const chromeAppIdentifierMatches = chromeAppIdentifierRegExp.exec(information);
             if (chromeAppIdentifierMatches && chromeAppIdentifierMatches.length > 0) {
@@ -133,6 +148,7 @@ class AndroidProcessService {
         return null;
     }
     async getNativeScriptApplicationInformation(adb, deviceIdentifier, information) {
+        // Search for appIdentifier (@<appIdentifier-debug>).
         const nativeScriptAppIdentifierRegExp = /@(.+)-(debug|inspectorServer)/g;
         const nativeScriptAppIdentifierMatches = nativeScriptAppIdentifierRegExp.exec(information);
         if (nativeScriptAppIdentifierMatches &&
@@ -147,6 +163,10 @@ class AndroidProcessService {
         return null;
     }
     async getAbstractPortForApplication(adb, processId, appIdentifier, abstractPortsInformation, framework) {
+        // The result will look like this (without the columns names):
+        // Num       		 RefCount Protocol Flags    Type St Inode  Path
+        // 0000000000000000: 00000002 00000000 00010000 0001 01 189004 @webview_devtools_remote_25512
+        // The Path column is the abstract port.
         framework = framework || "";
         switch (framework.toLowerCase()) {
             case constants_1.TARGET_FRAMEWORK_IDENTIFIERS.Cordova.toLowerCase():
@@ -173,6 +193,9 @@ class AndroidProcessService {
         return match && match[1];
     }
     async getProcessIds(adb, appIdentifiers) {
+        // Process information will look like this (without the columns names):
+        // USER     PID   PPID  VSIZE   RSS   WCHAN    PC         NAME
+        // u0_a63   25512 1334  1519560 96040 ffffffff f76a8f75 S com.telerik.appbuildertabstest
         const result = {};
         const processIdInformation = await adb.executeShellCommand(["ps"]);
         _.each(appIdentifiers, (appIdentifier) => {
@@ -183,6 +206,11 @@ class AndroidProcessService {
     }
     async getAlreadyMappedPort(adb, deviceIdentifier, abstractPort, adbForwardList) {
         const allForwardedPorts = adbForwardList || (await adb.executeCommand(["forward", "--list"])) || "";
+        // Sample output:
+        // 5e2e580b tcp:62503 localabstract:webview_devtools_remote_7985
+        // 5e2e580b tcp:62524 localabstract:webview_devtools_remote_7986
+        // 5e2e580b tcp:63160 localabstract:webview_devtools_remote_7987
+        // 5e2e580b tcp:57577 localabstract:com.telerik.nrel-debug
         const regex = new RegExp(`${deviceIdentifier}\\s+?tcp:(\\d+?)\\s+?.*?${abstractPort}$`);
         return this.getFirstMatchingGroupFromMultilineResult(allForwardedPorts, regex);
     }
@@ -196,6 +224,9 @@ class AndroidProcessService {
     }
     async getApplicationIdentifierFromPid(adb, pid, psData) {
         psData = psData || (await adb.executeShellCommand(["ps"]));
+        // Process information will look like this (without the columns names):
+        // USER     PID   PPID  VSIZE   RSS   WCHAN    PC         NAME
+        // u0_a63   25512 1334  1519560 96040 ffffffff f76a8f75 S com.telerik.appbuildertabstest
         return this.getFirstMatchingGroupFromMultilineResult(psData, new RegExp(`\\s+${pid}(?:\\s+\\d+){3}\\s+.*\\s+(.*?)$`));
     }
     getFirstMatchingGroupFromMultilineResult(input, regex) {
@@ -218,3 +249,4 @@ __decorate([
     (0, decorators_1.exported)("androidProcessService")
 ], AndroidProcessService.prototype, "getAppProcessId", null);
 yok_1.injector.register("androidProcessService", AndroidProcessService);
+//# sourceMappingURL=android-process-service.js.map

package/lib/common/mobile/mobile-core/device-discovery.js

@@ -51,3 +51,4 @@ class DeviceDiscovery extends events_1.EventEmitter {
 }
 exports.DeviceDiscovery = DeviceDiscovery;
 yok_1.injector.register("deviceDiscovery", DeviceDiscovery);
+//# sourceMappingURL=device-discovery.js.map

package/lib/common/mobile/mobile-core/devices-service.js

@@ -62,6 +62,7 @@ class DevicesService extends events_1.EventEmitter {
             const device = await this.getDevice(options.deviceId);
             return device;
         }
+        // Now let's take data for each device:
         const availableDevicesAndEmulators = this.getDeviceInstances().filter((d) => d.deviceInfo.status === constants_2.CONNECTED_STATUS &&
             (!this.platform ||
                 d.deviceInfo.platform.toLowerCase() === this.platform.toLowerCase()));
@@ -84,6 +85,8 @@ class DevicesService extends events_1.EventEmitter {
                 const devices = sortedInstances.filter((d) => !d.isEmulator);
                 let selectedInstance;
                 if (options.onlyEmulators || options.onlyDevices) {
+                    // When --emulator or --forDevice is passed, the instances are already filtered
+                    // So we are sure we have exactly the type we need and we can safely return the last one (highest OS version).
                     selectedInstance = _.last(sortedInstances);
                 }
                 else {
@@ -142,6 +145,7 @@ class DevicesService extends events_1.EventEmitter {
                 ...additionalErrors,
             ];
         }
+        // emulator is already running
         if (emulator.status === constants.RUNNING_EMULATOR_STATUS) {
             return null;
         }
@@ -173,9 +177,11 @@ class DevicesService extends events_1.EventEmitter {
         return !!(this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform) &&
             device.isEmulator);
     }
+    /* tslint:disable:no-unused-variable */
     setLogLevel(logLevel, deviceIdentifier) {
         this.$deviceLogProvider.setLogLevel(logLevel, deviceIdentifier);
     }
+    /* tslint:enable:no-unused-variable */
     isAppInstalledOnDevices(deviceIdentifiers, appId, projectName, projectDir) {
         this.$logger.trace(`Called isInstalledOnDevices for identifiers ${deviceIdentifiers}. AppIdentifier is ${appId}.`);
         return _.map(deviceIdentifiers, (deviceIdentifier) => this.isApplicationInstalledOnDevice(deviceIdentifier, {
@@ -247,6 +253,9 @@ class DevicesService extends events_1.EventEmitter {
         delete this._availableEmulators[emulator.imageIdentifier];
         this.emit(constants.EmulatorDiscoveryNames.EMULATOR_IMAGE_LOST, emulator);
     }
+    /**
+     * Starts looking for devices. Any found devices are pushed to "_devices" variable.
+     */
     async detectCurrentlyAttachedDevices(deviceInitOpts) {
         const options = this.getDeviceLookingOptions(deviceInitOpts);
         for (const deviceDiscovery of this._allDeviceDiscoveries) {
@@ -315,6 +324,11 @@ class DevicesService extends events_1.EventEmitter {
             clearInterval(this.emulatorDetectionInterval);
         }
     }
+    /**
+     * Returns device that matches an identifier.
+     * The identifier is expected to be the same as the running device declares it (emulator-5554 for android or GUID for ios).
+     * @param identifier running emulator or device identifier
+     */
     getDeviceByIdentifier(identifier) {
         const searchedDevice = _.find(this.getDeviceInstances(), (device) => {
             if (this.$mobileHelper.isApplePlatform(device.deviceInfo.platform) &&
@@ -330,6 +344,9 @@ class DevicesService extends events_1.EventEmitter {
         }
         return searchedDevice;
     }
+    /**
+     * Starts looking for running devices. All found devices are pushed to _devices variable.
+     */
     async startLookingForDevices(deviceInitOpts) {
         this.$logger.trace("startLookingForDevices; platform is %s", this._platform);
         if (this._platform) {
@@ -339,10 +356,20 @@ class DevicesService extends events_1.EventEmitter {
         await this.detectCurrentlyAvailableEmulators();
         await this.startDeviceDetectionInterval(deviceInitOpts);
     }
+    /**
+     * Returns device depending on the passed index.
+     * The index refers to assigned number to listed devices by ns device command.
+     * @param index assigned device number
+     */
     getDeviceByIndex(index) {
         this.validateIndex(index - 1);
         return this.getDeviceInstances()[index - 1];
     }
+    /**
+     * Returns running device for specified --device <DeviceId>.
+     * Method expects running devices.
+     * @param deviceOption parameter passed by the user to --device flag. Can be name, identifier or imageIdentifier.
+     */
     async getDevice(deviceOption) {
         let device = null;
         if (!device) {
@@ -362,6 +389,11 @@ class DevicesService extends events_1.EventEmitter {
         }
         return device;
     }
+    /**
+     * Method runs action for a --device (value), specified by the user.
+     * @param action action to be executed if canExecute returns true
+     * @param canExecute predicate to decide whether the command can be ran
+     */
     async executeOnDevice(action, canExecute) {
         if (!canExecute || canExecute(this._device)) {
             return {
@@ -370,6 +402,11 @@ class DevicesService extends events_1.EventEmitter {
             };
         }
     }
+    /**
+     * Executes passed action for each found device.
+     * @param action action to be executed if canExecute returns true
+     * @param canExecute predicate to decide whether the command can be ran
+     */
     async executeOnAllConnectedDevices(action, canExecute) {
         const devices = this.filterDevicesByPlatform();
         const sortedDevices = _.sortBy(devices, (device) => device.deviceInfo.platform);
@@ -421,6 +458,12 @@ class DevicesService extends events_1.EventEmitter {
             });
         });
     }
+    /**
+     * Runs the passed action if the predicate "canExecute" returns true
+     * @param action action to be executed if canExecute returns true.
+     * @param canExecute predicate to decide whether the command can be ran
+     * @param options all possible options that can be passed to the command.
+     */
     async execute(action, canExecute, options) {
         assert.ok(this._isInitialized, "Devices services not initialized!");
         if (this.hasDevices) {
@@ -429,6 +472,7 @@ class DevicesService extends events_1.EventEmitter {
                 this.$mobileHelper.isiOSPlatform(this._platform) &&
                 this.$options.emulator &&
                 !this.isOnlyiOSSimultorRunning()) {
+                // Executes the command only on iOS simulator
                 const originalCanExecute = canExecute;
                 canExecute = (dev) => this.isiOSSimulator(dev) &&
                     (!originalCanExecute || !!originalCanExecute(dev));
@@ -452,6 +496,11 @@ class DevicesService extends events_1.EventEmitter {
             }
         }
     }
+    /**
+     * Starts emulator or simulator if necessary depending on --device or --emulator flags.
+     * If no options are passed runs default emulator/simulator if no devices are connected.
+     * @param deviceInitOpts mainly contains information about --emulator and --deviceId flags.
+     */
     async startEmulatorIfNecessary(deviceInitOpts) {
         if (deviceInitOpts && deviceInitOpts.deviceId && deviceInitOpts.emulator) {
             this.$errors.fail(`--device and --emulator are incompatible options.
@@ -460,6 +509,7 @@ class DevicesService extends events_1.EventEmitter {
         if (deviceInitOpts &&
             deviceInitOpts.platform &&
             !deviceInitOpts.skipEmulatorStart) {
+            // are there any running devices
             this._platform = deviceInitOpts.platform;
             try {
                 await this.startLookingForDevices(deviceInitOpts);
@@ -485,9 +535,11 @@ class DevicesService extends events_1.EventEmitter {
     }
     async _startEmulatorIfNecessary(data) {
         const deviceInstances = this.getDeviceInstances();
+        //if no --device is passed and no devices are found, the default emulator is started
         if (!data.deviceId && _.isEmpty(deviceInstances)) {
             return this.startEmulatorCore(data);
         }
+        //check if --device(value) is running, if it's not or it's not the same as is specified, start with name from --device(value)
         if (data.deviceId) {
             if (!helpers.isNumberWithoutExponent(data.deviceId)) {
                 const activeDeviceInstance = _.find(deviceInstances, (device) => device.deviceInfo.identifier === data.deviceId);
@@ -496,6 +548,7 @@ class DevicesService extends events_1.EventEmitter {
                 }
             }
         }
+        // make sure if the target platform is visionOS we don't try to run it on an already running iOS simulator...
         if (data.platform === this.$devicePlatformsConstants.visionOS &&
             deviceInstances.length) {
             const runningDeviceInstance = deviceInstances.find((device) => device.deviceInfo.platform ===
@@ -504,6 +557,7 @@ class DevicesService extends events_1.EventEmitter {
                 return this.startEmulatorCore(data);
             }
         }
+        // if only emulator flag is passed and no other emulators are running, start default emulator
         if (data.emulator && deviceInstances.length) {
             const runningDeviceInstance = _.some(deviceInstances, (value) => value.isEmulator);
             if (!runningDeviceInstance) {
@@ -511,6 +565,12 @@ class DevicesService extends events_1.EventEmitter {
             }
         }
     }
+    /**
+     * Takes care of gathering information about all running devices.
+     * Sets "_isInitialized" to true after infomation is present.
+     * Method expects running devices.
+     * @param data mainly contains information about --emulator and --deviceId flags.
+     */
     async initialize(data) {
         if (!this._deviceInitializePromise) {
             this._deviceInitializePromise = this.initializeCore(data);
@@ -519,6 +579,7 @@ class DevicesService extends events_1.EventEmitter {
             await this._deviceInitializePromise;
         }
         catch (err) {
+            // In case the initalization fails, we want to allow calling `initlialize` again with other arguments for example, so remove the cached promise value.
             this.$logger.trace(`Error while initializing devicesService: ${err}`);
             this._deviceInitializePromise = null;
             throw err;
@@ -542,6 +603,7 @@ class DevicesService extends events_1.EventEmitter {
         deviceInitOpts = deviceInitOpts || {};
         this._data = deviceInitOpts;
         if (!deviceInitOpts.skipEmulatorStart) {
+            // TODO: Remove from here as it calls startLookingForDevices, so we double the calls to specific device detection services
             await this.startEmulatorIfNecessary(deviceInitOpts);
         }
         const platform = deviceInitOpts.platform;
@@ -572,6 +634,7 @@ class DevicesService extends events_1.EventEmitter {
             await this.startLookingForDevices(deviceLookingOptions);
         }
         else {
+            // platform and deviceId are not specified
             if (deviceInitOpts.skipInferPlatform) {
                 if (deviceInitOpts.skipDeviceDetectionInterval) {
                     await this.detectCurrentlyAttachedDevices(deviceLookingOptions);
@@ -679,6 +742,11 @@ class DevicesService extends events_1.EventEmitter {
         }
         return null;
     }
+    /**
+     * Starts emulator for platform and makes sure started devices/emulators/simulators are in _devices array before finishing.
+     * @param platform (optional) platform to start emulator/simulator for
+     * @param emulatorIdOrName (optional) emulator/simulator image identifier or name
+     */
     async startEmulatorCore(deviceInitOpts = {}) {
         const { deviceId } = deviceInitOpts;
         const platform = deviceInitOpts.platform || this._platform;
@@ -802,3 +870,4 @@ __decorate([
     (0, decorators_1.exported)("devicesService")
 ], DevicesService.prototype, "getDebuggableViews", null);
 yok_1.injector.register("devicesService", DevicesService);
+//# sourceMappingURL=devices-service.js.map

package/lib/common/mobile/mobile-core/ios-device-discovery.js

@@ -22,6 +22,7 @@ class IOSDeviceDiscovery extends device_discovery_1.DeviceDiscovery {
             return;
         }
         if (this.$mobileHelper.isvisionOSPlatform(options.platform)) {
+            // look for ios devices - same logic.
             options.platform = this.$devicePlatformsConstants.iOS;
         }
         await this.$iosDeviceOperations.startLookingForDevices((deviceInfo) => {
@@ -50,3 +51,4 @@ class IOSDeviceDiscovery extends device_discovery_1.DeviceDiscovery {
 }
 exports.IOSDeviceDiscovery = IOSDeviceDiscovery;
 yok_1.injector.register("iOSDeviceDiscovery", IOSDeviceDiscovery);
+//# sourceMappingURL=ios-device-discovery.js.map

package/lib/common/mobile/mobile-core/ios-simulator-discovery.js

@@ -28,12 +28,14 @@ class IOSSimulatorDiscovery extends device_discovery_1.DeviceDiscovery {
     async checkForDevices() {
         if (this.$hostInfo.isDarwin) {
             const currentSimulators = await this.$iOSSimResolver.iOSSim.getRunningSimulators();
+            // Remove old simulators
             _(this.cachedSimulators)
                 .reject((s) => _.some(currentSimulators, (simulator) => simulator &&
                 s &&
                 simulator.id === s.id &&
                 simulator.state === s.state))
                 .each((s) => this.deleteAndRemoveDevice(s));
+            // Add new simulators
             _(currentSimulators)
                 .reject((s) => _.some(this.cachedSimulators, (simulator) => simulator &&
                 s &&
@@ -92,3 +94,4 @@ class IOSSimulatorDiscovery extends device_discovery_1.DeviceDiscovery {
 }
 exports.IOSSimulatorDiscovery = IOSSimulatorDiscovery;
 yok_1.injector.register("iOSSimulatorDiscovery", IOSSimulatorDiscovery);
+//# sourceMappingURL=ios-simulator-discovery.js.map

package/lib/common/mobile/mobile-helper.js

@@ -89,3 +89,4 @@ class MobileHelper {
 exports.MobileHelper = MobileHelper;
 MobileHelper.DEVICE_PATH_SEPARATOR = "/";
 yok_1.injector.register("mobileHelper", MobileHelper);
+//# sourceMappingURL=mobile-helper.js.map

package/lib/common/mobile/wp8/wp8-emulator-services.js

@@ -53,3 +53,4 @@ class Wp8EmulatorServices {
 Wp8EmulatorServices.WP8_LAUNCHER = "XapDeployCmd.exe";
 Wp8EmulatorServices.WP8_LAUNCHER_PATH = "Microsoft SDKs\\Windows Phone\\v8.0\\Tools\\XAP Deployment";
 yok_1.injector.register("wp8EmulatorServices", Wp8EmulatorServices);
+//# sourceMappingURL=wp8-emulator-services.js.map

package/lib/common/opener.js

@@ -14,3 +14,4 @@ class Opener {
 }
 exports.Opener = Opener;
 yok_1.injector.register("opener", Opener);
+//# sourceMappingURL=opener.js.map

package/lib/common/os-info.js

@@ -19,3 +19,4 @@ class OsInfo {
 }
 exports.OsInfo = OsInfo;
 yok_1.injector.register("osInfo", OsInfo);
+//# sourceMappingURL=os-info.js.map

package/lib/common/plist-parser.js

@@ -22,3 +22,4 @@ class PlistParser {
 }
 exports.PlistParser = PlistParser;
 yok_1.injector.register("plistParser", PlistParser);
+//# sourceMappingURL=plist-parser.js.map

package/lib/common/project-helper.js

@@ -68,3 +68,4 @@ class ProjectHelper {
 }
 exports.ProjectHelper = ProjectHelper;
 yok_1.injector.register("projectHelper", ProjectHelper);
+//# sourceMappingURL=project-helper.js.map

package/lib/common/prompter.js

@@ -26,6 +26,7 @@ class Prompter {
                 else {
                     const result = {};
                     _.each(questions, (s) => {
+                        // Curly brackets needed because s.default() may return false and break the loop
                         result[s.name] = s.default();
                     });
                     return result;
@@ -122,7 +123,9 @@ class Prompter {
     }
     muteStdout() {
         if (helpers.isInteractive()) {
-            process.stdin.setRawMode(true);
+            process.stdin.setRawMode(true); // After setting rawMode to true, Ctrl+C doesn't work for non node.js events loop i.e device log command
+            // We need to create mute-stream and to pass it as output to ctrlcReader
+            // This will prevent the prompter to show the user's text twice on the console
             this.muteStreamInstance = new MuteStream();
             this.muteStreamInstance.pipe(process.stdout);
             this.muteStreamInstance.mute();
@@ -131,6 +134,7 @@ class Prompter {
                 output: this.muteStreamInstance,
             });
             this.ctrlcReader.on("SIGINT", () => {
+                // enable terminal cursor
                 process.stdout.write("\x1B[?25h");
                 process.exit();
             });
@@ -140,6 +144,7 @@ class Prompter {
         if (helpers.isInteractive()) {
             process.stdin.setRawMode(false);
             if (this.muteStreamInstance) {
+                // We need to clean the event listeners from the process.stdout because the MuteStream.pipe function calls the pipe function of the Node js Stream which adds event listeners and this can cause memory leak if we display more than ~10 prompts.
                 this.cleanEventListeners(process.stdout);
                 this.muteStreamInstance.unmute();
                 this.muteStreamInstance = null;
@@ -148,6 +153,8 @@ class Prompter {
         }
     }
     cleanEventListeners(stream) {
+        // The events names and listeners names can be found here https://github.com/nodejs/node/blob/master/lib/stream.js
+        // Which event cause memory leak can be tested with stream.listeners("event-name") and if the listeners count keeps increasing with each prompt we need to remove the listener.
         const memoryLeakEvents = [
             {
                 eventName: "close",
@@ -174,3 +181,4 @@ class Prompter {
 }
 exports.Prompter = Prompter;
 yok_1.injector.register("prompter", Prompter);
+//# sourceMappingURL=prompter.js.map

package/lib/common/queue.js

@@ -24,3 +24,4 @@ class Queue {
     }
 }
 exports.Queue = Queue;
+//# sourceMappingURL=queue.js.map

package/lib/common/resource-loader.js

@@ -23,3 +23,4 @@ class ResourceLoader {
 }
 exports.ResourceLoader = ResourceLoader;
 yok_1.injector.register("resources", ResourceLoader);
+//# sourceMappingURL=resource-loader.js.map

package/lib/common/services/auto-completion-service.js

@@ -27,12 +27,15 @@ class AutoCompletionService {
     get shellProfiles() {
         return [
             this.getHomePath(".bashrc"),
-            this.getHomePath(".zshrc"),
+            this.getHomePath(".zshrc"), // zsh - http://www.acm.uiuc.edu/workshops/zsh/startup_files.html
         ];
     }
     get cliRunCommandsFile() {
         let cliRunCommandsFile = this.getHomePath(util.format(".%src", this.$staticConfig.CLIENT_NAME.toLowerCase()));
         if (this.$hostInfo.isWindows) {
+            // on Windows bash, file is incorrectly written as C:\Users\<username>, which leads to errors when trying to execute the script:
+            // $ source ~/.bashrc
+            // sh.exe": C:Usersusername.appbuilderrc: No such file or directory
             cliRunCommandsFile = cliRunCommandsFile.replace(/\\/g, "/");
         }
         return cliRunCommandsFile;
@@ -47,7 +50,9 @@ class AutoCompletionService {
         return new RegExp(util.format("%s[\\s\\S]*%s", AutoCompletionService.GENERATED_TABTAB_COMPLETION_START, AutoCompletionService.GENERATED_TABTAB_COMPLETION_END));
     }
     removeObsoleteAutoCompletion() {
+        // In previous releases we were writing directly in .bash_profile, .bashrc, .zshrc and .profile - remove this old code
         const shellProfilesToBeCleared = this.shellProfiles;
+        // Add .profile only here as we do not want new autocompletion in this file, but we have to remove our old code from it.
         shellProfilesToBeCleared.push(this.getHomePath(".profile"));
         shellProfilesToBeCleared.forEach((file) => {
             try {
@@ -100,6 +105,7 @@ class AutoCompletionService {
                 this.isNewAutoCompletionEnabledInFile(filePath) ||
                     this.isObsoleteAutoCompletionEnabledInFile(filePath);
             if (!result) {
+                // break each
                 return false;
             }
         });
@@ -125,6 +131,7 @@ class AutoCompletionService {
         _.each(this.shellProfiles, (shellProfile) => {
             result = this.isObsoleteAutoCompletionEnabledInFile(shellProfile);
             if (!result) {
+                // break each
                 return false;
             }
         });
@@ -163,6 +170,8 @@ class AutoCompletionService {
         }
         catch (err) {
             this.$logger.info("Unable to update %s. Command-line completion might not work.", fileName);
+            // When npm is installed with sudo, in some cases the installation cannot write to shell profiles
+            // Advise the user how to enable autocompletion after the installation is completed.
             if ((err.code === "EPERM" || err.code === "EACCES") &&
                 !this.$hostInfo.isWindows &&
                 process.env.SUDO_USER) {
@@ -183,6 +192,7 @@ class AutoCompletionService {
             }
         }
         catch (err) {
+            // If file does not exist, autocompletion was not working for it, so ignore this error.
             if (err.code !== "ENOENT") {
                 this.$logger.info("Failed to update %s. Auto-completion may still work or work incorrectly. ", fileName);
                 this.$logger.info(err);
@@ -214,6 +224,7 @@ class AutoCompletionService {
                         this.$fs.writeFile(filePath, newText);
                     }
                 }
+                // The generated seems to be inconsistent in it's start/end markers so adding our own.
                 this.$fs.appendFile(filePath, `\n${AutoCompletionService.GENERATED_TABTAB_COMPLETION_START}\n`);
                 await this.$childProcess.exec(`"${process.argv[0]}" "${pathToExecutableFile}" completion_generate_script >> "${filePath}"`);
                 this.$fs.appendFile(filePath, this.completionAliasDefinition);
@@ -250,3 +261,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], AutoCompletionService.prototype, "completionShellScriptContent", null);
 yok_1.injector.register("autoCompletionService", AutoCompletionService);
+//# sourceMappingURL=auto-completion-service.js.map

package/lib/common/services/cancellation.js

@@ -28,7 +28,7 @@ class CancellationService {
             .watch(triggerFile, { ignoreInitial: true })
             .on("unlink", (filePath) => {
             this.$logger.info(`Exiting process as the file ${filePath} has been deleted. Probably reinstalling CLI while there's a working instance.`);
-            process.exit(132);
+            process.exit(132 /* ErrorCodes.DELETED_KILL_FILE */);
         });
         if (watcher) {
             this.watches[name] = watcher;
@@ -54,3 +54,4 @@ class CancellationService {
     }
 }
 yok_1.injector.register("cancellation", CancellationService);
+//# sourceMappingURL=cancellation.js.map

package/lib/common/services/commands-service.js

@@ -38,11 +38,11 @@ class CommandsService {
             if (!this.$staticConfig.disableAnalytics &&
                 !command.disableAnalytics &&
                 !this.$options.disableAnalytics) {
-                const analyticsService = this.$injector.resolve("analyticsService");
+                const analyticsService = this.$injector.resolve("analyticsService"); // This should be resolved here due to cyclic dependency
                 await analyticsService.checkConsent();
                 const beautifiedCommandName = this.beautifyCommandName(commandName).replace(/\|/g, " ");
                 const googleAnalyticsPageData = {
-                    googleAnalyticsDataType: "pageview",
+                    googleAnalyticsDataType: "pageview" /* GoogleAnalyticsDataType.Page */,
                     path: beautifiedCommandName,
                     title: beautifiedCommandName,
                 };
@@ -52,10 +52,11 @@ class CommandsService {
             const shouldExecuteHooks = !this.$staticConfig.disableCommandHooks &&
                 (command.enableHooks === undefined || command.enableHooks === true);
             if (shouldExecuteHooks) {
+                // Handle correctly hierarchical commands
                 const hierarchicalCommandName = this.$injector.buildHierarchicalCommand(commandName, commandArguments);
                 if (hierarchicalCommandName) {
-                    commandName = helpers.stringReplaceAll(hierarchicalCommandName.commandName, "|*", "-");
-                    commandName = helpers.stringReplaceAll(commandName, "|", "-");
+                    commandName = helpers.stringReplaceAll(hierarchicalCommandName.commandName, "|*" /* CommandsDelimiters.DefaultHierarchicalCommand */, "-" /* CommandsDelimiters.HooksCommand */);
+                    commandName = helpers.stringReplaceAll(commandName, "|" /* CommandsDelimiters.HierarchicalCommand */, "-" /* CommandsDelimiters.HooksCommand */);
                 }
                 await this.$hooksService.executeBeforeHooks(commandName);
             }
@@ -100,6 +101,7 @@ class CommandsService {
             await this.executeCommandAction(commandName, commandArguments, this.executeCommandUnchecked);
         }
         else {
+            // If canExecuteCommand returns false, the command cannot be executed or there's no such command at all.
             const command = this.$injector.resolveCommand(commandName);
             if (command) {
                 let commandWithArgs = commandName;
@@ -115,12 +117,15 @@ class CommandsService {
         const command = this.$injector.resolveCommand(commandName);
         const beautifiedName = helpers.stringReplaceAll(commandName, "|", " ");
         if (command) {
+            // Verify command is enabled
             if (command.isDisabled) {
                 this.$errors.fail("This command is not applicable to your environment.");
             }
+            // If command wants to handle canExecute logic on its own.
             if (command.canExecute) {
                 return await command.canExecute(commandArguments);
             }
+            // First part of hierarchical commands should be validated in specific way.
             if (await this.$injector.isValidHierarchicalCommand(commandName, commandArguments)) {
                 return true;
             }
@@ -132,8 +137,8 @@ class CommandsService {
         }
         const commandInfo = {
             inputStrings: [commandName, ...commandArguments],
-            commandDelimiter: "|",
-            defaultCommandDelimiter: "|*",
+            commandDelimiter: "|" /* CommandsDelimiters.HierarchicalCommand */,
+            defaultCommandDelimiter: "|*" /* CommandsDelimiters.DefaultHierarchicalCommand */,
         };
         const extensionData = await this.$extensibilityService.getExtensionNameWhereCommandIsRegistered(commandInfo);
         if (extensionData) {
@@ -149,11 +154,13 @@ class CommandsService {
     async validateMandatoryParams(commandArguments, mandatoryParams) {
         const commandArgsHelper = new CommandArgumentsValidationHelper(true, commandArguments);
         if (mandatoryParams.length > 0) {
+            // If command has more mandatory params than the passed ones, we shouldn't execute it
             if (mandatoryParams.length > commandArguments.length) {
                 const customErrorMessages = _.map(mandatoryParams, (mp) => mp.errorMessage);
                 customErrorMessages.splice(0, 0, "You need to provide all the required parameters.");
                 this.$errors.failWithHelp(customErrorMessages.join(os_1.EOL));
             }
+            // If we reach here, the commandArguments are at least as much as mandatoryParams. Now we should verify that we have each of them.
             for (let mandatoryParamIndex = 0; mandatoryParamIndex < mandatoryParams.length; ++mandatoryParamIndex) {
                 const mandatoryParam = mandatoryParams[mandatoryParamIndex];
                 let argument = null;
@@ -180,12 +187,14 @@ class CommandsService {
         if (!commandArgsHelper.isValid) {
             return false;
         }
+        // Command doesn't have any allowedParameters
         if (!command.allowedParameters || command.allowedParameters.length === 0) {
             if (commandArguments.length > 0) {
                 this.$errors.failWithHelp("This command doesn't accept parameters.");
             }
         }
         else {
+            // Exclude mandatory params, we've already checked them
             const unverifiedAllowedParams = command.allowedParameters.filter((param) => !param.mandatory);
             for (let remainingArgsIndex = 0; remainingArgsIndex < commandArgsHelper.remainingArguments.length; ++remainingArgsIndex) {
                 const argument = commandArgsHelper.remainingArguments[remainingArgsIndex];
@@ -199,6 +208,7 @@ class CommandsService {
                 }
                 if (parameter) {
                     const index = unverifiedAllowedParams.indexOf(parameter);
+                    // Remove the matched parameter from unverifiedAllowedParams collection, so it will not be used to verify another argument.
                     unverifiedAllowedParams.splice(index, 1);
                 }
                 else {
@@ -243,3 +253,4 @@ class CommandsService {
 }
 exports.CommandsService = CommandsService;
 yok_1.injector.register("commandsService", CommandsService);
+//# sourceMappingURL=commands-service.js.map