Provide TypeScript definition and JSDoc

[ybiquitous]

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

Closes #15

Ref: stylelint/stylelint#5725

Is there anything in the PR that needs further explanation?

This change aims to improve the developer experience when using the testRule() utility.

This additionally installs the following package:

npm i -D typescript @types/jest

Also, this supports endLine and endColumn. See stylelint/stylelint#5725

To-do

• I'll test if the change actually works in the stylelint/stylelint repo.
  • Bump jest-preset-stylelint to edge version stylelint#5932

[jeddy3]

Excellent stuff.

The basicChecks stuff is less relevant now that we don't focus on stylistic rules. It's pretty opaque too, and I see it misused when new contributors add new rules.

I suggest we remove the skipBasicChecks property as part of this pull request, and publish a major release. What do you think?

[ybiquitous]

@jeddy3 Thanks for explaining the background. I agree with removing skipBasicChecks. 👍🏼

[jeddy3]

Fantastic!

LGTM - feel free to merge.

Manually tested with stylelint-scales (a plugin pack I maintain).

[jeddy3]

Shall we add three changelog entries after merge?:

• Removed: skipBasicChecks schema property.
• Added: endLine and endColumn schema properties.
• Added: TypeScript definitions.

[ybiquitous]

Can you please merge, update the changelog, and release a new version if possible?

[ybiquitous]

Wait, I find a typo. I try fixing it.

[jeddy3]

Can you please merge, update the changelog, and release a new version if possible?

Can do.

[jeddy3]

Released in 5.0.0

[ybiquitous]

Thank you so much! 🎉