Giter VIP home page Giter VIP logo

next-circular-dependency's Introduction

next-circular-dependency

package version package downloads standard-readme compliant package license make a pull request

Detect circular dependencies in your Next.js app

Table of Contents

Usage

const path = require('path')
const withCSS = require('@zeit/next-css')
const optimizedImages = require('next-optimized-images')

const withNextCircularDeps = require('next-circular-dependency')

require('dotenv').config()

module.exports =  withNextCircularDeps(optimizedImages(withCSS({
  // exclude detection of files based on a RegExp
  exclude: /a\.js|node_modules/,
  // include specific files based on a RegExp
  include: /dir/,
  // add errors to webpack instead of warnings
  failOnError: true,
  // allow import cycles that include an asyncronous import,
  // e.g. via import(/* webpackMode: "weak" */ './file.js')
  allowAsyncCycles: false,
  // set the current working directory for displaying module paths
  cwd: process.cwd(),
}))
)

Install

This project uses node and npm.

$ npm install next-circular-dependency
$ # OR
$ yarn add next-circular-dependency

Contribute

  1. Fork it and create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am "Add some feature"
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request

License

MIT

next-circular-dependency's People

Contributors

dependabot[bot] avatar tiaanduplessis avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

next-circular-dependency's Issues

Add options instead of polluting next.config.js

Currently, to configure https://github.com/aackerman/circular-dependency-plugin we must inject properties into next.config.js, such as include or failOnError. Ideally, those would be passed as options instead, like:

withCircularDependency({ failOnError: true })(myNextConfig);

Here's an example of a official plugin written this way: https://github.com/zeit/next.js/blob/canary/packages/next-bundle-analyzer/index.js#L1

The good thing about this is that it will play nicely with https://www.npmjs.com/package/next-compose-plugins.

If you agree, I can make a PR. Thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.