Coder Social home page Coder Social logo

lerna-alias's Introduction

lerna-alias

Simple package for getting alias object for packages managed by lerna, so other tools (such as webpack, rollup, jest and possibly more) can consume your packages directly from the source files, instead of the built and prepared distribution files.

It just eases development and setting up scripts depending on other lerna packages.

API

lernaAliases({
  // from which directory lerna monorepo should be searched for
  directory: string = process.cwd(),
  // optional array of `mainFields` that should be used to resolv package's entry point
  // similar to the https://webpack.js.org/configuration/resolve/#resolve-mainfields
  // using this takes precedence over default `sourceDirectory` option
  mainFields?: string[],
  // which directory should be considered as containing source files of a package
  // if specified as false it will use package's root and rely on a tool's (i.e. webpack) resolving algorithm
  sourceDirectory: string | false = 'src'
}): Aliases

Types

Aliases

type Aliases = {
  // value is a local directory path to the package
  // resolved using `sourceDirectory` and `mainFields` options
  [packageName: string]: string,
}

Usage

with webpack

const { webpack: lernaAliases } = require('lerna-alias')

module.exports = {
  // ...
  resolve: {
    // ...
    alias: lernaAliases(),
  },
}

with Rollup

const { rollup: lernaAliases } = require('lerna-alias')
const lernaAliases = require('lerna-alias')

module.exports = {
  // ...
  plugins: [
    // ...
    alias(lernaAliases()),
  ],
}

with Jest

const { jest: lernaAliases } = require('lerna-alias')

module.exports = {
  // ...
  moduleNameMapper: lernaAliases(),
}

using mainFields option

const { jest: lernaAliases } = require('lerna-alias')

module.exports = {
  // ...
  moduleNameMapper: lernaAliases({ mainFields: ['main'] }),
}

lerna-alias's People

Contributors

andarist avatar

Stargazers

Andriy Panas avatar  avatar  avatar Chung, Lian(Dennis) avatar M. Meyer avatar Kir Yusupov avatar Hashem Khalifa avatar Per Svensson avatar Luma avatar Kamil Mateusiak avatar danielsdesk avatar Martin avatar Artur Bordeniuc avatar  avatar Raí Siqueira avatar Federico Zivolo avatar Konrad Kruk avatar Alasdair McLeay avatar Leif Olsen avatar Bartosz Olchówka avatar Rohat avatar Vik R avatar Nathan Vale avatar Tomáš Szabo avatar Neo Nie avatar Steven Bassett avatar Elliott Greaves avatar Jinxuan Zhu avatar Toby Brancher avatar Irwan Fario Subastian avatar  avatar Daniel Angermund avatar Jason Quense avatar Florian Rüberg avatar Patrick Dahms avatar  avatar

Watchers

Jinxuan Zhu avatar James Cloos avatar Alasdair McLeay avatar  avatar Irwan Fario Subastian avatar

lerna-alias's Issues

Update README with real examples

It would be nice to add some real-world examples of issues that this repository solves.
Right now, based on the description, and example configurations I have no idea how to use this package and I think it might solve my problem when set up correctly.

Default sourceDirectory forces imports from index

entry = `${sourceDirectory}/index`
causes it to be the case that if I want to import from myPackage/src/notIndexFile.js this is impossible; I must export everything from the index and import directly from there. if we did not include index in the string, I believe everything would still work that wants to import from index by default, but it would also be possible to import from other files and folders in the directory.

lerna-alias and react-dev-utils/ModuleScopePlugin

Hi!

First, let me say that it's great stuff - just what I've been looking for!

We have a monorepo, using lerna, of react libs and apps. We use webpack for building, and use ModuleScopePlugin from react-dev-utils to control how imports are made. More on the plugin here: https://www.npmjs.com/package/react-dev-utils. But issues then appear when we use lerna-alias, as aliases appear to reference the "fulll" paths of dependencies that are present in the monorepo. Would it be possible to, through eg. a flag, reference used dependencies through the lib's own node_modules, where symlinks should be present?

Any thoughts on this?
/d

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.