Fix TypeScript error for CommonJS importing

[baseballyama]

Which issue, if any, is this issue related to?

close: #6694

Is there anything in the PR that needs further explanation?

No.

[changeset-bot]

🦋 Changeset detected

Latest commit: bdf385e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
stylelint	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[baseballyama]

Hmmm. CI failed. so I need to dig into the codebase more.

[ybiquitous]

I'm not sure about CommonJS details, but the following form seems to work and pass tests:

module.exports = stylelint;
module.exports.default = stylelint;

In addition, we may need to suppress a TS error like this:

// NOTE: For CommonJS compatibility.
// @ts-expect-error -- TS2339: Property 'default' does not exist on type 'PublicApi'.
module.exports.default = stylelint;

[baseballyama]

Oops, sorry. I did run the test but I couldn't find the test failure😫
Now I think we can pass the test.(I run npm run test-coverage locally and all tests passed.)

[ybiquitous]

Thanks for fixing the error! We can confirm PostCSS also uses the same way:

• https://github.com/postcss/postcss/blob/8.4.21/lib/postcss.js#L101
• Fix usage of default exports with TypeScript postcss/postcss#1459

[jeddy3]

Thanks for fixing the error! We can confirm PostCSS also uses the same way:

I haven't delved deeply into this PR, but is there anything in postcss/postcss#1815 that we need to consider?

[ybiquitous]

@jeddy3 Thanks for the information. It seems to be the same problem, but hard to find a suitable way for all the situations... 🤔

Does anyone have a nice solution?

[baseballyama]

Could you add more context about what postcss/postcss#1815 solves?

After read postcss/postcss#1815 , I tried to update tsconfig.json as below, still I have a type error even after restarting TS server.
So I couldn't get what issue postcss/postcss#1815 solves with my limited knowledge.😫

  "compilerOptions": {
    "module": "commonjs",
    "moduleResolution": "node16",
  }

Property 'utils' does not exist on type 'typeof import("stylelint")'.

[ybiquitous]

In our case, it seems there are no problems. We can check the Stylelint types on https://arethetypeswrong.github.io/, but no problems are found (this website is introduced on postcss/postcss#1815 (comment)).

I have created a small repo to include this PR change:
https://github.com/ybiquitous/stylelint-pr-6695

TypeScript compiler (tsc) complains only the following CommonJS code. This code is reported as a problem on #6694, and it should be fixed by this PR.

const stylelint = require("stylelint");
console.log(stylelint.utils);
//                    ~~~~~ TS2339: Property 'utils' does not exist on type 'typeof import("stylelint")'.

All the files are executed successfully:

$ node index.mjs ; node index.cjs ; node index-default.cjs

{
  report: [Function: report],
  ruleMessages: [Function: ruleMessages],
  validateOptions: [Function: validateOptions],
  checkAgainstRule: [Function: checkAgainstRule]
}
{
  report: [Function: report],
  ruleMessages: [Function: ruleMessages],
  validateOptions: [Function: validateOptions],
  checkAgainstRule: [Function: checkAgainstRule]
}
{
  report: [Function: report],
  ruleMessages: [Function: ruleMessages],
  validateOptions: [Function: validateOptions],
  checkAgainstRule: [Function: checkAgainstRule]
}

In short, I think we can merge safely this PR. Any thoughts?

[jeddy3]

Thanks for checking arethetypeswrong for Stylelint

In short, I think we can merge safely this PR. Any thoughts?

I think so too.

[remcohaszing]

Hey, I saw you referenced my PR for postcss, and you made some wrong conclusions.

This PR actually makes proper type definitions much uglier / more annoying to maintain by making the same mistake that was made in postcss. Can this be reverted, or at least not be released?

It's getting late. I can create a proper PR tomorrow.

[jeddy3]

@remcohaszing Thank you for chiming in. We can hold off releasing it. Your input or a PR would be greatly appreciated!