Js-lingui: [Documentation] prevent @lingui/macro should be listed in the project's dependencies

[mschipperheyn]

Is your feature request related to a problem? Please describe.
Because @lingui/macro is based on preprocessing files it's part of dev dependencies. However, because it is used as an import in jsx files, eslint complains

[eslint] '@lingui/macro' should be listed in the project's dependencies, not devDependencies. [import/no-extraneous-dependencies]

Describe the solution you'd like
Documentation should describe how to disable this for @lingui/macro only. It would not be undesirable to have to fix this on a file per file basis

Describe alternatives you've considered
You could do individual includes //eslint-disable-line on a line by line basis. But that sucks

[tricoder42]

I've never seen this eslint rule. Could you please send a PR with proposed solution? We should probably also add it to documentation of babel-plugin-macros, because it'll affect all macros.

Thank you for bringing this up! 👍

[mschipperheyn]

Well, the rulle that gives the error is import/no-extraneous-dependencies. It basically warns you when you include in to be deployed code imports that are in devDependencies instead of dependencies. Perhaps the easiest solution would be to simply put @lingui/macro in dependencies, assuming that tree shaking will prevent it from being included when not necessary.

[tricoder42]

Yeah, sounds like a good idea. The tree shaking won't be even necessary. The production code won't see macro package as it's removed in build step (even the import).

[magicmark]

@tricoder42 should we reopen this issue? Had a chat about the eslint rule here https://github.com/benmosher/eslint-plugin-import/issues/1553

The current thinking is that the macro should indeed be a regular dependency - and that we should update the docs

[tricoder42]

Hey @magicmark, we should definitely discuss it in https://github.com/kentcdodds/babel-plugin-macros, because it affects all macros. I searched for relevant issues and could find any.

I guess we should:

1. Open ticket in https://github.com/kentcdodds/babel-plugin-macros with a link to https://github.com/benmosher/eslint-plugin-import/issues/1553 and explain the problem
2. Create a PR to https://github.com/kentcdodds/babel-plugin-macros mentioning that macros should be listed in production dependencies if the project uses eslint-plugin-import
3. Update Lingui docs to correctly install @lingui/macro as production dependency.

Maybe in the process we'll find a cue why nobody mentioned it in https://github.com/kentcdodds/babel-plugin-macros repository yet.

If anyone wants to pick it up, any help is appreciated 👍

[dshuvalov]

Hi everyone!

Anyone update about this issue.

After integrating this eslint plugin, I have got this issue.

[lucax88x]

@dshuvalov As you can read there https://github.com/kentcdodds/babel-plugin-macros/issues/141
you can add the stuff as dependency instead of devDependency with no problems

[tricoder42]

@lucax88x Perfect, would you like to send a PR with updated docs? Please next branch as a base, if you do so.

[semoal]

Got this on the the review of the documentation =) Assign me

[tricoder42]

Closed in #768

[dshuvalov]

Thank you guys. Where I can check updated docs?

[tricoder42]

@dshuvalov Latest version from next branch is deployed here https://js-lingui-git-next.lingui-js.now.sh/