microsoft/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2025-12-10 00:48:23 -06:00
Code Issues Packages Projects Releases 138 Wiki Activity

Use a different schema for each branding (#15856)

Browse Source 
Switch the schema depending on the branding we're being built for

Ever since we started writing the entire settings file out ourselves,
we've had the opportunity to control which schema it uses.

This is a quality-of-life improvement for Preview users, and might make
life easier for Dev users as well.

For Debug builds, it even switches over to a local `file://` path to
the schema in the source directory!

Closes #6601
This commit is contained in:
Dustin L. Howett 2023-08-22 05:39:14 -05:00 committed by GitHub
parent 21c2dee50a
commit 333fcd89b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp
View File

@ -1227,6 +1227,15 @@ void CascadiaSettings::WriteSettingsToDisk()
}
}
#ifndef NDEBUG
static [[maybe_unused]] std::string _getDevPathToSchema()
{
std::filesystem::path filePath{ __FILE__ };
auto schemaPath = filePath.parent_path().parent_path().parent_path().parent_path() / "doc" / "cascadia" / "profiles.schema.json";
return "file:///" + schemaPath.generic_string();
}
#endif
// Method Description:
// - Create a new serialized JsonObject from an instance of this class
// Arguments:
@ -1238,7 +1247,17 @@ Json::Value CascadiaSettings::ToJson() const
// top-level json object
auto json{ _globals->ToJson() };
json["$help"] = "https://aka.ms/terminal-documentation";
json["$schema"] = "https://aka.ms/terminal-profiles-schema";
json["$schema"] =
#if defined(WT_BRANDING_RELEASE)
"https://aka.ms/terminal-profiles-schema"
#elif defined(WT_BRANDING_PREVIEW)
"https://aka.ms/terminal-profiles-schema-preview"
#elif !defined(NDEBUG) // DEBUG mode
_getDevPathToSchema() // magic schema path that refers to the local source directory
#else // All other brandings
"https://raw.githubusercontent.com/microsoft/terminal/main/doc/cascadia/profiles.schema.json"
#endif
;
// "profiles" will always be serialized as an object
Json::Value profiles{ Json::ValueType::objectValue };