Skip to content

Commit

Permalink
update doc (#1203)
Browse files Browse the repository at this point in the history
* update doc

* review updates

* review updates
  • Loading branch information
mfederowicz authored Jan 23, 2025
1 parent 77616f0 commit 1117372
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 36 deletions.
36 changes: 26 additions & 10 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,9 @@ Clone the project:
git clone [email protected]:mgechev/revive.git
cd revive
```

In order to fetch all the dependencies run:

```bash
make install
```

## Build

In order to build the project run:

```bash
make build
```
Expand All @@ -31,14 +23,38 @@ The command will produce the `revive` binary in the root of the project.

If you want to develop a new rule, follow as an example the already existing rules in the [rule package](https://github.com/mgechev/revive/tree/master/rule).

All rules should implement the following interface:

Each rule needs to implement the `lint.Rule` interface:
```go
type Rule interface {
Name() string
Apply(*File, Arguments) []Failure
}
```
All rules with a configuration must implement `lint.ConfigurableRule` interface:
```go
type ConfigurableRule interface {
Configure(Arguments) error
}
```

The `Arguments` type is an alias of the type `[]any`. The arguments of the rule are passed from the configuration file.

#### Example

Let's suppose we have developed a rule called `BanStructNameRule` which disallow us to name a structure with a given identifier. We can set the banned identifier by using the TOML configuration file:

```toml
[rule.ban-struct-name]
arguments = ["Foo"]
```

With the snippet above we:

- Enable the rule with the name `ban-struct-name`. The `Name()` method of our rule should return a string that matches `ban-struct-name`.
- Configure the rule with the argument `Foo`. The list of arguments will be passed to `Apply(*File, Arguments)` together with the target file we're linting currently.

A sample rule implementation can be found [here](/rule/argument_limit.go).


## Development of formatters

Expand Down
27 changes: 1 addition & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -636,32 +636,7 @@ To add a custom formatter you'll have to push it to this repository or fork it.

### Writing a Custom Rule

Each rule needs to implement the `lint.Rule` interface:

```go
type Rule interface {
Name() string
Apply(*File, Arguments) []Failure
}
```

The `Arguments` type is an alias of the type `[]interface{}`. The arguments of the rule are passed from the configuration file.

#### Example

Let's suppose we have developed a rule called `BanStructNameRule` which disallow us to name a structure with a given identifier. We can set the banned identifier by using the TOML configuration file:

```toml
[rule.ban-struct-name]
arguments = ["Foo"]
```

With the snippet above we:

- Enable the rule with the name `ban-struct-name`. The `Name()` method of our rule should return a string that matches `ban-struct-name`.
- Configure the rule with the argument `Foo`. The list of arguments will be passed to `Apply(*File, Arguments)` together with the target file we're linting currently.

A sample rule implementation can be found [here](/rule/argument_limit.go).
See [DEVELOPING.md](./DEVELOPING.md) for instructions on how to write a custom rule.

#### Using `revive` as a library

Expand Down

0 comments on commit 1117372

Please sign in to comment.