Skip to content

question: Struct tags for deprecated fields #868

@jmooring

Description

@jmooring

This should have a very low priority...

We have a documentation utility that generates a YAML file with default configurations for various features, including all of the minify settings:

https://gohugo.io/configuration/minify/

On that page we have these notes for the user:

css.inline is for internal use. Changing this setting has no effect.
css.keepCSS2 has been deprecated. Use css.version instead.
html.keepConditionalComments has been deprecated. Use html.keepSpecialComments instead.
svg.inline is for internal use. Changing this setting has no effect.

I was wondering if you would be willing to add struct tags to the exported fields that are deprecated and to those fields that are for internal (at least from our perspective) use. For example:

// Minifier is a CSS minifier.
type Minifier struct {
	KeepCSS2     bool `json:"-"`
	Precision    int
	newPrecision int
	Inline       bool `json:"-"`
	Version      int
}

I'm not sure if that approach would have unintended consequences for other downstream projects, so this deserves some thought.

We have another (somewhat ugly) way to handle this, so again, this should have a low priority.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions