lint-staged is unable to resolve path to module in Monorepo with map imports

[phuczeero]

lint-staged is unable to resolve path to module in Monorepo with map imports

[imhoffd]

I was able to get the automatic cwd stuff working by having a config in the root of the monorepo and a config for each package as described in the readme.

However, the config in the root actually needs rules in it, otherwise lint-staged exits silently with exit code 1.

In other words, it appears you need something like this if you plan to use lint-staged in a monorepo but don't want any base rules for the monorepo root itself:

./lint-staged.config.cjs

module.exports = {
  '*': 'true'
}

./packages/thing-1/lint-staged.config.cjs

module.exports = {
  '*.{cjs,mjs,js,jsx,ts,tsx}': ['eslint --fix', 'prettier --write'],
}

[phuczeero]

Updated. Because I’m using shared eslint config which resolves tsconfig relative to process.cwd() (details here).
However, I'm still looking for a way to specify the working dir per .lintstagedrc.js in each package.

Feel free to close this thread if it does not make sense, thanks.

[iiroj]

By default monorepo tasks run with the specific config file directory as the root. The npx lint-staged --cwd <some-directory> can be used to override this for all tasks. Would that work for you?

For example, to run all tasks from the monorepo root, probably:

npx lint-staged --cwd $PWD

[phuczeero]

Yup, that works but if using lint-staged with husky, will I have to supply multiple lint-staged commands, so any process.cwd() used inside each package will result in the correct value?

// pre-commit
npx lint-staged --cwd packages/frontend
npx lint-staged --cwd packages/backend

[iiroj]

If you have multiple configs, in packages/frontend and packages/backend for example, the commands in those should already use those directories as CWD for the tasks. Is this not the case?

[phuczeero]

You are correct.
I previously added an empty config at root, follow the monorepo setup document "you can either add an "empty" lint-staged configuration to the root of the repo". When running lint-staged at root, I found process.cwd() resulting the root dir, though there are lint-staged config in each package.
Then update the root config from empty to @imhoffd suggestion and now it works correctly.

[iiroj]

Is there something you think could be fixed, or at least the README updated?

[imhoffd]

Hi @iiroj, thanks for your work on lint-staged. I don't think there are any active bugs in this issue. Here are a few takeaways, if it helps:

1. With an empty root config (e.g. module.exports = {}), lint-staged exits silently with exit code 1. This could probably be improved with an error message if the intention is to require at least one rule.
2. If the intention is to require at least one rule, I would question that. If a root config is necessary, then an empty root config should indicate to lint-staged that no linters need to run. Right now, I have the rule '*': 'true' in my root config because I don't need to run any linters on the monorepo root (yet), so it literally runs the true built-in bash command for all files--I don't see a better way to do this currently.
3. If a root config is necessary, I would further question that. lint-staged appears to correctly identify the root of the monorepo as well as the closest config file. Therefore, a missing root config should indicate to lint-staged that no linters need to run.

Basically, I expected to be able to install lint-staged in the root of my monorepo and add a single lint-staged config file in a package's subdirectory, but that ended up not working without doing some investigation. I was surprised that the root config file was necessary at all.

Thanks again!

[iiroj]

Thanks! The root config itself is not strictly necessary, but in order to activate the "monorepo features", you need at least two valid configuration files. This is because of backwards-compatibility reasons, as lint-staged has supported the (single) configuration file being in a subdirectory of a git repo for a longer time.

Thus, having an "empty config" in the root is a workaround for enabling monorepo features with a single configuration file in one of monorepo's subdirectories.