This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit 028d742

Mangepbrisbin

authored and

committed

Document engine-specific excludes

While we prefer to keep documentation on docs.codeclimate.com, this engine is the most frequent beneficiary of this general configuration point. Therefore, it's useful to improve visibility by mentioning it in the project README as well.

1 parent 5b3d755 commit 028d742Copy full SHA for 028d742

File tree

1 file changed

+15

-0

lines changed

README.md

1 file changed

+15

-0

lines changed

`‎README.md‎`

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,22 @@ engines:`
`68`	`68`	Note that you have the update the YAML structure under the `languages` key to
`69`	`69`	`the Hash type to support extra configuration.`
`70`	`70`
	`71`	`+### Excluding files and directories`
	`72`	`+`
	`73`	`+As with any other Code Climate engine, you can exclude certain files or`
	`74`	`+directories from being analyzed. For more information, see`
	`75`	`+[Exclude paths for specific engines][exclude-files-engine] in our`
	`76`	`+documentation.`
	`77`	`+`
	`78`	+```yaml
	`79`	`+engines:`
	`80`	`+ duplication:`
	`81`	`+ exclude_paths:`
	`82`	`+ - examples/`
	`83`	+```
	`84`	`+`
`71`	`85`	`[codeclimate]: https://codeclimate.com/dashboard`
`72`	`86`	`[what-is-duplication]: https://docs.codeclimate.com/docs/duplication-concept`
`73`	`87`	`[flay]: https://github.com/seattlerb/flay`
`74`	`88`	`[cli]: https://github.com/codeclimate/codeclimate`
	`89`	`+[exclude-files-engine]: https://docs.codeclimate.com/docs/excluding-files-and-folders#section-exclude-paths-for-specific-engines`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 028d742

File tree

1 file changed

1 file changed

`‎README.md‎`

0 commit comments