Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation #434

Open
as-zlynn-philipps opened this issue Mar 30, 2022 · 0 comments
Open

Better documentation #434

as-zlynn-philipps opened this issue Mar 30, 2022 · 0 comments

Comments

@as-zlynn-philipps
Copy link

as-zlynn-philipps commented Mar 30, 2022

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant