-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: fork eklanin/github-markdown-toc.go with HTML parsing updates (#…
…342) - Fork https://github.com/ekalinin/github-markdown-toc.go with [HTML parsing changes](ekalinin/github-markdown-toc.go#38). - Remove references to the original repo. - Removed `cmd/go_deps` as it is no longer needed.
- Loading branch information
Showing
22 changed files
with
1,501 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| load("@cgrindel_bazel_starlib//bzlformat:defs.bzl", "bzlformat_pkg") | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") | ||
|
|
||
| filegroup( | ||
| name = "all_files", | ||
| srcs = glob(["*"]), | ||
| visibility = ["//:__subpackages__"], | ||
| ) | ||
|
|
||
| go_library( | ||
| name = "github_markdown_toc", | ||
| srcs = [ | ||
| "ghdoc.go", | ||
| "headerfinder.go", | ||
| "internals.go", | ||
| ], | ||
| importpath = "github.com/cgrindel/bazel-starlib/markdown/tools/github_markdown_toc", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "@org_golang_x_net//html", | ||
| "@org_golang_x_net//html/atom", | ||
| ], | ||
| ) | ||
|
|
||
| go_test( | ||
| name = "github_markdown_toc_test", | ||
| srcs = [ | ||
| "ghdoc_test.go", | ||
| "headerfinder_test.go", | ||
| "internal_test.go", | ||
| ], | ||
| embed = [":github_markdown_toc"], | ||
| deps = [ | ||
| "@com_github_stretchr_testify//assert", | ||
| "@org_golang_x_net//html", | ||
| "@org_golang_x_net//html/atom", | ||
| ], | ||
| ) | ||
|
|
||
| bzlformat_pkg(name = "bzlformat") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2015 Eugene Kalinin | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
| this software and associated documentation files (the "Software"), to deal in | ||
| the Software without restriction, including without limitation the rights to | ||
| use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
| the Software, and to permit persons to whom the Software is furnished to do so, | ||
| subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
| FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
| IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| EXEC=gh-md-toc | ||
| CMD_SRC=cmd/${EXEC}/main.go | ||
| BUILD_DIR=build | ||
| BUILD_OS="windows darwin linux" | ||
| BUILD_ARCH="amd64" | ||
|
|
||
| clean: | ||
| @rm -f ${EXEC} | ||
| @rm -f ${BUILD_DIR}/* | ||
| @go clean | ||
|
|
||
| lint: | ||
| @golint | ||
| @golangci-lint run | ||
|
|
||
| # make run ARGS="--help" | ||
| run: | ||
| @go run ${CMD_SRC} $(ARGS) | ||
|
|
||
| build: clean lint | ||
| go build -race -o ${EXEC} ${CMD_SRC} | ||
|
|
||
| test: clean lint | ||
| @go test -cover -o ${EXEC} | ||
|
|
||
| release: test buildall | ||
| @git tag `grep "version" main.go | grep -o -E '[0-9]\.[0-9]\.[0-9]{1,2}'` | ||
| @git push --tags origin master | ||
|
|
||
| buildall: clean | ||
| @mkdir -p ${BUILD_DIR} | ||
| @for os in "${BUILD_OS}" ; do \ | ||
| for arch in "${BUILD_ARCH}" ; do \ | ||
| echo " * build $$os for $$arch"; \ | ||
| GOOS=$$os GOARCH=$$arch go build -o ${BUILD_DIR}/${EXEC} ${CMD_SRC}; \ | ||
| cd ${BUILD_DIR}; \ | ||
| tar czf ${EXEC}.$$os.$$arch.tgz ${EXEC}; \ | ||
| cd - ; \ | ||
| done done | ||
| @rm ${BUILD_DIR}/${EXEC} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # GitHub Markdown TOC | ||
|
|
||
| This utility is based upon [the gh-md-toc utility created by | ||
| eklanin](https://github.com/ekalinin/github-markdown-toc.go). The original implementation used | ||
| regular expressions to parse the HTML generated from GitHub's markdown rendering service. | ||
| Unfortunately, subtle changes in the output from this service can cause the regular expressions to | ||
| not work properly. I created [a pull request that replaced the regular experession logic with HTML | ||
| parsing using `golang.org/x/net/html`](https://github.com/ekalinin/github-markdown-toc.go/pull/38). | ||
| As of this writing, the pull request has not been merged. | ||
|
|
||
| After another outage due to the fragility of the regular expression logic on 2023-08-29, I opted to | ||
| fork the code with the HTML parsing logic and incorporate it into this repository. I preserved the | ||
| original license on the code. However, any changes to this utility may not be compatible with the | ||
| original code base. |
Oops, something went wrong.