nativescript 8.7.0-rc.1 → 8.7.0-rc.2

package/lib/services/plugins-service.js

@@ -64,6 +64,7 @@ class PluginsService {
             const realNpmPackageJson = this.$fs.readJson(pathToRealNpmPackageJson);
             if (realNpmPackageJson.nativescript) {
                 const pluginData = this.convertToPluginData(realNpmPackageJson, projectData.projectDir);
+                // Validate
                 const action = (pluginDestinationPath, platform, platformData) => __awaiter(this, void 0, void 0, function* () {
                     this.isPluginDataValidForPlatform(pluginData, platform, projectData);
                 });
@@ -152,6 +153,9 @@ class PluginsService {
                     paths: [projectData.projectDir],
                 });
                 if (pathToPackage) {
+                    // return false if the dependency is installed - we'll filter out boolean values
+                    // and end up with an array of dep names that are not installed if we end up
+                    // inside the catch block.
                     return false;
                 }
                 this.$logger.trace(`${dep} is not installed, or couldn't be found`);
@@ -187,6 +191,9 @@ class PluginsService {
         return productionPlugins
             .map((plugin) => this.convertToPluginData(plugin, projectData.projectDir))
             .filter((item, idx, self) => {
+            // Filter out duplicates to speed up build times by not building the same dependency
+            // multiple times. One possible downside is that if there are different versions
+            // of the same native dependency only the first one in the array will be built
             return self.findIndex((p) => p.name === item.name) === idx;
         });
     }
@@ -218,9 +225,11 @@ class PluginsService {
         const dependenciesGroupedByName = _.groupBy(productionDependencies, (p) => p.name);
         _.each(dependenciesGroupedByName, (dependencyOccurrences, dependencyName) => {
             if (dependencyOccurrences.length > 1) {
+                // the dependency exists multiple times in node_modules
                 const dependencyOccurrencesGroupedByVersion = _.groupBy(dependencyOccurrences, (g) => g.version);
                 const versions = _.keys(dependencyOccurrencesGroupedByVersion);
                 if (versions.length === 1) {
+                    // all dependencies with this name have the same version
                     this.$logger.trace(`Detected same versions (${_.first(versions)}) of the ${dependencyName} installed at locations: ${_.map(dependencyOccurrences, (d) => d.directory).join(", ")}`);
                 }
                 else {
@@ -246,9 +255,11 @@ class PluginsService {
             const dependenciesGroupedByFrameworkName = _.groupBy(dependenciesWithFrameworks, (d) => d.frameworkName);
             _.each(dependenciesGroupedByFrameworkName, (dependencyOccurrences, frameworkName) => {
                 if (dependencyOccurrences.length > 1) {
+                    // A framework exists multiple times in node_modules
                     const groupedByName = _.groupBy(dependencyOccurrences, (d) => d.name);
                     const pluginsNames = _.keys(groupedByName);
                     if (pluginsNames.length > 1) {
+                        // fail - the same framework is installed by different dependencies.
                         const locations = dependencyOccurrences.map((d) => d.frameworkLocation);
                         let msg = `Detected the framework ${frameworkName} is installed from multiple plugins at locations:\n${locations.join("\n")}\n`;
                         msg += this.getHelpMessage(projectDir);
@@ -258,6 +269,7 @@ class PluginsService {
                     const dependencyOccurrencesGroupedByVersion = _.groupBy(dependencyOccurrences, (g) => g.version);
                     const versions = _.keys(dependencyOccurrencesGroupedByVersion);
                     if (versions.length === 1) {
+                        // all dependencies with this name have the same version
                         this.$logger.warn(`Detected the framework ${frameworkName} is installed multiple times from the same versions of plugin (${_.first(versions)}) at locations: ${_.map(dependencyOccurrences, (d) => d.directory).join(", ")}`);
                         const selectedPackage = _.minBy(dependencyOccurrences, (d) => d.depth);
                         this.$logger.info(color_1.color.green(`CLI will use only the native code from '${selectedPackage.directory}'.`));
@@ -309,7 +321,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
             pluginData.isPlugin = !!cacheData.nativescript;
             pluginData.pluginPlatformsFolderPath = (platform) => {
                 if (this.$mobileHelper.isvisionOSPlatform(platform)) {
-                    platform = "ios";
+                    platform = "ios" /* constants.PlatformTypes.ios */;
                 }
                 return path.join(pluginData.fullPath, "platforms", platform.toLowerCase());
             };
@@ -366,6 +378,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
         return _.keys(require(packageJsonFilePath).dependencies);
     }
     getNodeModuleData(module, projectDir) {
+        // module can be  modulePath or moduleName
         if (!this.$fs.exists(module) || path.basename(module) !== "package.json") {
             module = this.getPackageJsonFilePathForModule(module, projectDir);
         }
@@ -403,7 +416,7 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
         });
     }
     parseNpmCommandResult(npmCommandResult) {
-        return npmCommandResult.split("@")[0];
+        return npmCommandResult.split("@")[0]; // returns plugin name
     }
     executeForAllInstalledPlatforms(action, projectData) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -420,6 +433,8 @@ This framework comes from ${dependencyName} plugin, which is installed multiple
     }
     getInstalledFrameworkVersion(platform, projectData) {
         const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, platform);
+        // const platformData = this.$platformsDataService.getPlatformData(platform, projectData);
+        // const frameworkData = this.$projectDataService.getNSValue(projectData.projectDir, platformData.frameworkPackageName);
         return runtimePackage.version;
     }
     isPluginDataValidForPlatform(pluginData, platform, projectData) {
@@ -475,3 +490,4 @@ PluginsService.LOCK_FILES = [
 ];
 exports.PluginsService = PluginsService;
 yok_1.injector.register("pluginsService", PluginsService);
+//# sourceMappingURL=plugins-service.js.map

package/lib/services/prepare-data-service.js

@@ -9,7 +9,7 @@ class PrepareDataService {
     }
     getPrepareData(projectDir, platform, data) {
         const platformLowerCase = platform.toLowerCase();
-        if (this.$mobileHelper.isApplePlatfrom(platform)) {
+        if (this.$mobileHelper.isApplePlatform(platform)) {
             return new prepare_data_1.IOSPrepareData(projectDir, platformLowerCase, data);
         }
         else if (this.$mobileHelper.isAndroidPlatform(platform)) {
@@ -19,3 +19,4 @@ class PrepareDataService {
 }
 exports.PrepareDataService = PrepareDataService;
 yok_1.injector.register("prepareDataService", PrepareDataService);
+//# sourceMappingURL=prepare-data-service.js.map

package/lib/services/project-backup-service.js

@@ -46,6 +46,7 @@ ProjectBackupService.Backup = class Backup {
                 backedUpPaths.push(pathToBackup);
             }
         }
+        // create backup.json
         this.$super.$fs.writeJson(path.resolve(this.backupDir, "_backup.json"), {
             name: this.name,
             paths: backedUpPaths,
@@ -66,6 +67,7 @@ ProjectBackupService.Backup = class Backup {
             }
         }
         this.$super.$logger.trace(backupData);
+        // restore files
         return this;
     }
     isUpToDate() {
@@ -75,6 +77,7 @@ ProjectBackupService.Backup = class Backup {
         }
         for (const pathToBackup of backupData.paths) {
             const sourcePath = path.resolve(this.backupDir, pathToBackup);
+            // if any of the files don't exist the backup is not up-to-date
             if (!this.$super.$fs.exists(sourcePath)) {
                 return false;
             }
@@ -112,3 +115,4 @@ ProjectBackupService.Backup = class Backup {
 };
 exports.ProjectBackupService = ProjectBackupService;
 yok_1.injector.register("projectBackupService", ProjectBackupService);
+//# sourceMappingURL=project-backup-service.js.map

package/lib/services/project-changes-service.js

@@ -73,6 +73,7 @@ class ProjectChangesService {
                     this._prepareInfo.projectFileHash = this.getProjectFileStrippedHash(projectData.projectDir, platformData);
                     this._changesInfo.nativeChanged = this.isProjectFileChanged(projectData.projectDir, platformData);
                 }
+                // If this causes too much rebuilds of the plugins or uncecessary builds for Android, move overrideCocoapods to prepareInfo.
                 this._changesInfo.nsConfigChanged = this.filesChanged([
                     path.join(projectData.projectDir, constants_1.CONFIG_FILE_NAME_JS),
                     path.join(projectData.projectDir, constants_1.CONFIG_FILE_NAME_TS),
@@ -156,7 +157,7 @@ class ProjectChangesService {
             this._prepareInfo = this._prepareInfo || this.getPrepareInfo(platformData);
             if (this._prepareInfo &&
                 addedPlatform.nativePlatformStatus ===
-                    "3") {
+                    "3" /* NativePlatformStatus.alreadyPrepared */) {
                 this._prepareInfo.nativePlatformStatus =
                     addedPlatform.nativePlatformStatus;
             }
@@ -182,8 +183,8 @@ class ProjectChangesService {
                 return false;
             }
             const nativePlatformStatus = !prepareData.nativePrepare || !prepareData.nativePrepare.skipNativePrepare
-                ? "2"
-                : "1";
+                ? "2" /* NativePlatformStatus.requiresPrepare */
+                : "1" /* NativePlatformStatus.requiresPlatformAdd */;
             this._prepareInfo = {
                 time: "",
                 nativePlatformStatus,
@@ -207,6 +208,13 @@ class ProjectChangesService {
         const projectFileContents = this.$fs.readJson(projectFilePath);
         const relevantProperties = ["dependencies"];
         const projectFileStrippedContents = _.pick(projectFileContents, relevantProperties);
+        // _(this.$devicePlatformsConstants)
+        // 	.keys()
+        // 	.map(k => k.toLowerCase())
+        // 	.difference([platformData.platformNameLowerCase])
+        // 	.each(otherPlatform => {
+        // 		delete projectFileContents.nativescript[`tns-${otherPlatform}`];
+        // 	});
         return (0, helpers_1.getHash)(JSON.stringify(projectFileStrippedContents));
     }
     isProjectFileChanged(projectDir, platformData) {
@@ -272,3 +280,4 @@ __decorate([
 ], ProjectChangesService.prototype, "checkForChanges", null);
 exports.ProjectChangesService = ProjectChangesService;
 yok_1.injector.register("projectChangesService", ProjectChangesService);
+//# sourceMappingURL=project-changes-service.js.map

package/lib/services/project-cleanup-service.js

@@ -38,6 +38,7 @@ class ProjectCleanupService {
                 success = success && cleanRes.ok;
             }
             if (!(options === null || options === void 0 ? void 0 : options.silent)) {
+                // required to print an empty line for the spinner to not replace the last status... (probably a bug in the spinners)
                 console.log();
             }
             if (stats) {
@@ -100,3 +101,4 @@ class ProjectCleanupService {
 }
 exports.ProjectCleanupService = ProjectCleanupService;
 yok_1.injector.register("projectCleanupService", ProjectCleanupService);
+//# sourceMappingURL=project-cleanup-service.js.map

package/lib/services/project-config-service.js

@@ -44,6 +44,7 @@ class ProjectConfigService {
         return (this.forceUsingLegacyConfig = force);
     }
     requireFromString(src, filename) {
+        // @ts-ignore
         const m = new module.constructor();
         m.paths = module.paths;
         m._compile(src, filename);
@@ -66,6 +67,7 @@ export default {
 } as NativeScriptConfig;`.trim();
     }
     warnUsingLegacyNSConfig() {
+        // todo: remove hack
         const isMigrate = _.get(this.$options, "argv._[0]") === "migrate";
         if (isMigrate) {
             return;
@@ -74,6 +76,7 @@ export default {
     }
     detectProjectConfigs(projectDir) {
         var _a;
+        // allow overriding config name with env variable or --config (or -c)
         let configName = (_a = process.env.NATIVESCRIPT_CONFIG_NAME) !== null && _a !== void 0 ? _a : this.$options.config;
         if (configName === "false") {
             configName = false;
@@ -103,6 +106,7 @@ export default {
         const existingConfigs = possibleConfigPaths.filter((path) => {
             return this.$fs.exists(path);
         });
+        // push the first possible config into the "existing" list
         const hasExistingConfig = !!existingConfigs.length;
         if (!hasExistingConfig) {
             this.$logger.trace(`No config file found - falling back to ${possibleConfigPaths[0]}.`);
@@ -201,9 +205,11 @@ export default {
                 this.$logger.error(`Failed to update config.` + error);
             }
             finally {
+                // verify config is updated correctly
                 if (this.getValue(key) !== value) {
                     this.$logger.error(`${os_1.EOL}Failed to update ${hasTSConfig ? constants_1.CONFIG_FILE_NAME_TS : constants_1.CONFIG_FILE_NAME_JS}.${os_1.EOL}`);
                     this.$logger.printMarkdown(`Please manually update \`${hasTSConfig ? constants_1.CONFIG_FILE_NAME_TS : constants_1.CONFIG_FILE_NAME_JS}\` and set \`${key}\` to \`${value}\`.${os_1.EOL}`);
+                    // restore original content
                     this.$fs.writeFile(configFilePath, configContent);
                     return false;
                 }
@@ -233,9 +239,11 @@ export default {
             ? this.$fs.readJson(info.NSConfigPath)
             : {};
         try {
+            // injecting here to avoid circular dependency
             const projectData = this.$injector.resolve("projectData");
             const embeddedPackageJsonPath = path.resolve(this.projectHelper.projectDir, projectData.getAppDirectoryRelativePath(), constants.PACKAGE_JSON_FILE_NAME);
             const embeddedPackageJson = this.$fs.readJson(embeddedPackageJsonPath);
+            // filter only the supported keys
             additionalData.push(_.pick(embeddedPackageJson, [
                 "android",
                 "ios",
@@ -247,9 +255,11 @@ export default {
         }
         catch (err) {
             this.$logger.trace("failed to add embedded package.json data to config", err);
+            // ignore if the file doesn't exist
         }
         try {
             const packageJson = this.$fs.readJson(path.join(this.projectHelper.projectDir, "package.json"));
+            // add app id to additionalData for backwards compatibility
             if (!NSConfig.id &&
                 packageJson &&
                 packageJson.nativescript &&
@@ -273,8 +283,10 @@ export default {
         }
         catch (err) {
             this.$logger.trace("failed to read package.json data for config", err);
+            // ignore if the file doesn't exist
         }
         return _.defaultsDeep({}, ...additionalData, NSConfig);
+        // return Object.assign({}, ...additionalData, NSConfig);
     }
     writeLegacyNSConfigIfNeeded(projectDir, runtimePackage) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -284,6 +296,8 @@ export default {
             }
             if (runtimePackage.version &&
                 semver.gte(semver.coerce(runtimePackage.version), "7.0.0-rc.5")) {
+                // runtimes >= 7.0.0-rc.5 support passing appPath and appResourcesPath through gradle project flags
+                // so writing an nsconfig is not necessary.
                 return;
             }
             const runtimePackageDisplay = `${runtimePackage.name}${runtimePackage.version ? " v" + runtimePackage.version : ""}`;
@@ -300,9 +314,11 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
                 appPath: this.getValue("appPath"),
                 appResourcesPath: this.getValue("appResourcesPath"),
             });
+            // mark the file for cleanup after the CLI exits
             yield this.$cleanupService.addCleanupDeleteAction(nsConfigPath);
         });
     }
+    // todo: move into config manipulation
     flattenObjectToPaths(obj, basePath) {
         const toPath = (key) => [basePath, key].filter(Boolean).join(".");
         return Object.keys(obj).reduce((all, key) => {
@@ -320,7 +336,7 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
     }
 }
 __decorate([
-    (0, decorators_1.cache)()
+    (0, decorators_1.cache)() // @cache should prevent the message being printed multiple times
 ], ProjectConfigService.prototype, "warnUsingLegacyNSConfig", null);
 __decorate([
     (0, decorators_1.exported)("projectConfigService")
@@ -333,3 +349,4 @@ __decorate([
 ], ProjectConfigService.prototype, "setValue", null);
 exports.ProjectConfigService = ProjectConfigService;
 yok_1.injector.register("projectConfigService", ProjectConfigService);
+//# sourceMappingURL=project-config-service.js.map

package/lib/services/project-data-service.js

@@ -36,12 +36,14 @@ class ProjectDataService {
         this.$injector = $injector;
         this.projectDataCache = {};
         try {
+            // add the ProjectData of the default projectDir to the projectData cache
             const projectData = this.$injector.resolve("projectData");
             projectData.initializeProjectData();
             this.defaultProjectDir = projectData.projectDir;
             this.projectDataCache[this.defaultProjectDir] = projectData;
         }
         catch (e) {
+            // the CLI is required as a lib from a non-project folder
         }
     }
     get $pluginsService() {
@@ -70,6 +72,8 @@ class ProjectDataService {
         delete projectFileInfo.projectData[ProjectDataService.DEPENDENCIES_KEY_NAME][dependencyName];
         this.$fs.writeJson(projectFileInfo.projectFilePath, projectFileInfo.projectData);
     }
+    // TODO: Add tests
+    // TODO: Remove $projectData and replace it with $projectDataService.getProjectData
     getProjectData(projectDir) {
         projectDir = projectDir || this.defaultProjectDir;
         this.projectDataCache[projectDir] =
@@ -126,6 +130,10 @@ class ProjectDataService {
     }
     getAndroidAssetsStructure(opts) {
         return __awaiter(this, void 0, void 0, function* () {
+            // TODO: Use image-size package to get the width and height of an image.
+            // TODO: Parse the splash_screen.xml in nodpi directory and get from it the names of the background and center image.
+            // TODO: Parse the AndroidManifest.xml to get the name of the icon.
+            // This way we'll not use the image-definitions.json and the method will return the real android structure.
             const projectDir = opts.projectDir;
             const projectData = this.getProjectData(projectDir);
             const pathToAndroidDir = path.join(projectData.appResourcesDirectoryPath, this.$devicePlatformsConstants.Android);
@@ -139,6 +147,7 @@ class ProjectDataService {
                 useLegacy = !manifest.includes(`android:icon="@mipmap/ic_launcher"`);
             }
             catch (err) {
+                // ignore
             }
             const content = this.getImageDefinitions()[useLegacy ? "android_legacy" : "android"];
             return {
@@ -163,6 +172,8 @@ class ProjectDataService {
             }
             if (fstat.isDirectory()) {
                 if (filePath === pathToProjectNodeModules) {
+                    // we do not want to get the files from node_modules directory of the project.
+                    // We'll get here only when you have nativescript.config with appDirectoryPath set to "."
                     return false;
                 }
                 return true;
@@ -177,6 +188,9 @@ class ProjectDataService {
         }
     }
     updateNsConfigValue(projectDir, updateObject, propertiesToRemove) {
+        // todo: figure out a way to update js/ts configs
+        // most likely needs an ast parser/writer
+        // should be delegated to the config service
         const nsConfigPath = path.join(projectDir, constants.CONFIG_FILE_NAME_JS);
         const currentNsConfig = this.getNsConfig(nsConfigPath);
         let newNsConfig = currentNsConfig;
@@ -218,10 +232,14 @@ class ProjectDataService {
             const imageDefinitions = this.getImageDefinitions().ios;
             _.each(content && content.images, (image) => {
                 let foundMatchingDefinition = false;
+                // In some cases the image may not be available, it will just be described.
+                // When this happens, the filename will be empty.
+                // So we'll keep the path empty as well.
                 if (image.filename) {
                     image.path = path.join(dirPath, image.filename);
                 }
                 if (image.size) {
+                    // size is basically <width>x<height>
                     const [width, height] = image.size
                         .toString()
                         .split(constants_1.AssetConstants.sizeDelimiter);
@@ -230,6 +248,7 @@ class ProjectDataService {
                         image.height = +height;
                     }
                 }
+                // Find the image size based on the hardcoded values in the image-definitions.json
                 _.each(imageDefinitions, (assetSubGroup) => {
                     const assetItem = _.find(assetSubGroup, (assetElement) => assetElement.filename === image.filename &&
                         path.basename(assetElement.directory) === path.basename(dirPath));
@@ -249,6 +268,7 @@ class ProjectDataService {
                         image.scale = image.scale || assetItem.scale;
                         image.rgba = assetItem.rgba;
                         finalContent.images.push(image);
+                        // break each
                         return false;
                     }
                 });
@@ -352,13 +372,16 @@ class ProjectDataService {
     getRuntimePackage(projectDir, platform) {
         platform = platform.toLowerCase();
         const packageJson = this.$fs.readJson(path.join(projectDir, constants.PACKAGE_JSON_FILE_NAME));
-        const runtimeName = platform === "android"
+        const runtimeName = platform === "android" /* PlatformTypes.android */
             ? constants.TNS_ANDROID_RUNTIME_NAME
             : constants.TNS_IOS_RUNTIME_NAME;
         if (packageJson &&
             packageJson.nativescript &&
             packageJson.nativescript[runtimeName] &&
             packageJson.nativescript[runtimeName].version) {
+            // if we have a nativescript key with a runtime version in package.json
+            // that means we are dealing with a legacy project, and should respect
+            // that information
             return {
                 name: runtimeName,
                 version: packageJson.nativescript[runtimeName].version,
@@ -370,19 +393,19 @@ class ProjectDataService {
         const runtimePackage = this.$pluginsService
             .getDependenciesFromPackageJson(projectDir)
             .devDependencies.find((d) => {
-            if (platform === "ios") {
+            if (platform === "ios" /* constants.PlatformTypes.ios */) {
                 return [
                     constants.SCOPED_IOS_RUNTIME_NAME,
                     constants.TNS_IOS_RUNTIME_NAME,
                 ].includes(d.name);
             }
-            else if (platform === "android") {
+            else if (platform === "android" /* constants.PlatformTypes.android */) {
                 return [
                     constants.SCOPED_ANDROID_RUNTIME_NAME,
                     constants.TNS_ANDROID_RUNTIME_NAME,
                 ].includes(d.name);
             }
-            else if (platform === "visionos") {
+            else if (platform === "visionos" /* constants.PlatformTypes.visionos */) {
                 return d.name === constants.SCOPED_VISIONOS_RUNTIME_NAME;
             }
         });
@@ -390,12 +413,14 @@ class ProjectDataService {
             const coerced = semver.coerce(runtimePackage.version);
             const isRange = !!coerced && coerced.version !== runtimePackage.version;
             const isTag = !coerced;
+            // in case we are using a local tgz for the runtime or a range like ~8.0.0, ^8.0.0 etc. or a tag like JSC
             if (runtimePackage.version.includes("tgz") || isRange || isTag) {
                 try {
                     const runtimePackageJsonPath = (0, package_path_helper_1.resolvePackageJSONPath)(runtimePackage.name, {
                         paths: [projectDir],
                     });
                     if (!runtimePackageJsonPath) {
+                        // caught below
                         throw new Error("Runtime package.json not found.");
                     }
                     runtimePackage.version = this.$fs.readJson(runtimePackageJsonPath).version;
@@ -412,20 +437,21 @@ class ProjectDataService {
             }
             return runtimePackage;
         }
+        // default to the scoped runtimes
         this.$logger.trace("Could not find an installed runtime, falling back to default runtimes");
-        if (platform === "ios") {
+        if (platform === "ios" /* constants.PlatformTypes.ios */) {
             return {
                 name: constants.SCOPED_IOS_RUNTIME_NAME,
                 version: null,
             };
         }
-        else if (platform === "android") {
+        else if (platform === "android" /* constants.PlatformTypes.android */) {
             return {
                 name: constants.SCOPED_ANDROID_RUNTIME_NAME,
                 version: null,
             };
         }
-        else if (platform === "visionos") {
+        else if (platform === "visionos" /* constants.PlatformTypes.visionos */) {
             return {
                 name: constants.SCOPED_VISIONOS_RUNTIME_NAME,
                 version: null,
@@ -459,9 +485,11 @@ __decorate([
             return projectDir + ":" + platform;
         },
         shouldCache(result) {
+            // don't cache coerced versions
             if (result._coerced) {
                 return false;
             }
+            // only cache if version is defined
             return !!result.version;
         },
     })
@@ -471,3 +499,4 @@ __decorate([
 ], ProjectDataService.prototype, "getNsConfigDefaultContent", null);
 exports.ProjectDataService = ProjectDataService;
 yok_1.injector.register("projectDataService", ProjectDataService);
+//# sourceMappingURL=project-data-service.js.map

package/lib/services/project-name-service.js

@@ -65,3 +65,4 @@ class ProjectNameService {
 }
 exports.ProjectNameService = ProjectNameService;
 yok_1.injector.register("projectNameService", ProjectNameService);
+//# sourceMappingURL=project-name-service.js.map

package/lib/services/project-service.js

@@ -76,11 +76,15 @@ class ProjectService {
                 appId: appId,
                 projectName,
             });
+            // can pass --no-git to skip creating a git repo
+            // useful in monorepos where we're creating
+            // sub projects in an existing git repo.
             if (this.$options.git) {
                 try {
                     if (!this.$options.force) {
                         const git = (0, simple_git_1.default)(projectDir);
                         if (yield git.checkIsRepo()) {
+                            // throwing here since we're catching below.
                             throw new Error("Already part of a git repository.");
                         }
                     }
@@ -122,6 +126,7 @@ class ProjectService {
                 this.alterPackageJsonData(projectCreationSettings);
                 this.$projectConfigService.writeDefaultConfig(projectDir, appId);
                 yield this.ensureAppResourcesExist(projectDir);
+                // Install devDependencies and execute all scripts:
                 yield this.$packageManager.install(projectDir, projectDir, {
                     disableNpmInstall: false,
                     frameworkPath: null,
@@ -155,6 +160,7 @@ class ProjectService {
                 this.$logger.trace("Project does not have App_Resources - fetching from default template.");
                 this.$fs.createDirectory(appResourcesDestinationPath);
                 const tempDir = yield this.$tempService.mkdirSync("ns-default-template");
+                // the template installed doesn't have App_Resources -> get from a default template
                 yield this.$pacoteService.extractPackage(constants.RESERVED_TEMPLATE_NAMES["default"], tempDir);
                 const templateProjectData = this.$projectDataService.getProjectData(tempDir);
                 const templateAppResourcesDir = templateProjectData.getAppResourcesDirectoryPath(tempDir);
@@ -166,12 +172,14 @@ class ProjectService {
         const { projectDir, projectName } = projectCreationSettings;
         const projectFilePath = path.join(projectDir, this.$staticConfig.PROJECT_FILE_NAME);
         let packageJsonData = this.$fs.readJson(projectFilePath);
+        // clean up keys from the template package.json that we don't care about.
         Object.keys(packageJsonData).forEach((key) => {
             if (key.startsWith("_") ||
                 constants.TemplatesV2PackageJsonKeysToRemove.includes(key)) {
                 delete packageJsonData[key];
             }
         });
+        // this is used to ensure the order of keys is consistent, the blanks are filled in from the template
         const packageJsonSchema = {
             name: projectName,
             main: "",
@@ -179,6 +187,7 @@ class ProjectService {
             private: true,
             dependencies: {},
             devDependencies: {},
+            // anythign else would go below
         };
         packageJsonData = Object.assign(packageJsonSchema, packageJsonData);
         this.$fs.writeJson(projectFilePath, packageJsonData);
@@ -202,3 +211,4 @@ __decorate([
 ], ProjectService.prototype, "alterPackageJsonData", null);
 exports.ProjectService = ProjectService;
 yok_1.injector.register("projectService", ProjectService);
+//# sourceMappingURL=project-service.js.map

package/lib/services/project-templates-service.js

@@ -50,12 +50,12 @@ class ProjectTemplatesService {
             const templateNameToBeTracked = this.getTemplateNameToBeTracked(templateValue, templatePackageJsonContent);
             if (templateNameToBeTracked) {
                 yield this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Create project",
+                    action: "Create project" /* constants.TrackActionNames.CreateProject */,
                     isForDevice: null,
                     additionalData: templateNameToBeTracked,
                 });
                 yield this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Using Template",
+                    action: "Using Template" /* constants.TrackActionNames.UsingTemplate */,
                     additionalData: templateNameToBeTracked,
                 });
             }
@@ -112,3 +112,4 @@ __decorate([
 ], ProjectTemplatesService.prototype, "prepareTemplate", null);
 exports.ProjectTemplatesService = ProjectTemplatesService;
 yok_1.injector.register("projectTemplatesService", ProjectTemplatesService);
+//# sourceMappingURL=project-templates-service.js.map

package/lib/services/qr-code-terminal-service.js

@@ -18,3 +18,4 @@ class QrCodeTerminalService {
 }
 exports.QrCodeTerminalService = QrCodeTerminalService;
 yok_1.injector.register("qrCodeTerminalService", QrCodeTerminalService);
+//# sourceMappingURL=qr-code-terminal-service.js.map

package/lib/services/require-service.js

@@ -9,3 +9,4 @@ class RequireService {
 }
 exports.RequireService = RequireService;
 yok_1.injector.register("requireService", RequireService);
+//# sourceMappingURL=require-service.js.map

package/lib/services/start-service.js

@@ -114,3 +114,4 @@ class StartService {
 }
 exports.default = StartService;
 yok_1.injector.register("startService", StartService);
+//# sourceMappingURL=start-service.js.map

package/lib/services/temp-service.js

@@ -34,3 +34,4 @@ class TempService {
 }
 exports.TempService = TempService;
 yok_1.injector.register("tempService", TempService);
+//# sourceMappingURL=temp-service.js.map

package/lib/services/terminal-spinner-service.js

@@ -14,6 +14,7 @@ const ora = require("ora");
 const yok_1 = require("../common/yok");
 class TerminalSpinnerService {
     createSpinner(spinnerOptions = {}) {
+        // @ts-expect-error - options are readonly, however we still want to override them before passing them on...
         spinnerOptions.stream = spinnerOptions.stream || process.stdout;
         return ora(spinnerOptions);
     }
@@ -36,3 +37,4 @@ class TerminalSpinnerService {
 }
 exports.TerminalSpinnerService = TerminalSpinnerService;
 yok_1.injector.register("terminalSpinnerService", TerminalSpinnerService);
+//# sourceMappingURL=terminal-spinner-service.js.map