From 14d69abd7a74770712e666690fa497e4f3dc4319 Mon Sep 17 00:00:00 2001 From: "Iskander (Alex) Sharipov" Date: Sat, 26 Dec 2020 18:13:54 +0100 Subject: [PATCH] move docs->_docs, test->_test (#162) --- Makefile | 8 ++++---- README.md | 10 +++++----- {docs => _docs}/gorules.md | 0 {docs => _docs}/logo.png | Bin {docs => _docs}/logo2.png | Bin {test => _test}/install/binary_gopath/Dockerfile | 0 {test => _test}/install/binary_gopath/expected.txt | 0 {test => _test}/install/binary_gopath/rules.go | 0 {test => _test}/install/binary_gopath/target.go | 0 {test => _test}/install/binary_gopath/test.bash | 0 {test => _test}/install/binary_nogopath/Dockerfile | 0 .../install/binary_nogopath/expected.txt | 0 {test => _test}/install/binary_nogopath/rules.go | 0 {test => _test}/install/binary_nogopath/target.go | 0 {test => _test}/install/binary_nogopath/test.bash | 0 {test => _test}/install/gitclone/Dockerfile | 0 {test => _test}/install/gitclone/expected.txt | 0 {test => _test}/install/gitclone/expected2.txt | 0 {test => _test}/install/gitclone/rules.go | 0 {test => _test}/install/gitclone/rules2.go | 0 {test => _test}/install/gitclone/target.go | 0 {test => _test}/install/gitclone/test.bash | 0 {test => _test}/regress/issue103/Dockerfile | 0 {test => _test}/regress/issue103/expected.txt | 0 {test => _test}/regress/issue103/rules.go | 0 {test => _test}/regress/issue103/target.go | 0 {test => _test}/regress/issue103/test.bash | 0 27 files changed, 9 insertions(+), 9 deletions(-) rename {docs => _docs}/gorules.md (100%) rename {docs => _docs}/logo.png (100%) rename {docs => _docs}/logo2.png (100%) rename {test => _test}/install/binary_gopath/Dockerfile (100%) rename {test => _test}/install/binary_gopath/expected.txt (100%) rename {test => _test}/install/binary_gopath/rules.go (100%) rename {test => _test}/install/binary_gopath/target.go (100%) rename {test => _test}/install/binary_gopath/test.bash (100%) rename {test => _test}/install/binary_nogopath/Dockerfile (100%) rename {test => _test}/install/binary_nogopath/expected.txt (100%) rename {test => _test}/install/binary_nogopath/rules.go (100%) rename {test => _test}/install/binary_nogopath/target.go (100%) rename {test => _test}/install/binary_nogopath/test.bash (100%) rename {test => _test}/install/gitclone/Dockerfile (100%) rename {test => _test}/install/gitclone/expected.txt (100%) rename {test => _test}/install/gitclone/expected2.txt (100%) rename {test => _test}/install/gitclone/rules.go (100%) rename {test => _test}/install/gitclone/rules2.go (100%) rename {test => _test}/install/gitclone/target.go (100%) rename {test => _test}/install/gitclone/test.bash (100%) rename {test => _test}/regress/issue103/Dockerfile (100%) rename {test => _test}/regress/issue103/expected.txt (100%) rename {test => _test}/regress/issue103/rules.go (100%) rename {test => _test}/regress/issue103/target.go (100%) rename {test => _test}/regress/issue103/test.bash (100%) diff --git a/Makefile b/Makefile index 874e146b..0f9f0a0a 100644 --- a/Makefile +++ b/Makefile @@ -7,13 +7,13 @@ test: @echo "everything is OK" test-master: - cd test/install/gitclone && docker build --no-cache . - cd test/regress/issue103 && docker build --no-cache . + cd _test/install/gitclone && docker build --no-cache . + cd _test/regress/issue103 && docker build --no-cache . @echo "everything is OK" test-release: - cd test/install/binary_gopath && docker build --build-arg release=$(RELEASE) --no-cache . - cd test/install/binary_nogopath && docker build --build-arg release=$(RELEASE) --no-cache . + cd _test/install/binary_gopath && docker build --build-arg release=$(RELEASE) --no-cache . + cd _test/install/binary_nogopath && docker build --build-arg release=$(RELEASE) --no-cache . @echo "everything is OK" lint: diff --git a/README.md b/README.md index 30cd9900..b5f568ef 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/quasilyte/go-ruleguard)](https://pkg.go.dev/mod/github.com/quasilyte/go-ruleguard) [![Go Report Card](https://goreportcard.com/badge/github.com/quasilyte/go-ruleguard)](https://goreportcard.com/report/github.com/quasilyte/go-ruleguard) -![Logo](docs/logo2.png) +![Logo](_docs/logo2.png) ## Overview @@ -19,8 +19,8 @@ You write the rules, `ruleguard` checks whether they are satisfied. * Custom linting rules without re-compilation and Go plugins. * Diagnostics are written in a declarative way. -* [Quickfix](docs/gorules.md#suggestions-quickfix-support) actions support. -* Powerful match filtering features, like expression [type pattern matching](docs/gorules.md#type-pattern-matching). +* [Quickfix](_docs/gorules.md#suggestions-quickfix-support) actions support. +* Powerful match filtering features, like expression [type pattern matching](_docs/gorules.md#type-pattern-matching). `ruleguard` comes with [rules.go](rules.go) file that can be used as a foundation to write your own rules file. @@ -119,7 +119,7 @@ The `-e` generated rule will have `e` name, so it can be debugged as well. ## How does it work? -`ruleguard` parses [gorules](docs/gorules.md) (e.g. `rules.go`) during the start to load the rule set. +`ruleguard` parses [gorules](_docs/gorules.md) (e.g. `rules.go`) during the start to load the rule set. Loaded rules are then used to check the specified targets (Go files, packages). The `rules.go` file itself is never compiled, nor executed. @@ -136,7 +136,7 @@ To learn more, check out the documentation and/or the source code. * [Ruleguard by example](https://go-ruleguard.github.io/by-example/) tour * Example rule files: [rules.go](rules.go) * Another great example: [github.com/dgryski/semgrep-go/ruleguard.rules.go](https://github.com/dgryski/semgrep-go/blob/master/ruleguard.rules.go) -* [gorules](docs/gorules.md) format documentation +* [gorules](_docs/gorules.md) format documentation * [dsl package](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl) reference * [ruleguard package](https://godoc.org/github.com/quasilyte/go-ruleguard/ruleguard) reference * Introduction article: [EN](https://quasilyte.dev/blog/post/ruleguard/), [RU](https://habr.com/ru/post/481696/) diff --git a/docs/gorules.md b/_docs/gorules.md similarity index 100% rename from docs/gorules.md rename to _docs/gorules.md diff --git a/docs/logo.png b/_docs/logo.png similarity index 100% rename from docs/logo.png rename to _docs/logo.png diff --git a/docs/logo2.png b/_docs/logo2.png similarity index 100% rename from docs/logo2.png rename to _docs/logo2.png diff --git a/test/install/binary_gopath/Dockerfile b/_test/install/binary_gopath/Dockerfile similarity index 100% rename from test/install/binary_gopath/Dockerfile rename to _test/install/binary_gopath/Dockerfile diff --git a/test/install/binary_gopath/expected.txt b/_test/install/binary_gopath/expected.txt similarity index 100% rename from test/install/binary_gopath/expected.txt rename to _test/install/binary_gopath/expected.txt diff --git a/test/install/binary_gopath/rules.go b/_test/install/binary_gopath/rules.go similarity index 100% rename from test/install/binary_gopath/rules.go rename to _test/install/binary_gopath/rules.go diff --git a/test/install/binary_gopath/target.go b/_test/install/binary_gopath/target.go similarity index 100% rename from test/install/binary_gopath/target.go rename to _test/install/binary_gopath/target.go diff --git a/test/install/binary_gopath/test.bash b/_test/install/binary_gopath/test.bash similarity index 100% rename from test/install/binary_gopath/test.bash rename to _test/install/binary_gopath/test.bash diff --git a/test/install/binary_nogopath/Dockerfile b/_test/install/binary_nogopath/Dockerfile similarity index 100% rename from test/install/binary_nogopath/Dockerfile rename to _test/install/binary_nogopath/Dockerfile diff --git a/test/install/binary_nogopath/expected.txt b/_test/install/binary_nogopath/expected.txt similarity index 100% rename from test/install/binary_nogopath/expected.txt rename to _test/install/binary_nogopath/expected.txt diff --git a/test/install/binary_nogopath/rules.go b/_test/install/binary_nogopath/rules.go similarity index 100% rename from test/install/binary_nogopath/rules.go rename to _test/install/binary_nogopath/rules.go diff --git a/test/install/binary_nogopath/target.go b/_test/install/binary_nogopath/target.go similarity index 100% rename from test/install/binary_nogopath/target.go rename to _test/install/binary_nogopath/target.go diff --git a/test/install/binary_nogopath/test.bash b/_test/install/binary_nogopath/test.bash similarity index 100% rename from test/install/binary_nogopath/test.bash rename to _test/install/binary_nogopath/test.bash diff --git a/test/install/gitclone/Dockerfile b/_test/install/gitclone/Dockerfile similarity index 100% rename from test/install/gitclone/Dockerfile rename to _test/install/gitclone/Dockerfile diff --git a/test/install/gitclone/expected.txt b/_test/install/gitclone/expected.txt similarity index 100% rename from test/install/gitclone/expected.txt rename to _test/install/gitclone/expected.txt diff --git a/test/install/gitclone/expected2.txt b/_test/install/gitclone/expected2.txt similarity index 100% rename from test/install/gitclone/expected2.txt rename to _test/install/gitclone/expected2.txt diff --git a/test/install/gitclone/rules.go b/_test/install/gitclone/rules.go similarity index 100% rename from test/install/gitclone/rules.go rename to _test/install/gitclone/rules.go diff --git a/test/install/gitclone/rules2.go b/_test/install/gitclone/rules2.go similarity index 100% rename from test/install/gitclone/rules2.go rename to _test/install/gitclone/rules2.go diff --git a/test/install/gitclone/target.go b/_test/install/gitclone/target.go similarity index 100% rename from test/install/gitclone/target.go rename to _test/install/gitclone/target.go diff --git a/test/install/gitclone/test.bash b/_test/install/gitclone/test.bash similarity index 100% rename from test/install/gitclone/test.bash rename to _test/install/gitclone/test.bash diff --git a/test/regress/issue103/Dockerfile b/_test/regress/issue103/Dockerfile similarity index 100% rename from test/regress/issue103/Dockerfile rename to _test/regress/issue103/Dockerfile diff --git a/test/regress/issue103/expected.txt b/_test/regress/issue103/expected.txt similarity index 100% rename from test/regress/issue103/expected.txt rename to _test/regress/issue103/expected.txt diff --git a/test/regress/issue103/rules.go b/_test/regress/issue103/rules.go similarity index 100% rename from test/regress/issue103/rules.go rename to _test/regress/issue103/rules.go diff --git a/test/regress/issue103/target.go b/_test/regress/issue103/target.go similarity index 100% rename from test/regress/issue103/target.go rename to _test/regress/issue103/target.go diff --git a/test/regress/issue103/test.bash b/_test/regress/issue103/test.bash similarity index 100% rename from test/regress/issue103/test.bash rename to _test/regress/issue103/test.bash