Skip to content

Commit

Permalink
Update README and CHANGELOG before publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
aackerman committed Mar 20, 2018
1 parent 27af8ea commit da5218c
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 35 deletions.
18 changes: 12 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# Changelog

## 5.0.0

* Support for webpack 4
* Exclude logic will now be checked regardless of presence of `onDetected` method


## 4.4.0

Added `onStart` and `onEnd` callbacks
* Added `onStart` and `onEnd` callbacks

## 4.3.0

Added `cwd` parameter to allow setting the current working directory for displaying module paths
* Added `cwd` parameter to allow setting the current working directory for displaying module paths

## 4.2.0

The webpack module record is now passed into the `onDetected` callback
* The webpack module record is now passed into the `onDetected` callback

## 4.1.0

Added support for the `ModuleConcatenationPlugin` from webpack
* Added support for the `ModuleConcatenationPlugin` from webpack

## 4.0.0

Dropped support for Node 4.x
* Dropped support for Node 4.x

## 3.0.0

Started using Error objects instead of plain strings for webpack compilation warnings/errors
* Started using Error objects instead of plain strings for webpack compilation warnings/errors
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Detect modules with circular dependencies when bundling with webpack.

Circular dependencies are often a necessity in complex software, the presence of a circular dependency doesn't always imply a bug, but in the case where you believe a bug exists, this module may help find it.

### Webpack Versions

The latest major version of this plugin `5`, supports webpack `4.x.x` as a peer dependency. Major version `4` of this plugin and below are intended to support webpack `3.x.x` and below as a peer dependency.

### Basic Usage

```js
Expand Down
11 changes: 8 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,14 @@ class CircularDependencyPlugin {
plugin.options.onStart({ compilation });
}
for (let module of modules) {
const shouldSkip = module.resource === undefined
|| plugin.options.exclude.test(module.resource);
if (shouldSkip) { continue }
const shouldSkip = (
module.resource == null ||
plugin.options.exclude.test(module.resource)
)
// skip the module if it matches the exclude pattern
if (shouldSkip) {
continue
}

let maybeCyclicalPathsList = this.isCyclic(module, module, {})
if (maybeCyclicalPathsList) {
Expand Down
52 changes: 26 additions & 26 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit da5218c

Please sign in to comment.