DevFW-CICD/ingress-nginx-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add go dependencies for mdtoc

Browse source
This commit is contained in:
Manuel Alejandro de Brito Fontes 2019-07-21 14:00:47 -04:00
parent cb33c4ed26
commit 36959a4878
No known key found for this signature in database
GPG key ID: 786136016A8BA02A
63 changed files with 12675 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
vendor/github.com/tallclair/mdtoc/.gitignore generated vendored Normal file
View file

@ -0,0 +1 @@
mdtoc

28
vendor/github.com/tallclair/mdtoc/CONTRIBUTING.md generated vendored Normal file
View file

@ -0,0 +1,28 @@
# How to Contribute
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
## Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.
## Code reviews
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.
## Community Guidelines
This project follows
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

202
vendor/github.com/tallclair/mdtoc/LICENSE generated vendored Normal file
View file

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

53
vendor/github.com/tallclair/mdtoc/README.md generated vendored Normal file
View file

@ -0,0 +1,53 @@
# Markdown Table of Contents Generator
`mdtoc` is a utility for generating a table-of-contents for markdown files.
Only github-flavored markdown is currently supported, but I am open to accepting patches to add
other formats.
# Table of Contents
Generated with `mdtoc --inplace README.md`
<!-- toc -->
- [Usage](#usage)
- [Installation](#installation)
<!-- /toc -->
## Usage
Usage: `mdtoc [OPTIONS] [FILE]...`
Generate a table of contents for a markdown file (github flavor).
TOC may be wrapped in a pair of tags to allow in-place updates:
```
<!-- toc -->
generated TOC goes here
<!-- /toc -->
```
TOC indentation is normalized, so the shallowest header has indentation 0.
**Options:**
`--dryrun` - Whether to check for changes to TOC, rather than overwriting.
Requires `--inplace` flag. Exit code 1 if there are changes.
`--inplace` - Whether to edit the file in-place, or output to STDOUT. Requires
toc tags to be present.
`--skip-prefix` - Whether to ignore any headers before the opening toc
tag. (default true)
For example, with `--skip-prefix=false` the TOC for this file becomes:
```
- [Markdown Table of Contents Generator](#markdown-table-of-contents-generator)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Installation](#installation)
```
## Installation
``` go get github.com/tallclair/mdtoc ```

11
vendor/github.com/tallclair/mdtoc/go.mod generated vendored Normal file
View file

@ -0,0 +1,11 @@
module github.com/tallclair/mdtoc
go 1.12
require (
github.com/BurntSushi/toml v0.3.1 // indirect
github.com/ekalinin/github-markdown-toc v0.0.0-20190514155158-83fadb60a7f1 // indirect
github.com/gomarkdown/markdown v0.0.0-20190222000725-ee6a7931a1e4
github.com/mmarkdown/mmark v2.0.40+incompatible
github.com/stretchr/testify v1.3.0
)

15
vendor/github.com/tallclair/mdtoc/go.sum generated vendored Normal file
View file

@ -0,0 +1,15 @@
github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/ekalinin/github-markdown-toc v0.0.0-20190514155158-83fadb60a7f1 h1:E42haoFVyge+y3G2q/lwksiZPu6bMmim1xLxjOjPeEw=
github.com/ekalinin/github-markdown-toc v0.0.0-20190514155158-83fadb60a7f1/go.mod h1:XfZS1iyC28CnllR54Ou2Ero6qs4Rmn7GpVumNSj1DZo=
github.com/gomarkdown/markdown v0.0.0-20190222000725-ee6a7931a1e4 h1:vELsocEzlhM4lk2nhxolEaQrMp25u7/i9IX8s9uLads=
github.com/gomarkdown/markdown v0.0.0-20190222000725-ee6a7931a1e4/go.mod h1:gmFANS06wAVmF0B9yi65QKsRmPQ97tze7FRLswua+OY=
github.com/mmarkdown/mmark v2.0.40+incompatible h1:vMeUeDzBK3H+/mU0oMVfMuhSXJlIA+DE/DMPQNAj5C4=
github.com/mmarkdown/mmark v2.0.40+incompatible/go.mod h1:Uvmoz7tvsWpr7bMVxIpqZPyN3FbOtzDmnsJDFp7ltJs=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

301
vendor/github.com/tallclair/mdtoc/mdtoc.go generated vendored Normal file
View file

@ -0,0 +1,301 @@
/*
Copyright 2019 Google LLC
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 main
import (
"bytes"
"flag"
"fmt"
"io/ioutil"
"log"
"math"
"os"
"regexp"
"strings"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/html"
"github.com/gomarkdown/markdown/parser"
"github.com/mmarkdown/mmark/mparser"
)
const (
startTOC = "<!-- toc -->"
endTOC = "<!-- /toc -->"
)
type options struct {
dryrun bool
inplace bool
skipPrefix bool
}
var defaultOptions options
func init() {
flag.BoolVar(&defaultOptions.dryrun, "dryrun", false, "Whether to check for changes to TOC, rather than overwriting. Requires --inplace flag.")
flag.BoolVar(&defaultOptions.inplace, "inplace", false, "Whether to edit the file in-place, or output to STDOUT. Requires toc tags to be present.")
flag.BoolVar(&defaultOptions.skipPrefix, "skip-prefix", true, "Whether to ignore any headers before the opening toc tag.")
flag.Usage = func() {
fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [OPTIONS] [FILE]...\n", os.Args[0])
fmt.Fprintf(flag.CommandLine.Output(), "Generate a table of contents for a markdown file (github flavor).\n")
fmt.Fprintf(flag.CommandLine.Output(), "TOC may be wrapped in a pair of tags to allow in-place updates: <!-- toc --><!-- /toc -->\n")
flag.PrintDefaults()
}
}
func main() {
flag.Parse()
if err := validateArgs(defaultOptions, flag.Args()); err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
flag.Usage()
os.Exit(1)
}
hadError := false
for _, file := range flag.Args() {
toc, err := run(file, defaultOptions)
if err != nil {
log.Printf("%s: %v", file, err)
hadError = true
} else if !defaultOptions.inplace {
fmt.Println(toc)
}
}
if hadError {
os.Exit(1)
}
}
func validateArgs(opts options, args []string) error {
if len(args) < 1 {
return fmt.Errorf("must specify at least 1 file")
}
if !opts.inplace && len(args) > 1 {
return fmt.Errorf("non-inplace updates require exactly 1 file")
}
if opts.dryrun && !opts.inplace {
return fmt.Errorf("--dryrun requires --inplace")
}
return nil
}
// run the TOC generator on file with options.
// Returns the generated toc, and any error.
func run(file string, opts options) (string, error) {
raw, err := ioutil.ReadFile(file)
if err != nil {
return "", fmt.Errorf("unable to read %s: %v", file, err)
}
start := bytes.Index(raw, []byte(startTOC))
end := bytes.Index(raw, []byte(endTOC))
if tocTagRequired(opts) {
if start == -1 {
return "", fmt.Errorf("missing opening TOC tag")
}
if end == -1 {
return "", fmt.Errorf("missing closing TOC tag")
}
if end < start {
return "", fmt.Errorf("TOC closing tag before start tag")
}
}
var prefix, doc []byte
// skipPrefix is only used when toc tags are present.
if opts.skipPrefix && start != -1 && end != -1 {
prefix = raw[:start]
doc = raw[end:]
} else {
doc = raw
}
toc, err := generateTOC(prefix, doc)
if err != nil {
return toc, fmt.Errorf("failed to generate toc: %v", err)
}
if !opts.inplace {
return toc, err
}
realStart := start + len(startTOC)
oldTOC := string(raw[realStart:end])
if strings.TrimSpace(oldTOC) == strings.TrimSpace(toc) {
// No changes required.
return toc, nil
} else if opts.dryrun {
return toc, fmt.Errorf("changes found:\n%s", toc)
}
err = atomicWrite(file,
string(raw[:start]),
startTOC+"\n",
string(toc),
string(raw[end:]),
)
return toc, err
}
// atomicWrite writes the chunks sequentially to the filePath.
// A temporary file is used so no changes are made to the original in the case of an error.
func atomicWrite(filePath string, chunks ...string) error {
tmpPath := filePath + "_tmp"
tmp, err := os.OpenFile(tmpPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600)
if err != nil {
return fmt.Errorf("unable to open tepmorary file %s: %v", tmpPath, err)
}
// Cleanup
defer func() {
tmp.Close()
os.Remove(tmpPath)
}()
for _, chunk := range chunks {
if _, err := tmp.WriteString(chunk); err != nil {
return err
}
}
if err := tmp.Close(); err != nil {
return err
}
return os.Rename(tmp.Name(), filePath)
}
// parse parses a raw markdown document to an AST.
func parse(b []byte) ast.Node {
p := parser.NewWithExtensions(parser.CommonExtensions)
p.Opts = parser.Options{
// mparser is required for parsing the --- title blocks
ParserHook: mparser.Hook,
}
return p.Parse(b)
}
func generateTOC(prefix []byte, doc []byte) (string, error) {
prefixMd := parse(prefix)
anchors := make(anchorGen)
// Start counting anchors from the beginning of the doc.
walkHeadings(prefixMd, func(heading *ast.Heading) {
anchors.mkAnchor(asText(heading))
})
md := parse(doc)
baseLvl := headingBase(md)
toc := &bytes.Buffer{}
htmlRenderer := html.NewRenderer(html.RendererOptions{})
walkHeadings(md, func(heading *ast.Heading) {
anchor := anchors.mkAnchor(asText(heading))
content := headingBody(htmlRenderer, heading)
fmt.Fprintf(toc, "%s- [%s](#%s)\n", strings.Repeat(" ", heading.Level-baseLvl), content, anchor)
})
return string(toc.Bytes()), nil
}
func tocTagRequired(opts options) bool {
return opts.inplace
}
type headingFn func(heading *ast.Heading)
// walkHeadings runs the heading function on each heading in the parsed markdown document.
func walkHeadings(doc ast.Node, headingFn headingFn) error {
var err error
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
if !entering {
return ast.GoToNext // Don't care about closing the heading section.
}
heading, ok := node.(*ast.Heading)
if !ok {
return ast.GoToNext // Ignore non-heading nodes.
}
if heading.IsTitleblock {
return ast.GoToNext // Ignore title blocks (the --- section)
}
headingFn(heading)
return ast.GoToNext
})
return err
}
func asText(node ast.Node) string {
var text string
ast.WalkFunc(node, func(node ast.Node, entering bool) ast.WalkStatus {
if !entering {
return ast.GoToNext // Don't care about closing the heading section.
}
t, ok := node.(*ast.Text)
if !ok {
return ast.GoToNext // Ignore non-text nodes.
}
text += string(t.AsLeaf().Literal)
return ast.GoToNext
})
return text
}
// Renders the heading body as HTML
func headingBody(renderer *html.Renderer, heading *ast.Heading) string {
var buf bytes.Buffer
for _, child := range heading.Children {
ast.WalkFunc(child, func(node ast.Node, entering bool) ast.WalkStatus {
return renderer.RenderNode(&buf, node, entering)
})
}
return strings.TrimSpace(buf.String())
}
// headingBase finds the minimum heading level. This is useful for normalizing indentation, such as
// when a top-level heading is skipped in the prefix.
func headingBase(doc ast.Node) int {
baseLvl := math.MaxInt32
walkHeadings(doc, func(heading *ast.Heading) {
if baseLvl > heading.Level {
baseLvl = heading.Level
}
})
return baseLvl
}
// Match punctuation that is filtered out from anchor IDs.
var punctuation = regexp.MustCompile(`[^\w\- ]`)
// anchorGen is used to generate heading anchor IDs, using the github-flavored markdown syntax.
type anchorGen map[string]int
func (a anchorGen) mkAnchor(text string) string {
text = strings.ToLower(text)
text = punctuation.ReplaceAllString(text, "")
text = strings.ReplaceAll(text, " ", "-")
idx := a[text]
a[text] = idx + 1
if idx > 0 {
return fmt.Sprintf("%s-%d", text, idx)
}
return text
}