diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2020-06-16 15:43:50 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2020-06-18 09:09:56 +0200 |
commit | fc045e12a953aac88b942c25b958c5c0554b252b (patch) | |
tree | ad8e171d0730f55eb9a531c1a9f0a8dfb51065ad /common | |
parent | 9679023f2b0d7c55b70f23fd94603f301a841079 (diff) |
Rename taxonomy kinds from taxonomy to term, taxonomyTerm to taxonomy
And we have taken great measures to limit potential site breakage:
* For `disableKinds` and `outputs` we try to map from old to new values if possible, if not we print an ERROR that can be toggled off if not relevant.
* The layout lookup is mostly compatible with more options for the new `term` kind.
That leaves:
* Where queries in site.Pages using taxonomy/taxonomyTerm Kind values as filter.
* Other places where these kind value are used in the templates (classes etc.)
Fixes #6911
Fixes #7395
Diffstat (limited to 'common')
-rw-r--r-- | common/constants/constants.go | 21 | ||||
-rw-r--r-- | common/loggers/ignorableLogger.go | 52 |
2 files changed, 73 insertions, 0 deletions
diff --git a/common/constants/constants.go b/common/constants/constants.go new file mode 100644 index 000000000..25bd7c758 --- /dev/null +++ b/common/constants/constants.go @@ -0,0 +1,21 @@ +// Copyright 2020 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package constants + +// Error IDs. +// Do not change these values. +const ( + ErrIDAmbigousDisableKindTaxonomy = "error-disable-taxonomy" + ErrIDAmbigousOutputKindTaxonomy = "error-output-taxonomy" +) diff --git a/common/loggers/ignorableLogger.go b/common/loggers/ignorableLogger.go new file mode 100644 index 000000000..e12e41d68 --- /dev/null +++ b/common/loggers/ignorableLogger.go @@ -0,0 +1,52 @@ +// Copyright 2020 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package loggers + +import ( + "fmt" + "strings" +) + +// IgnorableLogger is a logger that ignores certain log statements. +type IgnorableLogger struct { + logger *Logger + statements map[string]bool +} + +// NewIgnorableLogger wraps the given logger and ignores the log statement IDs given. +func NewIgnorableLogger(logger *Logger, statements ...string) IgnorableLogger { + statementsSet := make(map[string]bool) + for _, s := range statements { + statementsSet[strings.ToLower(s)] = true + + } + return IgnorableLogger{ + logger: logger, + statements: statementsSet, + } +} + +func (l IgnorableLogger) Errorf(statementID, format string, v ...interface{}) { + if l.statements[statementID] { + // Ignore. + return + } + ignoreMsg := fmt.Sprintf(` +If you feel that this should not be logged as an ERROR, you can ignore it by adding this to your site config: +ignoreErrors = [%q]`, statementID) + + format += ignoreMsg + + l.logger.ERROR.Printf(format, v...) +} |