Skip to content

Commit

Permalink
README: better enableAnalysisOfUnusedDevDependencies description (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
janedbal authored Jan 10, 2024
1 parent f8245ec commit 232c33f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ return $config
// with such option, you should add custom paths by addPathToScan() or addPathsToScan()
->disableComposerAutoloadPathScan()

// report unused dependencies even for dev packages
// dev packages are often used only in CI, so this is not enabled by default
// but you may want to ignore those packages manually to be sure
->enableAnalysisOfUnusedDevDependencies()

// disable detection of dev dependencies in production code globally
->ignoreErrors([ErrorType::DEV_DEPENDENCY_IN_PROD])

Expand Down Expand Up @@ -123,10 +128,6 @@ return $config
// allow using classes not present in composer's autoloader by regex
// e.g. when you want to ignore whole namespace of classes
->ignoreUnknownClassesRegex('~^PHPStan\\.*?~')

// report unused dependencies even for dev packages
// typically, dev packages is some CI tooling without references in code, so this is not enabled by default
->enableAnalysisOfUnusedDevDependencies()
;
```

Expand Down

0 comments on commit 232c33f

Please sign in to comment.