Font Spec #4842

ryfu-msft · 2024-10-01T15:34:16Z

Related to #166

Adds the initial font specification document. This outlines the planned implementation for supporting fonts. This will be updated to match the actual implementation.

Microsoft Reviewers: Open in CodeFlow

mdanish-kh · 2024-10-01T16:50:15Z

doc/specs/#166 - Font Support.md

+
+If a user specifies a specific name such as : 
+
+`winget fonts list --name 'Arial'`


Will this support a substring match like winget list? Can I do something like winget fonts list --name 'Nerd Font' (display all nerd fonts installed on my system) or winget fonts list 'Italic' (list out all italic fonts)?

Or also --version, --exact, etc.

I am thinking of creating an index in memory that we can use to better search the installed fonts like the examples you have above.

doc/specs/#166 - Font Support.md

JohnMcPMS · 2024-10-01T18:43:58Z

doc/specs/#166 - Font Support.md

+
+### Font File Types
+
+This feature will support font files with the following file types:


From our talks, do we actually need to specify the file types that are supported? It seemed like we could support whatever font formats Windows supports with no additional work per-type.

This is just for general knowledge, I don't plan to do anything different based on file type. Installation support will be based on the results from IdWriteFontFile::Analyze

doc/specs/#166 - Font Support.md

JohnMcPMS · 2024-10-01T19:08:32Z

doc/specs/#166 - Font Support.md

+---
+
+### 1. Initial Validation
+Winget will check that `effectiveInstallerType == font` before kicking off the font installation flow.


I don't think that this check is necessary. My expectation is that we:

Have a separate source for fonts, marked as explicit

winget fonts install is the same as winget install -s winget-fonts (or whatever the name of the source is).

The actual workflow is identical post source selection; the font installer type is not special.

The goal is logically separate fonts for our repository.

Updated spec to align with this. Made sure to call out that the workflow should not change post source selection.

JohnMcPMS · 2024-10-01T20:17:31Z

doc/specs/#166 - Font Support.md

+
+`winget fonts uninstall --name 'Baskerville Old Face'`
+
+Winget will uninstall a font family with a single font face without any warnings.


A warning should only be generated when the set of things being removed would be larger than the set of things requested to be removed. Specifying a single face might require removing multiple faces or families because they are all in the same file. This applies to all uninstall command permutations.

So generally:

determine the set of files that back the target

determine the set of faces that this will remove

if there are faces outside of the target, warn and require --force

Updated spec to align with above.

doc/specs/#166 - Font Support.md

JohnMcPMS · 2024-10-01T20:25:19Z

doc/specs/#166 - Font Support.md

+
+4. **Uninstalling a font face that shares the same font file as another font face:**
+
+`winget fonts uninstall --name 'Arial' --font-face 'Bold'`


I don't understand how this example and example 1 exist together. It doesn't seem like name has a consistent meaning across these commands.

I realized that using a font family that includes the word 'face' was slightly confusing...

I've updated the arguments to more accurately reflect the difference between --family-name and --face-name

doc/specs/#166 - Font Support.md

denelon · 2024-10-02T21:30:23Z

From a PowerShell point of view are we thinking something like: WinGetFont as the Object type as opposed to a WinGetPackage?

JohnMcPMS · 2024-10-02T21:56:52Z

From a PowerShell point of view are we thinking something like: WinGetFont as the Object type as opposed to a WinGetPackage?

I would prefer not to have to create an entire COM and PowerShell interface that is 90% the same with different names. That does mean a slant mapping of faces to versions. But version can be used to describe different flavors of things, and faces of fonts are just versions of the primary theme. So it still fits, somewhat.

Trenly · 2024-10-03T19:20:12Z

doc/specs/#166 - Font Support.md

+> Font types will not be treated differently. Support for font installation will be determined by calling [IDWriteFontFile::Analyze](https://learn.microsoft.com/en-us/windows/win32/api/dwrite/nf-dwrite-idwritefontfile-analyze).
+
+### Installing Fonts
+Typically, a user would download the font file and drag it to the `C:\Windows\Fonts` directory in the explorer view, but there are a couple things happening behind the scenes.


Does the drag and drop flow trigger the same endpoints as double clicking the file in File Explorer? Just trying to understand if all the current methods of installing fonts end up at the same place

Trenly · 2024-10-03T19:23:32Z

doc/specs/#166 - Font Support.md

+
+
+## Manifest Changes
+- Addition of `font` to `installerType` and `nestedInstallerType`


Is there any way for the manifest to specify the font name and not just the path to it? Thinking of a use case where the file is something like ARandomFont.ttf when it the name of the font is actually something like Really Awesome Font

I believe that the font files contain face and family metadata already and we are planning to always use that. If that is not always the case, then we do probably need a way to specify the name. The registry value names don't appear to have any actual impact on the enumerated fonts (from what I remember of @ryfu-msft investigation), but maybe they are important in the event that the file doesn't contain the relevant metadata.

Trenly · 2024-10-03T19:26:00Z

doc/specs/#166 - Font Support.md

+
+If a user specifies a specific name such as : 
+
+`winget fonts list --name 'Arial'`


Or also --version, --exact, etc.

Trenly · 2024-10-03T19:28:56Z

doc/specs/#166 - Font Support.md

+
+### 1. Selection From Font Source
+Font source:
+There will be a separate source specifically for fonts. This source will be marked as explicit. The workflows following font source selection will be the same as if an executable package was selected. A user will be enter the following commands and experience the same behavior of installing a font.


How will this new source interact with the GPO for allowed / disallowed sources?

Good question for @denelon

The new source was just my thought on how we would separate the data and keep the index size from growing. My expectation is that it would respect configured policy just the same, but the question is whether it would be in the umbrella of some existing controls or not (the one that controls the winget source for example).

Trenly · 2024-10-03T19:31:01Z

doc/specs/#166 - Font Support.md

+
+## CLI Behavior / Implementation Details
+
+New Command: `winget fonts`


Will there be any new GPO to prevent the installation of fonts, or uninstallation of specific fonts?

Thinking about how an enterprise could use a custom standard font for all of their branding / marketing and would want to ensure that users at the company can't uninstall it using WinGet

Also, how will this interact with existing Font GPOs, if at all?

ryfu-msft added 4 commits September 18, 2024 14:06

add initial file for font spec

82001af

add more info

7e4d0cc

update font spec

6f29e8f

clean up font spec

aae5df0

ryfu-msft requested a review from a team as a code owner October 1, 2024 15:34

ryfu-msft marked this pull request as draft October 1, 2024 15:34

This comment has been minimized.

Sign in to view

mdanish-kh reviewed Oct 1, 2024

View reviewed changes

JohnMcPMS reviewed Oct 1, 2024

View reviewed changes

mdanish-kh reviewed Oct 2, 2024

View reviewed changes

doc/specs/#166 - Font Support.md Outdated Show resolved Hide resolved

ryfu-msft added 2 commits October 2, 2024 13:29

address feedback

525b902

add spelling

26b69db

This comment has been minimized.

Sign in to view

spelling

91f932b

Trenly reviewed Oct 3, 2024

View reviewed changes

ryfu-msft mentioned this pull request Oct 16, 2024

Add experimental feature for font list command #4886

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Font Spec #4842

Font Spec #4842

ryfu-msft commented Oct 1, 2024 •

edited by microsoft-github-policy-service bot

Loading

This comment has been minimized.

mdanish-kh Oct 1, 2024

Trenly Oct 3, 2024

ryfu-msft Oct 3, 2024

JohnMcPMS Oct 1, 2024

ryfu-msft Oct 3, 2024

JohnMcPMS Oct 1, 2024

ryfu-msft Oct 3, 2024

JohnMcPMS Oct 1, 2024

ryfu-msft Oct 3, 2024

JohnMcPMS Oct 1, 2024

ryfu-msft Oct 3, 2024

This comment has been minimized.

denelon commented Oct 2, 2024

JohnMcPMS commented Oct 2, 2024

Trenly Oct 3, 2024

Trenly Oct 3, 2024

JohnMcPMS Oct 3, 2024

Trenly Oct 3, 2024

Trenly Oct 3, 2024

JohnMcPMS Oct 3, 2024

Trenly Oct 3, 2024

Trenly Oct 3, 2024


		If a user specifies a specific name such as :

		`winget fonts list --name 'Arial'`


		### Font File Types

		This feature will support font files with the following file types:


		`winget fonts uninstall --name 'Baskerville Old Face'`

		Winget will uninstall a font family with a single font face without any warnings.


		4. Uninstalling a font face that shares the same font file as another font face:

		`winget fonts uninstall --name 'Arial' --font-face 'Bold'`



		## Manifest Changes
		- Addition of `font` to `installerType` and `nestedInstallerType`


		## CLI Behavior / Implementation Details

		New Command: `winget fonts`

Font Spec #4842

Are you sure you want to change the base?

Font Spec #4842

Conversation

ryfu-msft commented Oct 1, 2024 • edited by microsoft-github-policy-service bot Loading

Microsoft Reviewers: Open in CodeFlow

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

denelon commented Oct 2, 2024

JohnMcPMS commented Oct 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryfu-msft commented Oct 1, 2024 •

edited by microsoft-github-policy-service bot

Loading