Giter VIP home page Giter VIP logo

eslint-import-resolver-lerna's Introduction

eslint-import-resolver-lerna

eslint-import-resolver-lerna Build Status Built with GNU Make

This resolver can be used together with eslint-plugin-import package to help it find modules in your Lerna-based monorepo.

When you might need this

In general you might not even need this, since Lerna symlinks your monorepo packages into your node_modules directory where the resolver can pick it up using the standard Node.js resolution mechanism. You probably will need this if:

  • You compile your project with Babel, Flow, TypeScript or any other compilation pipeline
  • You compile your packages directory into a completely different directory, ie. from src/packages into dist/packages
  • You configure Lerna to do link your packages together in the dist/packages directory

This will cause your src/packages directory to not have node_modules folder, thus causing the plugin to be unable to find your other packages using the standard built-in Node.js module resolution mechanism. That's where this resolver will help you.

What this does

This plugin will look in your packages directory and generate a list of all the package names (as defined in their package.json files) that the monorepo contains. Then, when the import plugin tries to resolve any of those names it will be able to help the import plugin to locate the package.

Usage

This resolver accepts only one configuration option: packages (string or array of strings, required) which must be an absolute path to Lerna's packages directory or an array of such absolute paths.

// .eslintrc.js
const path = require('path')

module.exports = {
  settings: {
    'import/resolver': {
      'eslint-import-resolver-lerna': {
        packages: path.resolve(__dirname, 'src/packages')
      }
    }
  }
}

LICENSE

See the LICENSE file for information.

eslint-import-resolver-lerna's People

Contributors

dependabot[bot] avatar robertrossmann avatar semantic-release-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

eslint-import-resolver-lerna's Issues

The automated release is failing 🚨

🚨 The automated release from the release/latest branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the release/latest branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

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.