Replace deprecated dtslint

[MikeMcC399]

What would you like?

Replace the use of the deprecated npm module dtslint "A utility built on TSLint for linting TypeScript declaration (.d.ts) files."

cypress/cli/package.json

Line 94 in 5afb929

"dtslint": "4.2.1",

Why is this needed?

The npm module dtslint is deprecated and the source repo https://github.com/Microsoft/dtslint was archived on Nov 16, 2023. [email protected] was the final version released.

See https://aka.ms/type-testing-tools which shows:

If you are just looking for a TypeScript type testing tool, use:

• tsd
• eslint-plugin-expect-type
• tstyche

dtslint is used in Cypress CI workflows, in the job

lint-types

cypress/.circleci/workflows.yml

Lines 1608 to 1622 in 6bf0257

	lint-types:
	<<: *defaults
	parallelism: 1
	steps:
	- restore_cached_workspace
	- run:
	command: ls -la types
	working_directory: cli
	- run:
	command: ls -la chai
	working_directory: cli/types
	- run:
	name: "Lint types 🧹"
	command: yarn workspace cypress dtslint
	- store-npm-logs

Other

• Relates to issue dtslint TypeError: DeprecationError: 'originalKeywordKind' #30063

[jennifer-shehane]

I vote for tsd with how we're using it. Seemed not too bad to replace to that one.

[jennifer-shehane]

@MikeMcC399 There's a lot of dep updates we need highlighted in this issue btw: #3777

[MikeMcC399]

@jennifer-shehane

There's a lot of dep updates we need highlighted in this issue btw: #3777

• Looks like a general clean-up of TypeScript is needed if Dependency Dashboard #3777 is showing so many @types deprecations.

I just looked at the first one on the list https://www.npmjs.com/package/@types/chalk which says:

This package has been deprecated

Author message:

This is a stub types definition for chalk (https://github.com/chalk/chalk). chalk provides its own type definitions, so you don't need @types/chalk installed!

so there may be scope for simplification / removal with other related packages.

[jennifer-shehane]

@MikeMcC399 Yah, open to any PRs from anything in there. I've been whittling away at the list as much as I have time.

[MikeMcC399]

@jennifer-shehane

Yah, open to any PRs from anything in there. I've been whittling away at the list as much as I have time.

I guess I could take a look at these and see how I fare! 🙂

[MikeMcC399]

@jennifer-shehane

• None of the remaining deprecations in the list on Dependency Dashboard #3777 are simple updates. They either require dependent version updates or complete migrations, so at this time I don't expect to tackle any of the others on this list as I am lacking the background experience with the modules concerned. If it would be helpful I could submit a separate single issue with the consolidated findings for necessary steps or I could add a separate commented issue for each deprecation. Let me know if you want this or if I should just leave it to you.

[jennifer-shehane]

Yah, any ideas on updates could be helpful. A lot of us are relearning these deps use cases as well, so I do think you're likely as well positioned as we are to update.

[MikeMcC399]

@jennifer-shehane

Yah, any ideas on updates could be helpful. A lot of us are relearning these deps use cases as well, so I do think you're likely as well positioned as we are to update.

OK. I'll do separate issues as they are easier to manage in terms of assignment, tracking, etc.

[mrazauskas]

I vote for tsd with how we're using it. Seemed not too bad to replace to that one.

@jennifer-shehane Just to draw your attention, the following test is passing:

import { expectType, expectNotType, expectAssignable, expectNotAssignable } from "tsd";

type Target = { a: { b: 1 } };

expectType<Target>({ a: { b: 1 } });
expectNotType<Target>({ a: { b: 1 } });

expectAssignable<Target>({ a: { b: 1 } });
expectNotAssignable<Target>({ a: { b: 1 } });

This issue is known for years, see: tsdjs/tsd#141. The solution is also known and was mentioned here: tsdjs/tsd#196. (By the way, there are many other improvements mention in this issue, but nothing was done for a year.)

I was maintaining forked tsd-lite. It was fixing several problems and limitations: monorepo support, testing on specific version of TypeScript, etc. Some things were not possible to improve and the reason was internal architecture of the library. For instance, @tsd/typescript is required. This is just a copy of TypeScript with few patched lines, but it makes the install size of tsd to reach 48.0MB.

So I decided to write a type testing tool from scratch: mrazauskas/tsd-lite#364

---

This is how TSTyche was born.

• It loads TypeScript that is already installed, so the install size is only 219kB;
• Allows testing on specific versions of Typescript: tstyche --target 5.0,latest;
• Has test() and describe() to organize larger tests and makes it easy to debug using .only and .skip.

And there is much more. For instance, documentation website: https://tstyche.org

---

By the way, immutable.js was recently migrating away from dtslint. Their first idea was to use tsd (immutable-js/immutable-js#1985), but after I have pointed to some oddities (immutable-js/immutable-js#1986) they decided to use TSTyche (immutable-js/immutable-js#1988).

I was helping them with migration. I would be happy to migrate cypress type tests too. Let me know if that sounds interesting.

[MikeMcC399]

@jennifer-shehane

Yah, any ideas on updates could be helpful. A lot of us are relearning these deps use cases as well, so I do think you're likely as well positioned as we are to update.

OK. I'll do separate issues as they are easier to manage in terms of assignment, tracking, etc.

• All the deprecations are now covered by individual issues which are also linked to Dependency Dashboard #3777.

[mrazauskas]

By the way, the following script is not working as intended:

cypress/npm/vue/package.json

Line 14 in 195cdb1

"tsd": "yarn build && yarn tsc -p test-tsd/tsconfig.tsd.json",

Just add --listFilesOnly to the command and you will see a list of .d.ts files, but none of the files within the npm/vue/test-tsd directory.

The culprit is here:

cypress/npm/vue/test-tsd/tsconfig.tsd.json

Lines 12 to 15 in 195cdb1

	"include": [
	"../dist",
	"../test-dts"
	]

The directory name is test-tsd (not test-dts). This means that the mentioned script was never type checking the files within the test-tsd directory. If you fix this typo, the script will fail.

---

@lmiller1990 If I got it right, the typo was introduced in #22757.

[MikeMcC399]

@mrazauskas

Thanks for your detective work regarding the vue package! Would you like to open a separate issue and/or PR for this, as it is not really well placed here.