Remove embedded configuration warning. (#1766)

BillyONeal · web-flow · commit 4f3755971c89 · 2025-09-08T12:37:20.000-07:00
diff --git a/azure-pipelines/e2e-projects/e2e-registry-templates/removed.json.in b/azure-pipelines/e2e-projects/e2e-registry-templates/removed.json.in
@@ -1,5 +1,5 @@
 {
-  "vcpkg-configuration": {
+  "configuration": {
     "default-registry": {
       "kind": "git",
       "baseline": "$E2ERegistryBaseline",
diff --git a/docs/vcpkg.schema.json b/docs/vcpkg.schema.json
@@ -90,6 +90,10 @@
         "supports": {
           "$ref": "vcpkg-schema-definitions.schema.json#/definitions/platform-expression"
         },
+        "configuration": {
+          "description": "Embedded vcpkg.configuration.json file.",
+          "$ref": "vcpkg-configuration.schema.json"
+        },
         "vcpkg-configuration": {
           "description": "Embedded vcpkg.configuration.json file.",
           "$ref": "vcpkg-configuration.schema.json"
@@ -102,6 +106,21 @@
     },
     {
       "$ref": "vcpkg-schema-definitions.schema.json#/definitions/has-zero-or-one-version"
+    },
+    {
+      "description": "Only one of configuration or vcpkg-configuration may be used. (They are aliases of the same field)",
+      "if": {
+        "required": [
+          "configuration"
+        ]
+      },
+      "then": {
+        "not": {
+          "required": [
+            "vcpkg-configuration"
+          ]
+        }
+      }
     }
   ]
-}
+}
diff --git a/include/vcpkg/base/contractual-constants.h b/include/vcpkg/base/contractual-constants.h
@@ -30,6 +30,7 @@ namespace vcpkg
     inline constexpr StringLiteral JsonIdCacheCapitalSize = "cacheSize";
     inline constexpr StringLiteral JsonIdChecksums = "checksums";
     inline constexpr StringLiteral JsonIdComment = "comment";
+    inline constexpr StringLiteral JsonIdConfiguration = "configuration";
     inline constexpr StringLiteral JsonIdContacts = "contacts";
     inline constexpr StringLiteral JsonIdCorrelator = "correlator";
     inline constexpr StringLiteral JsonIdCreated = "created";
diff --git a/include/vcpkg/base/message-data.inc.h b/include/vcpkg/base/message-data.inc.h
@@ -136,11 +136,11 @@ DECLARE_MESSAGE(AlreadyInstalled, (msg::spec), "", "{spec} is already installed"
 DECLARE_MESSAGE(AManifest, (), "", "a manifest")
 DECLARE_MESSAGE(AMaximumOfOneAssetReadUrlCanBeSpecified, (), "", "a maximum of one asset read url can be specified.")
 DECLARE_MESSAGE(AMaximumOfOneAssetWriteUrlCanBeSpecified, (), "", "a maximum of one asset write url can be specified.")
-DECLARE_MESSAGE(AmbiguousConfigDeleteConfigFile,
-                (msg::path),
+DECLARE_MESSAGE(AmbiguousConfig,
+                (msg::json_field),
                 "",
-                "Ambiguous vcpkg configuration provided by both manifest and configuration file.\n-- Delete "
-                "configuration file {path}")
+                "Ambiguous vcpkg configuration provided by both manifest and configuration file. Choose one by "
+                "deleting this file or deleting \"{json_field}\" from the manifest file.")
 DECLARE_MESSAGE(AnArtifactsGitRegistryUrl, (), "", "an artifacts git registry URL")
 DECLARE_MESSAGE(AnArtifactsRegistry, (), "", "an artifacts registry")
 DECLARE_MESSAGE(AnArrayOfDefaultFeatures, (), "", "an array of default features")
@@ -920,6 +920,10 @@ DECLARE_MESSAGE(ConfigurationNestedDemands,
                 (msg::json_field),
                 "",
                 "[\"{json_field}\"] contains a nested `demands` object (nested `demands` have no effect)")
+DECLARE_MESSAGE(ConflictingEmbeddedConfiguration,
+                (),
+                "",
+                "only one of {{\"configuration\", \"vcpkg-configuration\"}} may be used")
 DECLARE_MESSAGE(ConflictingFiles,
                 (msg::path, msg::spec),
                 "",
@@ -1013,10 +1017,6 @@ DECLARE_MESSAGE(
 DECLARE_MESSAGE(DefaultFeatureIdentifier, (), "", "the names of default features must be identifiers")
 DECLARE_MESSAGE(DefaultFlag, (msg::option), "", "Defaulting to --{option} being on.")
 DECLARE_MESSAGE(DefaultRegistryIsArtifact, (), "", "The default registry cannot be an artifact registry.")
-DECLARE_MESSAGE(DeleteVcpkgConfigFromManifest,
-                (msg::path),
-                "",
-                "-- Or remove \"vcpkg-configuration\" from the manifest file {path}.")
 DECLARE_MESSAGE(
     DependencyFeatureCore,
     (),
@@ -1133,10 +1133,6 @@ DECLARE_MESSAGE(DuplicatePackagePatternRegistry, (msg::url), "", "registry: {url
 DECLARE_MESSAGE(ElapsedForPackage, (msg::spec, msg::elapsed), "", "Elapsed time to handle {spec}: {elapsed}")
 DECLARE_MESSAGE(ElapsedTimeForChecks, (msg::elapsed), "", "Time to determine pass/fail: {elapsed}")
 DECLARE_MESSAGE(EmailVcpkgTeam, (msg::url), "", "Send an email to {url} with any feedback.")
-DECLARE_MESSAGE(EmbeddingVcpkgConfigInManifest,
-                (),
-                "",
-                "Embedding `vcpkg-configuration` in a manifest file is an EXPERIMENTAL feature.")
 DECLARE_MESSAGE(EmptyLicenseExpression, (), "", "SPDX license expression was empty.")
 DECLARE_MESSAGE(EndOfStringInCodeUnit, (), "", "found end of string in middle of code point")
 DECLARE_MESSAGE(EnvInvalidMaxConcurrency,
@@ -2125,6 +2121,7 @@ DECLARE_MESSAGE(LoadingDependencyInformation,
                 "",
                 "Loading dependency information for {count} packages...")
 DECLARE_MESSAGE(LocalPortfileVersion, (), "", "Using local port versions. To update the local ports, use `git pull`.")
+DECLARE_MESSAGE(ManifestHere, (), "", "the manifest file is here")
 DECLARE_MESSAGE(ManifestConflict2, (), "", "Found both a manifest and CONTROL files; please rename one or the other")
 DECLARE_MESSAGE(ManifestFormatCompleted, (), "", "Succeeded in formatting the manifest files.")
 DECLARE_MESSAGE(MismatchedBinParagraphs,
diff --git a/include/vcpkg/configuration.h b/include/vcpkg/configuration.h
@@ -64,12 +64,8 @@ namespace vcpkg
         static View<StringView> known_fields();
     };
 
-    enum class ConfigurationSource
-    {
-        None,
-        VcpkgConfigurationFile,
-        ManifestFile,
-    };
+    StringLiteral configuration_source_file_name(ConfigurationSource source);
+    StringLiteral configuration_source_field(ConfigurationSource source);
 
     struct ConfigurationAndSource
     {
@@ -87,6 +83,7 @@ namespace vcpkg
     {
         Optional<std::string> builtin_baseline;
         Optional<Configuration> config;
+        ConfigurationSource config_source = ConfigurationSource::None;
     };
 
     extern const Json::IDeserializer<Configuration>& configuration_deserializer;
diff --git a/include/vcpkg/fwd/configuration.h b/include/vcpkg/fwd/configuration.h
@@ -6,4 +6,12 @@ namespace vcpkg
     struct ConfigurationAndSource;
     struct RegistryConfig;
     struct ManifestConfiguration;
+
+    enum class ConfigurationSource
+    {
+        None,
+        VcpkgConfigurationFile,
+        ManifestFileVcpkgConfiguration,
+        ManifestFileConfiguration
+    };
 }
diff --git a/include/vcpkg/sourceparagraph.h b/include/vcpkg/sourceparagraph.h
@@ -188,7 +188,9 @@ namespace vcpkg
         ParsedSpdxLicenseDeclaration license;
 
         Optional<std::string> builtin_baseline;
-        Optional<Json::Object> vcpkg_configuration;
+
+        Optional<Json::Object> configuration;
+        ConfigurationSource configuration_source = ConfigurationSource::None;
         // Currently contacts is only a Json::Object but it will eventually be unified with maintainers
         Json::Object contacts;
 
diff --git a/locales/messages.json b/locales/messages.json
@@ -119,8 +119,8 @@
   "_AllShasValid.comment": "sha = sha512 of url",
   "AlreadyInstalled": "{spec} is already installed",
   "_AlreadyInstalled.comment": "An example of {spec} is zlib:x64-windows.",
-  "AmbiguousConfigDeleteConfigFile": "Ambiguous vcpkg configuration provided by both manifest and configuration file.\n-- Delete configuration file {path}",
-  "_AmbiguousConfigDeleteConfigFile.comment": "An example of {path} is /foo/bar.",
+  "AmbiguousConfig": "Ambiguous vcpkg configuration provided by both manifest and configuration file. Choose one by deleting this file or deleting \"{json_field}\" from the manifest file.",
+  "_AmbiguousConfig.comment": "An example of {json_field} is identifer.",
   "AnArrayOfDefaultFeatures": "an array of default features",
   "AnArrayOfDependencies": "an array of dependencies",
   "AnArrayOfDependencyOverrides": "an array of dependency overrides",
@@ -536,6 +536,7 @@
   "_ConfigurationErrorRegistriesWithoutBaseline.comment": "An example of {path} is /foo/bar. An example of {url} is https://github.com/microsoft/vcpkg.",
   "ConfigurationNestedDemands": "[\"{json_field}\"] contains a nested `demands` object (nested `demands` have no effect)",
   "_ConfigurationNestedDemands.comment": "An example of {json_field} is identifer.",
+  "ConflictingEmbeddedConfiguration": "only one of {{\"configuration\", \"vcpkg-configuration\"}} may be used",
   "ConflictingFiles": "The following files are already installed in {path} and are in conflict with {spec}",
   "_ConflictingFiles.comment": "An example of {path} is /foo/bar. An example of {spec} is zlib:x64-windows.",
   "ConsideredVersions": "The following executables were considered but discarded because of the version requirement of {version}:",
@@ -589,8 +590,6 @@
   "DefaultFlag": "Defaulting to --{option} being on.",
   "_DefaultFlag.comment": "An example of {option} is editable.",
   "DefaultRegistryIsArtifact": "The default registry cannot be an artifact registry.",
-  "DeleteVcpkgConfigFromManifest": "-- Or remove \"vcpkg-configuration\" from the manifest file {path}.",
-  "_DeleteVcpkgConfigFromManifest.comment": "An example of {path} is /foo/bar.",
   "DependencyFeatureCore": "the feature \"core\" cannot be in a dependency's feature list. To turn off default features, add \"default-features\": false instead.",
   "_DependencyFeatureCore.comment": "The word \"core\" is an on-disk name that must not be localized. The \"default-features\" part is JSON syntax that must be copied verbatim into the user's file.",
   "DependencyFeatureDefault": "the feature \"default\" cannot be in a dependency's feature list. To turn on default features, add \"default-features\": true instead.",
@@ -673,7 +672,6 @@
   "_ElapsedTimeForChecks.comment": "An example of {elapsed} is 3.532 min.",
   "EmailVcpkgTeam": "Send an email to {url} with any feedback.",
   "_EmailVcpkgTeam.comment": "An example of {url} is https://github.com/microsoft/vcpkg.",
-  "EmbeddingVcpkgConfigInManifest": "Embedding `vcpkg-configuration` in a manifest file is an EXPERIMENTAL feature.",
   "EmptyLicenseExpression": "SPDX license expression was empty.",
   "EndOfStringInCodeUnit": "found end of string in middle of code point",
   "EnvInvalidMaxConcurrency": "{env_var} is {value}, must be > 0",
@@ -1172,6 +1170,7 @@
   "LocalPortfileVersion": "Using local port versions. To update the local ports, use `git pull`.",
   "ManifestConflict2": "Found both a manifest and CONTROL files; please rename one or the other",
   "ManifestFormatCompleted": "Succeeded in formatting the manifest files.",
+  "ManifestHere": "the manifest file is here",
   "MismatchedBinParagraphs": "The serialized binary paragraph was different from the original binary paragraph. Please open an issue at https://github.com/microsoft/vcpkg with the following output:",
   "MismatchedFiles": "file to store does not match hash",
   "MismatchedManifestAfterReserialize": "The serialized manifest was different from the original manifest. Please open an issue at https://github.com/microsoft/vcpkg, with the following output:",
diff --git a/src/vcpkg-test/manifests.cpp b/src/vcpkg-test/manifests.cpp
@@ -103,7 +103,7 @@ TEST_CASE ("manifest construct minimum", "[manifests]")
     REQUIRE(pgh.core_paragraph->description.empty());
     REQUIRE(pgh.core_paragraph->dependencies.empty());
     REQUIRE(!pgh.core_paragraph->builtin_baseline.has_value());
-    REQUIRE(!pgh.core_paragraph->vcpkg_configuration.has_value());
+    REQUIRE(!pgh.core_paragraph->configuration.has_value());
 
     REQUIRE(pgh.check_against_feature_flags({}, feature_flags_without_versioning));
 
@@ -136,7 +136,7 @@ TEST_CASE ("project manifest construct minimum", "[manifests]")
     REQUIRE(pgh.core_paragraph->description.empty());
     REQUIRE(pgh.core_paragraph->dependencies.empty());
     REQUIRE(!pgh.core_paragraph->builtin_baseline.has_value());
-    REQUIRE(!pgh.core_paragraph->vcpkg_configuration.has_value());
+    REQUIRE(!pgh.core_paragraph->configuration.has_value());
 
     // name might not be present:
     REQUIRE(project_manifest_is_parsable(R"json({
@@ -873,6 +873,93 @@ TEST_CASE ("manifest embed configuration", "[manifests]")
         ]
     })json";
 
+    std::string raw = Strings::concat(R"json({
+    "configuration": )json",
+                                      raw_config,
+                                      R"json(,
+    "name": "zlib",
+    "version": "1.0.0",
+    "builtin-baseline": "089fa4de7dca22c67dcab631f618d5cd0697c8d4",
+    "dependencies": [
+        "a",
+        {
+            "$extra": null,
+            "name": "b"
+        },
+        {
+            "name": "c",
+            "version>=": "2018-09-01"
+        }
+    ]
+})json");
+    auto m_pgh = test_parse_port_manifest(raw);
+
+    REQUIRE(m_pgh.has_value());
+    auto& pgh = **m_pgh.get();
+    REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_without_versioning));
+    REQUIRE(pgh.check_against_feature_flags({}, feature_flags_with_versioning));
+
+    auto maybe_as_json = Json::parse(raw, "test");
+    REQUIRE(maybe_as_json.has_value());
+    auto as_json = *maybe_as_json.get();
+    check_json_eq(Json::Value::object(serialize_manifest(pgh)), as_json.value);
+
+    REQUIRE(pgh.core_paragraph->builtin_baseline == "089fa4de7dca22c67dcab631f618d5cd0697c8d4");
+    REQUIRE(pgh.core_paragraph->dependencies.size() == 3);
+    REQUIRE(pgh.core_paragraph->dependencies[0].name == "a");
+    REQUIRE(pgh.core_paragraph->dependencies[0].constraint == DependencyConstraint{});
+    REQUIRE(pgh.core_paragraph->dependencies[1].name == "b");
+    REQUIRE(pgh.core_paragraph->dependencies[1].constraint == DependencyConstraint{});
+    REQUIRE(pgh.core_paragraph->dependencies[2].name == "c");
+    REQUIRE(pgh.core_paragraph->dependencies[2].constraint ==
+            DependencyConstraint{VersionConstraintKind::Minimum, Version{"2018-09-01", 0}});
+
+    auto config = Json::parse(raw_config, "<test config>").value(VCPKG_LINE_INFO).value;
+    REQUIRE(config.is_object());
+    auto config_obj = config.object(VCPKG_LINE_INFO);
+    REQUIRE(pgh.core_paragraph->configuration.has_value());
+    auto parsed_config_obj = *pgh.core_paragraph->configuration.get();
+    REQUIRE(Json::stringify(parsed_config_obj) == Json::stringify(config_obj));
+    REQUIRE(pgh.core_paragraph->configuration_source == ConfigurationSource::ManifestFileConfiguration);
+}
+
+TEST_CASE ("manifest embed vcpkg_configuration", "[manifests]")
+{
+    std::string raw_config = R"json({
+        "$extra-info": null,
+        "default-registry": {
+            "kind": "builtin",
+            "baseline": "089fa4de7dca22c67dcab631f618d5cd0697c8d4"
+        },
+        "registries": [
+            {
+                "kind": "filesystem",
+                "path": "a/b/c",
+                "baseline": "default",
+                "packages": [
+                    "a",
+                    "b",
+                    "c"
+                ]
+            },
+            {
+                "kind": "git",
+                "repository": "https://github.com/microsoft/vcpkg-ports",
+                "baseline": "089fa4de7dca22c67dcab631f618d5cd0697c8d4",
+                "packages": [ 
+                    "zlib",
+                    "rapidjson",
+                    "fmt"
+                ]
+            },
+            {
+                "kind": "artifact",
+                "name": "vcpkg-artifacts",
+                "location": "https://github.com/microsoft/vcpkg-artifacts"
+            }
+        ]
+    })json";
+
     std::string raw = Strings::concat(R"json({
     "vcpkg-configuration": )json",
                                       raw_config,
@@ -917,9 +1004,10 @@ TEST_CASE ("manifest embed configuration", "[manifests]")
     auto config = Json::parse(raw_config, "<test config>").value(VCPKG_LINE_INFO).value;
     REQUIRE(config.is_object());
     auto config_obj = config.object(VCPKG_LINE_INFO);
-    REQUIRE(pgh.core_paragraph->vcpkg_configuration.has_value());
-    auto parsed_config_obj = *pgh.core_paragraph->vcpkg_configuration.get();
+    REQUIRE(pgh.core_paragraph->configuration.has_value());
+    auto parsed_config_obj = *pgh.core_paragraph->configuration.get();
     REQUIRE(Json::stringify(parsed_config_obj) == Json::stringify(config_obj));
+    REQUIRE(pgh.core_paragraph->configuration_source == ConfigurationSource::ManifestFileVcpkgConfiguration);
 }
 
 TEST_CASE ("manifest construct maximum", "[manifests]")
diff --git a/src/vcpkg/commands.new.cpp b/src/vcpkg/commands.new.cpp
@@ -171,7 +171,8 @@ namespace vcpkg
                 // no existing configuration, so create one with out-of-the-box registries
                 break;
             case ConfigurationSource::VcpkgConfigurationFile:
-            case ConfigurationSource::ManifestFile:
+            case ConfigurationSource::ManifestFileVcpkgConfiguration:
+            case ConfigurationSource::ManifestFileConfiguration:
                 // reuse existing configuration
                 configuration = current_configuration.config;
                 break;
diff --git a/src/vcpkg/commands.update-baseline.cpp b/src/vcpkg/commands.update-baseline.cpp
@@ -126,16 +126,26 @@ namespace vcpkg
             update_baseline_in_config(paths, reg);
         }
 
-        if (configuration.source == ConfigurationSource::ManifestFile)
+        switch (configuration.source)
         {
-            manifest.manifest.insert_or_replace(JsonIdVcpkgConfiguration, configuration.config.serialize());
-        }
-
-        if (!dry_run && configuration.source == ConfigurationSource::VcpkgConfigurationFile)
-        {
-            paths.get_filesystem().write_contents(configuration.directory / FileVcpkgConfigurationDotJson,
-                                                  Json::stringify(configuration.config.serialize()),
-                                                  VCPKG_LINE_INFO);
+            case ConfigurationSource::None:
+                // nothing to do
+                break;
+            case ConfigurationSource::ManifestFileVcpkgConfiguration:
+                manifest.manifest.insert_or_replace(JsonIdVcpkgConfiguration, configuration.config.serialize());
+                break;
+            case ConfigurationSource::ManifestFileConfiguration:
+                manifest.manifest.insert_or_replace(JsonIdConfiguration, configuration.config.serialize());
+                break;
+            case ConfigurationSource::VcpkgConfigurationFile:
+                if (!dry_run)
+                {
+                    paths.get_filesystem().write_contents(configuration.directory / FileVcpkgConfigurationDotJson,
+                                                          Json::stringify(configuration.config.serialize()),
+                                                          VCPKG_LINE_INFO);
+                }
+                break;
+            default: Checks::unreachable(VCPKG_LINE_INFO);
         }
 
         if (!dry_run && has_manifest)
diff --git a/src/vcpkg/configuration.cpp b/src/vcpkg/configuration.cpp
diff --git a/src/vcpkg/sourceparagraph.cpp b/src/vcpkg/sourceparagraph.cpp
diff --git a/src/vcpkg/vcpkgpaths.cpp b/src/vcpkg/vcpkgpaths.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "vcpkg-configuration": {`
	`2`	`+ "configuration": {`
`3`	`3`	`"default-registry": {`
`4`	`4`	`"kind": "git",`
`5`	`5`	`"baseline": "$E2ERegistryBaseline",`