javierbrea / eslint-plugin-boundaries / 40861020225

100%

master: 100%

push

github

docs: Explain how to import the plugin with nodenext, node16 or require() (#585)

* docs(#584): Explain how to import the plugin with nodenext, node16 or require()

The TypeScript Support guide says that, with nodenext, node16 or require(), TypeScript types the default imports of the plugin, /recommended and /strict as { default: ... }, and that /config exports createConfig and the configs with the right types. Its path aliases example no longer sets baseUrl, and it says that the constants and type guards are exported from /config.

The e2e project type-checks the example of the guide with nodenext, and checks that require() of the three entry points returns the plugin and the configs.

Part of #584

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(#584): Move the nodenext workaround of the TypeScript guide to its troubleshooting section

The workaround is now an entry of the troubleshooting section, titled after the problem: it shows the TS2339 error, the import from /config and the warning about .default, and folds the explanation and the full example in a details block. The path aliases and type exports paragraphs are shorter.

Part of #584

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(#584): Check that require() of /config loads createConfig and the strict config

The createConfig-commonjs e2e config loads them from /config with require(), as the TypeScript Support guide recommends for require(), and lints the basic fixture with the strict rules. Unlike the other CommonJS configs, it type-checks with no @ts-expect-error.

Part of #584

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(#584): Say that the paths are relative to the tsconfig.json file only without baseUrl

With baseUrl set, TypeScript resolves the paths against it, so the sentence of the path aliases example now applies only to configs without baseUrl.

Part of #584

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(#584):... (continued)

2135 of 2135 branches covered (100.0%)

Branch coverage included in aggregate %.

2663 of 2663 relevant lines covered (100.0%)

1383.86 hits per line