Skip to content

Better documentation #434

Open
Open
@as-zlynn-philipps

Description

@as-zlynn-philipps

There are some nuances of the root option that are not explained in the README, or even the docs, for instance:

{
  "plugins": [
    ["module-resolver", {
      "root": ["./src"], // setting this to `./` worked at first glance, but it broke a lot of things in my app
      "alias": {
        "test": "./test", // it's not clear whether this is relative to the `root` specified above (it's not, UNLIKE tsconfig.json)
        "underscore": "lodash"
      }
    }]
  ]
}

In addition, none of the docs actually explain what this plugin does behind the scenes, nor do they provide a means to troubleshoot. Just saying, a lot of developers want aliases, but may not realize how much this plugin really affects their builds (🙋‍♂️ me).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions