Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mx-psi committed Oct 27, 2021
1 parent 823e44a commit 462be73
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,22 @@ If you just want to list the files that porto would change vanity import, run:
```bash
porto -l path/to/library
```
## Inclusion/exclusion rules

If you want to ignore files (e.g. proto generated files), pass the `--skip-files` flag:
`porto` skips autogenerated, internal, third party and vendored files by default. You can customize what files get included using some flags:

- If you want to ignore files (e.g. proto generated files), pass the `--skip-files` flag:

```bash
porto --skip-files ".*\\.pb\\.go$" path/to/library
```
- If you want to ignore directories (e.g. tooling directories), pass the `--skip-dirs` flag:

If you want to include `internal` folders too
```bash
porto --skip-dirs "^tools$" path/to/library
```
- If you want to include `internal` folders and directories skipped by default:

```bash
porto --include-internal path/to/library
porto --include-internal --skip-dirs-use-default=false path/to/library
```

0 comments on commit 462be73

Please sign in to comment.