nativescript 8.9.0-dev.0 → 8.9.0-dev.2

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

@@ -5,6 +5,15 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectConfigService = void 0;
 const constants = require("../constants");
@@ -35,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);
@@ -57,6 +67,7 @@ export default {
 } as NativeScriptConfig;`.trim();
     }
     warnUsingLegacyNSConfig() {
+        // todo: remove hack
         const isMigrate = _.get(this.$options, "argv._[0]") === "migrate";
         if (isMigrate) {
             return;
@@ -65,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;
@@ -94,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]}.`);
@@ -147,62 +160,65 @@ export default {
     getValue(key, defaultValue) {
         return _.get(this.readConfig(), key, defaultValue);
     }
-    async setValue(key, value) {
-        const { hasTSConfig, hasNSConfig, TSConfigPath, JSConfigPath, usingNSConfig, NSConfigPath, } = this.detectProjectConfigs();
-        const configFilePath = TSConfigPath || JSConfigPath;
-        if (this.forceUsingLegacyConfig ||
-            (usingNSConfig && !this.forceUsingNewConfig)) {
+    setValue(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { hasTSConfig, hasNSConfig, TSConfigPath, JSConfigPath, usingNSConfig, NSConfigPath, } = this.detectProjectConfigs();
+            const configFilePath = TSConfigPath || JSConfigPath;
+            if (this.forceUsingLegacyConfig ||
+                (usingNSConfig && !this.forceUsingNewConfig)) {
+                try {
+                    this.$logger.trace("Project Config Service -> setValue writing to legacy config.");
+                    const NSConfig = hasNSConfig ? this.$fs.readJson(NSConfigPath) : {};
+                    _.set(NSConfig, key, value);
+                    this.$fs.writeJson(NSConfigPath, NSConfig);
+                    return true;
+                }
+                catch (error) {
+                    this.$logger.trace(`Failed to setValue on legacy config. Error is ${error.message}`, error);
+                    return false;
+                }
+            }
+            if (!this.$fs.exists(configFilePath)) {
+                this.writeDefaultConfig(this.projectHelper.projectDir);
+            }
+            if (!Array.isArray(value) && typeof value === "object") {
+                let allSuccessful = true;
+                for (const prop of this.flattenObjectToPaths(value)) {
+                    if (!(yield this.setValue(prop.key, prop.value))) {
+                        allSuccessful = false;
+                    }
+                }
+                return allSuccessful;
+            }
+            const configContent = this.$fs.readText(configFilePath);
             try {
-                this.$logger.trace("Project Config Service -> setValue writing to legacy config.");
-                const NSConfig = hasNSConfig ? this.$fs.readJson(NSConfigPath) : {};
-                _.set(NSConfig, key, value);
-                this.$fs.writeJson(NSConfigPath, NSConfig);
-                return true;
+                const transformer = new config_transformer_1.ConfigTransformer(configContent);
+                const newContent = transformer.setValue(key, value);
+                const prettierOptions = (yield (0, prettier_1.resolveConfig)(this.projectHelper.projectDir, { editorconfig: true })) || {
+                    semi: false,
+                    singleQuote: true,
+                };
+                this.$logger.trace("updating config, prettier options: ", prettierOptions);
+                this.$fs.writeFile(configFilePath, (0, prettier_1.format)(newContent, Object.assign(Object.assign({}, prettierOptions), { parser: "typescript", 
+                    // note: we don't use plugins here, since we are only formatting ts files, and they are supported by default
+                    // and this also causes issues with certain plugins, like prettier-plugin-tailwindcss.
+                    plugins: [] })));
             }
             catch (error) {
-                this.$logger.trace(`Failed to setValue on legacy config. Error is ${error.message}`, error);
-                return false;
+                this.$logger.error(`Failed to update config.` + error);
             }
-        }
-        if (!this.$fs.exists(configFilePath)) {
-            this.writeDefaultConfig(this.projectHelper.projectDir);
-        }
-        if (typeof value === "object") {
-            let allSuccessful = true;
-            for (const prop of this.flattenObjectToPaths(value)) {
-                if (!(await this.setValue(prop.key, prop.value))) {
-                    allSuccessful = false;
+            finally {
+                // verify config is updated correctly
+                if (!Array.isArray(this.getValue(key)) && 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;
                 }
+                return true;
             }
-            return allSuccessful;
-        }
-        const configContent = this.$fs.readText(configFilePath);
-        try {
-            const transformer = new config_transformer_1.ConfigTransformer(configContent);
-            const newContent = transformer.setValue(key, value);
-            const prettierOptions = (await (0, prettier_1.resolveConfig)(this.projectHelper.projectDir, { editorconfig: true })) || {
-                semi: false,
-                singleQuote: true,
-            };
-            this.$logger.trace("updating config, prettier options: ", prettierOptions);
-            this.$fs.writeFile(configFilePath, await (0, prettier_1.format)(newContent, {
-                ...prettierOptions,
-                parser: "typescript",
-                plugins: [],
-            }));
-        }
-        catch (error) {
-            this.$logger.error(`Failed to update config.` + error);
-        }
-        finally {
-            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}`);
-                this.$fs.writeFile(configFilePath, configContent);
-                return false;
-            }
-            return true;
-        }
+        });
     }
     writeDefaultConfig(projectDir, appId) {
         const TSConfigPath = path.resolve(projectDir, constants_1.CONFIG_FILE_NAME_TS);
@@ -226,9 +242,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",
@@ -240,9 +258,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 &&
@@ -266,38 +286,55 @@ 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);
     }
-    async writeLegacyNSConfigIfNeeded(projectDir, runtimePackage) {
-        const { usingNSConfig } = this.detectProjectConfigs(projectDir);
-        if (usingNSConfig) {
-            return;
-        }
-        if (runtimePackage.version &&
-            semver.gte(semver.coerce(runtimePackage.version), "7.0.0-rc.5")) {
-            return;
-        }
-        const runtimePackageDisplay = `${runtimePackage.name}${runtimePackage.version ? " v" + runtimePackage.version : ""}`;
-        this.$logger.info();
-        this.$logger.printMarkdown(`
+    writeLegacyNSConfigIfNeeded(projectDir, runtimePackage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { usingNSConfig } = this.detectProjectConfigs(projectDir);
+            if (usingNSConfig) {
+                return;
+            }
+            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 : ""}`;
+            this.$logger.info();
+            this.$logger.printMarkdown(`
 Using __${runtimePackageDisplay}__ which requires \`nsconfig.json\` to be present.
 Writing \`nsconfig.json\` based on the values set in \`${constants_1.CONFIG_FILE_NAME_DISPLAY}\`.
 You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as necessary.`);
-        const nsConfigPath = path.join(projectDir || this.projectHelper.projectDir, "nsconfig.json");
-        this.$fs.writeJson(nsConfigPath, {
-            _info1: `Auto Generated for backwards compatibility with the currently used runtime.`,
-            _info2: `Do not edit this file manually, as any changes will be ignored.`,
-            _info3: `Config changes should be done in ${constants_1.CONFIG_FILE_NAME_DISPLAY} instead.`,
-            appPath: this.getValue("appPath"),
-            appResourcesPath: this.getValue("appResourcesPath"),
+            const nsConfigPath = path.join(projectDir || this.projectHelper.projectDir, "nsconfig.json");
+            this.$fs.writeJson(nsConfigPath, {
+                _info1: `Auto Generated for backwards compatibility with the currently used runtime.`,
+                _info2: `Do not edit this file manually, as any changes will be ignored.`,
+                _info3: `Config changes should be done in ${constants_1.CONFIG_FILE_NAME_DISPLAY} instead.`,
+                appPath: this.getValue("appPath"),
+                appResourcesPath: this.getValue("appResourcesPath"),
+            });
+            // mark the file for cleanup after the CLI exits
+            yield this.$cleanupService.addCleanupDeleteAction(nsConfigPath);
         });
-        await 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) => {
-            if (typeof obj[key] === "object") {
+            if (Array.isArray(obj[key])) {
+                return [
+                    ...all,
+                    {
+                        key: toPath(key),
+                        value: obj[key], // Preserve arrays as they are
+                    },
+                ];
+            }
+            else if (typeof obj[key] === "object" && obj[key] !== null) {
                 return [...all, ...this.flattenObjectToPaths(obj[key], toPath(key))];
             }
             return [
@@ -310,9 +347,8 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
         }, []);
     }
 }
-exports.ProjectConfigService = ProjectConfigService;
 __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")
@@ -323,4 +359,6 @@ __decorate([
 __decorate([
     (0, decorators_1.exported)("projectConfigService")
 ], ProjectConfigService.prototype, "setValue", null);
+exports.ProjectConfigService = ProjectConfigService;
 yok_1.injector.register("projectConfigService", ProjectConfigService);
+//# sourceMappingURL=project-config-service.js.map