Skip to content

Commit

Permalink
move docs->_docs, test->_test
Browse files Browse the repository at this point in the history
  • Loading branch information
quasilyte committed Dec 26, 2020
1 parent 0d29c19 commit d1cb000
Show file tree
Hide file tree
Showing 27 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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/)
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit d1cb000

Please sign in to comment.