TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-10-29 07:09:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

cmd/viewer: add field comments to generated view methods

Browse Source 
Extract field comments from AST and include them in generated view
methods. Comments are preserved from the original struct fields to
provide documentation for the view accessors.

Fixes #16958

Signed-off-by: Maisem Ali <3953239+maisem@users.noreply.github.com>
This commit is contained in:
Maisem Ali
2025-08-27 00:06:28 -07:00
committed by Brad Fitzpatrick
parent 80f5a00e76
commit 882b05fff9
10 changed files with 1383 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
types/prefs/prefs_example/prefs_example_view.go
View File

@@ -89,38 +89,68 @@ func (v *PrefsView) UnmarshalJSONFrom(dec *jsontext.Decoder) error {
return nil
}
func (v PrefsView) ControlURL() prefs.Item[string] { return v.ж.ControlURL }
func (v PrefsView) RouteAll() prefs.Item[bool] { return v.ж.RouteAll }
func (v PrefsView) ExitNodeID() prefs.Item[tailcfg.StableNodeID] { return v.ж.ExitNodeID }
func (v PrefsView) ExitNodeIP() prefs.Item[netip.Addr] { return v.ж.ExitNodeIP }
func (v PrefsView) ExitNodePrior() tailcfg.StableNodeID { return v.ж.ExitNodePrior }
func (v PrefsView) ExitNodeAllowLANAccess() prefs.Item[bool] { return v.ж.ExitNodeAllowLANAccess }
func (v PrefsView) CorpDNS() prefs.Item[bool] { return v.ж.CorpDNS }
func (v PrefsView) RunSSH() prefs.Item[bool] { return v.ж.RunSSH }
func (v PrefsView) RunWebClient() prefs.Item[bool] { return v.ж.RunWebClient }
func (v PrefsView) WantRunning() prefs.Item[bool] { return v.ж.WantRunning }
func (v PrefsView) LoggedOut() prefs.Item[bool] { return v.ж.LoggedOut }
func (v PrefsView) ShieldsUp() prefs.Item[bool] { return v.ж.ShieldsUp }
func (v PrefsView) AdvertiseTags() prefs.ListView[string] { return v.ж.AdvertiseTags.View() }
func (v PrefsView) Hostname() prefs.Item[string] { return v.ж.Hostname }
func (v PrefsView) NotepadURLs() prefs.Item[bool] { return v.ж.NotepadURLs }
func (v PrefsView) ForceDaemon() prefs.Item[bool] { return v.ж.ForceDaemon }
func (v PrefsView) Egg() prefs.Item[bool] { return v.ж.Egg }
func (v PrefsView) ControlURL() prefs.Item[string] { return v.ж.ControlURL }
func (v PrefsView) RouteAll() prefs.Item[bool] { return v.ж.RouteAll }
func (v PrefsView) ExitNodeID() prefs.Item[tailcfg.StableNodeID] { return v.ж.ExitNodeID }
func (v PrefsView) ExitNodeIP() prefs.Item[netip.Addr] { return v.ж.ExitNodeIP }
// ExitNodePrior is an internal state rather than a preference.
// It can be kept in the Prefs structure but should not be wrapped
// and is ignored by the [prefs] package.
func (v PrefsView) ExitNodePrior() tailcfg.StableNodeID { return v.ж.ExitNodePrior }
func (v PrefsView) ExitNodeAllowLANAccess() prefs.Item[bool] { return v.ж.ExitNodeAllowLANAccess }
func (v PrefsView) CorpDNS() prefs.Item[bool] { return v.ж.CorpDNS }
func (v PrefsView) RunSSH() prefs.Item[bool] { return v.ж.RunSSH }
func (v PrefsView) RunWebClient() prefs.Item[bool] { return v.ж.RunWebClient }
func (v PrefsView) WantRunning() prefs.Item[bool] { return v.ж.WantRunning }
func (v PrefsView) LoggedOut() prefs.Item[bool] { return v.ж.LoggedOut }
func (v PrefsView) ShieldsUp() prefs.Item[bool] { return v.ж.ShieldsUp }
// AdvertiseTags is a preference whose value is a slice of strings.
// The value is atomic, and individual items in the slice should
// not be modified after the preference is set.
// Since the item type (string) is immutable, we can use [prefs.List].
func (v PrefsView) AdvertiseTags() prefs.ListView[string] { return v.ж.AdvertiseTags.View() }
func (v PrefsView) Hostname() prefs.Item[string] { return v.ж.Hostname }
func (v PrefsView) NotepadURLs() prefs.Item[bool] { return v.ж.NotepadURLs }
func (v PrefsView) ForceDaemon() prefs.Item[bool] { return v.ж.ForceDaemon }
func (v PrefsView) Egg() prefs.Item[bool] { return v.ж.Egg }
// AdvertiseRoutes is a preference whose value is a slice of netip.Prefix.
// The value is atomic, and individual items in the slice should
// not be modified after the preference is set.
// Since the item type (netip.Prefix) is immutable, we can use [prefs.List].
func (v PrefsView) AdvertiseRoutes() prefs.ListView[netip.Prefix] { return v.ж.AdvertiseRoutes.View() }
func (v PrefsView) NoSNAT() prefs.Item[bool] { return v.ж.NoSNAT }
func (v PrefsView) NoStatefulFiltering() prefs.Item[opt.Bool] { return v.ж.NoStatefulFiltering }
func (v PrefsView) NetfilterMode() prefs.Item[preftype.NetfilterMode] { return v.ж.NetfilterMode }
func (v PrefsView) OperatorUser() prefs.Item[string] { return v.ж.OperatorUser }
func (v PrefsView) ProfileName() prefs.Item[string] { return v.ж.ProfileName }
func (v PrefsView) AutoUpdate() AutoUpdatePrefs { return v.ж.AutoUpdate }
func (v PrefsView) AppConnector() AppConnectorPrefs { return v.ж.AppConnector }
func (v PrefsView) PostureChecking() prefs.Item[bool] { return v.ж.PostureChecking }
func (v PrefsView) NetfilterKind() prefs.Item[string] { return v.ж.NetfilterKind }
// AutoUpdate contains auto-update preferences.
// Each preference in the group can be configured and managed individually.
func (v PrefsView) AutoUpdate() AutoUpdatePrefs { return v.ж.AutoUpdate }
// AppConnector contains app connector-related preferences.
// Each preference in the group can be configured and managed individually.
func (v PrefsView) AppConnector() AppConnectorPrefs { return v.ж.AppConnector }
func (v PrefsView) PostureChecking() prefs.Item[bool] { return v.ж.PostureChecking }
func (v PrefsView) NetfilterKind() prefs.Item[string] { return v.ж.NetfilterKind }
// DriveShares is a preference whose value is a slice of *[drive.Share].
// The value is atomic, and individual items in the slice should
// not be modified after the preference is set.
// Since the item type (*drive.Share) is mutable and implements [views.ViewCloner],
// we need to use [prefs.StructList] instead of [prefs.List].
func (v PrefsView) DriveShares() prefs.StructListView[*drive.Share, drive.ShareView] {
return prefs.StructListViewOf(&v.ж.DriveShares)
}
func (v PrefsView) AllowSingleHosts() prefs.Item[marshalAsTrueInJSON] { return v.ж.AllowSingleHosts }
func (v PrefsView) Persist() persist.PersistView { return v.ж.Persist.View() }
// Persist is an internal state rather than a preference.
// It can be kept in the Prefs structure but should not be wrapped
// and is ignored by the [prefs] package.
func (v PrefsView) Persist() persist.PersistView { return v.ж.Persist.View() }
// A compilation failure here means this code must be regenerated, with the command at the top of this file.
var _PrefsViewNeedsRegeneration = Prefs(struct {

7
types/prefs/prefs_view_test.go
View File

@@ -95,6 +95,9 @@ func (v TestPrefsView) AddrItem() Item[netip.Addr] { return v.ж.A
func (v TestPrefsView) StringStringMap() MapView[string, string] { return v.ж.StringStringMap.View() }
func (v TestPrefsView) IntStringMap() MapView[int, string] { return v.ж.IntStringMap.View() }
func (v TestPrefsView) AddrIntMap() MapView[netip.Addr, int] { return v.ж.AddrIntMap.View() }
// Bundles are complex preferences that usually consist of
// multiple parameters that must be configured atomically.
func (v TestPrefsView) Bundle1() ItemView[*TestBundle, TestBundleView] {
return ItemViewOf(&v.ж.Bundle1)
}
@@ -116,6 +119,10 @@ func (v TestPrefsView) IntBundleMap() StructMapView[int, *TestBundle, TestBundle
func (v TestPrefsView) AddrBundleMap() StructMapView[netip.Addr, *TestBundle, TestBundleView] {
return StructMapViewOf(&v.ж.AddrBundleMap)
}
// Group is a nested struct that contains one or more preferences.
// Each preference in a group can be configured individually.
// Preference groups should be included directly rather than by pointers.
func (v TestPrefsView) Group() TestPrefsGroup { return v.ж.Group }
// A compilation failure here means this code must be regenerated, with the command at the top of this file.