Docs: CommonJS examples

[bukowa]

Docs page(s)

https://eslint.org/docs/latest/use/configure/rules#using-configuration-files

solution:

module.exports =  {
    // Other ESLint configuration settings...
    rules: {
        // Other rules...
        'vue/multi-word-component-names': 'off'
    }
};

[mdjermanovic]

Hi @bukowa, thanks for the issue!

ESLint configuration files can be ESM or CommonJS, as explained in the Configuration Files docs:

https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file.

I don't think we should clutter the documentation by showing every example in both formats, as examples in the two formats would be pretty much the same except for the difference in importing and exporting.

Perhaps we could update the documentation so that the "configuration file" text before examples is always a link to the Configuration Files docs?

@eslint/eslint-team thoughts?

[snitin315]

I agree, we don't need to show examples in both the formats.

Perhaps we could update the documentation so that the "configuration file" text before examples is always a link to the Configuration Files docs?

Adding a link sounds good to me 👍🏻 . Should we target "configuration files" text in headings or normal paragraph text?

[Tanujkanti4441]

What if we give both the examples in single container that will be shown up by corresponding buttons of ESM and CommonJS
something like this:

[bukowa]

That looks great, it also instantly shows what is the difference and why there's a difference!

[snitin315]

This will increase maintenance overhead, we will need to write two different examples.

[nzakas]

We do already have a tabs component:
https://eslint.org/docs/latest/component-library/code-tabs

But I agree with @mdjermanovic and @snitin315, I think providing two formats for every example is too much overhead and will likely lead to errors going forward. Unless there's a way to automatically generate the CommonJS version and the tabs, then I think adding a link is the best option.

[Tanujkanti4441]

agreed for adding a link, as @mdjermanovic suggested i also feel it would be good to add a text as link before the example that will be easily visible to readers.

[mdjermanovic]

Here's a PR to add links: #18535