From 8157c4c4a83538ab7762334d6dd382cb2a0c9025 Mon Sep 17 00:00:00 2001 From: "Rostislav M. Georgiev" Date: Wed, 24 Jul 2019 17:20:51 +0300 Subject: [PATCH] Remove unused package //pkg/util/normalizer Signed-off-by: Rostislav M. Georgiev --- go.mod | 2 - hack/.golint_failures | 1 - pkg/util/BUILD | 1 - pkg/util/normalizer/BUILD | 29 ------ pkg/util/normalizer/markdown.go | 151 ------------------------------ pkg/util/normalizer/normalizer.go | 80 ---------------- 6 files changed, 264 deletions(-) delete mode 100644 pkg/util/normalizer/BUILD delete mode 100644 pkg/util/normalizer/markdown.go delete mode 100644 pkg/util/normalizer/normalizer.go diff --git a/go.mod b/go.mod index abc4677c8dc..bac97403c60 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,6 @@ require ( github.com/Azure/go-autorest v11.1.2+incompatible github.com/GoogleCloudPlatform/k8s-cloud-provider v0.0.0-20181220005116-f8e995905100 github.com/JeffAshton/win_pdh v0.0.0-20161109143554-76bb4ee9f0ab - github.com/MakeNowJust/heredoc v0.0.0-20170808103936-bb23615498cd github.com/Microsoft/go-winio v0.4.11 github.com/Microsoft/hcsshim v0.8.6 github.com/PuerkitoBio/purell v1.1.1 @@ -120,7 +119,6 @@ require ( github.com/prometheus/common v0.0.0-20181126121408-4724e9255275 github.com/quobyte/api v0.1.2 github.com/robfig/cron v1.1.0 - github.com/russross/blackfriday v1.5.2 github.com/seccomp/libseccomp-golang v0.9.1 // indirect github.com/sigma/go-inotify v0.0.0-20181102212354-c87b6cf5033d github.com/smartystreets/goconvey v0.0.0-20190330032615-68dc04aab96a // indirect diff --git a/hack/.golint_failures b/hack/.golint_failures index 51f0711ab39..94e98833ae7 100644 --- a/hack/.golint_failures +++ b/hack/.golint_failures @@ -279,7 +279,6 @@ pkg/util/iptables pkg/util/iptables/testing pkg/util/labels pkg/util/mount -pkg/util/normalizer pkg/util/oom pkg/util/procfs pkg/util/removeall diff --git a/pkg/util/BUILD b/pkg/util/BUILD index a6e224aaa1e..0373818fd4d 100644 --- a/pkg/util/BUILD +++ b/pkg/util/BUILD @@ -36,7 +36,6 @@ filegroup( "//pkg/util/mount:all-srcs", "//pkg/util/netsh:all-srcs", "//pkg/util/node:all-srcs", - "//pkg/util/normalizer:all-srcs", "//pkg/util/oom:all-srcs", "//pkg/util/parsers:all-srcs", "//pkg/util/pod:all-srcs", diff --git a/pkg/util/normalizer/BUILD b/pkg/util/normalizer/BUILD deleted file mode 100644 index 41637f99a9c..00000000000 --- a/pkg/util/normalizer/BUILD +++ /dev/null @@ -1,29 +0,0 @@ -load("@io_bazel_rules_go//go:def.bzl", "go_library") - -go_library( - name = "go_default_library", - srcs = [ - "markdown.go", - "normalizer.go", - ], - importpath = "k8s.io/kubernetes/pkg/util/normalizer", - visibility = ["//visibility:public"], - deps = [ - "//vendor/github.com/MakeNowJust/heredoc:go_default_library", - "//vendor/github.com/russross/blackfriday:go_default_library", - ], -) - -filegroup( - name = "package-srcs", - srcs = glob(["**"]), - tags = ["automanaged"], - visibility = ["//visibility:private"], -) - -filegroup( - name = "all-srcs", - srcs = [":package-srcs"], - tags = ["automanaged"], - visibility = ["//visibility:public"], -) diff --git a/pkg/util/normalizer/markdown.go b/pkg/util/normalizer/markdown.go deleted file mode 100644 index 3f064d07354..00000000000 --- a/pkg/util/normalizer/markdown.go +++ /dev/null @@ -1,151 +0,0 @@ -/* -Copyright 2016 The Kubernetes Authors. - -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. -*/ - -/* -This file is copied from /pkg/kubectl/cmd/templates/markdown.go -In a future PR we should remove the original copy and use -/pkg/util/normalizer everywhere. -*/ - -package normalizer - -import ( - "bytes" - "fmt" - "strings" - - "github.com/russross/blackfriday" -) - -const linebreak = "\n" - -// ASCIIRenderer implements blackfriday.Renderer -var _ blackfriday.Renderer = &ASCIIRenderer{} - -// ASCIIRenderer is a blackfriday.Renderer intended for rendering markdown -// documents as plain text, well suited for human reading on terminals. -type ASCIIRenderer struct { - Indentation string - - listItemCount uint - listLevel uint -} - -// NormalText gets a text chunk *after* the markdown syntax was already -// processed and does a final cleanup on things we don't expect here, like -// removing linebreaks on things that are not a paragraph break (auto unwrap). -func (r *ASCIIRenderer) NormalText(out *bytes.Buffer, text []byte) { - raw := string(text) - lines := strings.Split(raw, linebreak) - for _, line := range lines { - trimmed := strings.Trim(line, " \n\t") - out.WriteString(trimmed) - out.WriteString(" ") - } -} - -// List renders the start and end of a list. -func (r *ASCIIRenderer) List(out *bytes.Buffer, text func() bool, flags int) { - r.listLevel++ - out.WriteString(linebreak) - text() - r.listLevel-- -} - -// ListItem renders list items and supports both ordered and unordered lists. -func (r *ASCIIRenderer) ListItem(out *bytes.Buffer, text []byte, flags int) { - if flags&blackfriday.LIST_ITEM_BEGINNING_OF_LIST != 0 { - r.listItemCount = 1 - } else { - r.listItemCount++ - } - indent := strings.Repeat(r.Indentation, int(r.listLevel)) - var bullet string - if flags&blackfriday.LIST_TYPE_ORDERED != 0 { - bullet += fmt.Sprintf("%d.", r.listItemCount) - } else { - bullet += "*" - } - out.WriteString(indent + bullet + " ") - r.fw(out, text) - out.WriteString(linebreak) -} - -// Paragraph renders the start and end of a paragraph. -func (r *ASCIIRenderer) Paragraph(out *bytes.Buffer, text func() bool) { - out.WriteString(linebreak) - text() - out.WriteString(linebreak) -} - -// BlockCode renders a chunk of text that represents source code. -func (r *ASCIIRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string) { - out.WriteString(linebreak) - lines := []string{} - for _, line := range strings.Split(string(text), linebreak) { - indented := r.Indentation + line - lines = append(lines, indented) - } - out.WriteString(strings.Join(lines, linebreak)) -} - -func (r *ASCIIRenderer) GetFlags() int { return 0 } -func (r *ASCIIRenderer) HRule(out *bytes.Buffer) { - out.WriteString(linebreak + "----------" + linebreak) -} -func (r *ASCIIRenderer) LineBreak(out *bytes.Buffer) { out.WriteString(linebreak) } -func (r *ASCIIRenderer) TitleBlock(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) Header(out *bytes.Buffer, text func() bool, level int, id string) { text() } -func (r *ASCIIRenderer) BlockHtml(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) BlockQuote(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) TableRow(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) TableHeaderCell(out *bytes.Buffer, text []byte, align int) { r.fw(out, text) } -func (r *ASCIIRenderer) TableCell(out *bytes.Buffer, text []byte, align int) { r.fw(out, text) } -func (r *ASCIIRenderer) Footnotes(out *bytes.Buffer, text func() bool) { text() } -func (r *ASCIIRenderer) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int) { r.fw(out, text) } -func (r *ASCIIRenderer) AutoLink(out *bytes.Buffer, link []byte, kind int) { r.fw(out, link) } -func (r *ASCIIRenderer) CodeSpan(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) DoubleEmphasis(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) Emphasis(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) RawHtmlTag(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) TripleEmphasis(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) StrikeThrough(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) FootnoteRef(out *bytes.Buffer, ref []byte, id int) { r.fw(out, ref) } -func (r *ASCIIRenderer) Entity(out *bytes.Buffer, entity []byte) { r.fw(out, entity) } -func (r *ASCIIRenderer) Smartypants(out *bytes.Buffer, text []byte) { r.fw(out, text) } -func (r *ASCIIRenderer) DocumentHeader(out *bytes.Buffer) {} -func (r *ASCIIRenderer) DocumentFooter(out *bytes.Buffer) {} -func (r *ASCIIRenderer) TocHeaderWithAnchor(text []byte, level int, anchor string) {} -func (r *ASCIIRenderer) TocHeader(text []byte, level int) {} -func (r *ASCIIRenderer) TocFinalize() {} - -func (r *ASCIIRenderer) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int) { - r.fw(out, header, body) -} - -func (r *ASCIIRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) { - r.fw(out, link) -} - -func (r *ASCIIRenderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) { - r.fw(out, link) -} - -func (r *ASCIIRenderer) fw(out *bytes.Buffer, text ...[]byte) { - for _, t := range text { - out.Write(t) - } -} diff --git a/pkg/util/normalizer/normalizer.go b/pkg/util/normalizer/normalizer.go deleted file mode 100644 index 28179f70b17..00000000000 --- a/pkg/util/normalizer/normalizer.go +++ /dev/null @@ -1,80 +0,0 @@ -/* -Copyright 2016 The Kubernetes Authors. - -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. -*/ - -/* -This file is copied from /pkg/kubectl/cmd/templates/normalizer.go -In a future PR we should remove the original copy and use -/pkg/util/normalizer everywhere. -*/ - -package normalizer - -import ( - "strings" - - "github.com/MakeNowJust/heredoc" - "github.com/russross/blackfriday" -) - -const indentation = ` ` - -// LongDesc normalizes a command's long description to follow the conventions. -func LongDesc(s string) string { - if len(s) == 0 { - return s - } - return normalizer{s}.Heredoc().Markdown().Trim().string -} - -// Examples normalizes a command's examples to follow the conventions. -func Examples(s string) string { - if len(s) == 0 { - return s - } - return normalizer{s}.Trim().Indent().string -} - -type normalizer struct { - string -} - -func (s normalizer) Markdown() normalizer { - bytes := []byte(s.string) - formatted := blackfriday.Markdown(bytes, &ASCIIRenderer{Indentation: indentation}, 0) - s.string = string(formatted) - return s -} - -func (s normalizer) Heredoc() normalizer { - s.string = heredoc.Doc(s.string) - return s -} - -func (s normalizer) Trim() normalizer { - s.string = strings.TrimSpace(s.string) - return s -} - -func (s normalizer) Indent() normalizer { - indentedLines := []string{} - for _, line := range strings.Split(s.string, "\n") { - trimmed := strings.TrimSpace(line) - indented := indentation + trimmed - indentedLines = append(indentedLines, indented) - } - s.string = strings.Join(indentedLines, "\n") - return s -}