Document that public folders should be ignored by linters/formatters/assitance tools

[rkrisztian]

Scope

Improves an existing behavior

Compatibility

• This is a breaking change

Feature description

In issue #2345, it was suggested that npx msw init public/ --save creates public/mockServiceWorker.js with markers added to make tools like ESLint ignore the whole file:

/* eslint-disable */
/* tslint:disable */

However, with new tools emerging like Biome, I don't think this solution will scale well. I just want to agree with @kettanaito, because you can't possibly address all such tools. Instead, the documentation should include some extra guidance, like, configuring linter/formatter/assistance tools to ignore public folders completely (if that's not already the case). For example, in Biome you can do something like this (assuming vsc.useIgnoreFile is already enabled to keep my example simple):

{
	"files": {
		"includes": ["**", "!public"]
	}
}

[kettanaito]

Hi, @rkrisztian. Thanks for proposing this.

While I think that is a solid advice to mention somewhere, it has nothing to do with MSW. You should never lint your public directory regardless if you're using this library. It's common sense.

Perhaps we could mention it on the Browser integration page. Would that work?

[rkrisztian]

Yes, that makes sense to me. I think I was essentially proposing the same thing. Maybe with the addition that markers like eslint-disable can be retired at the same time. Maybe not immediately but through a deprecation period.

[kettanaito]

If this sounds interesting to you, I would be grateful for a pull request!