Allow specifying the test files and typings file manually

[smartclash]

PR 1 of 2. Checkout the 2nd PR here #75

This PR aims to add two more options: testFiles and typingsFile apart from cwd. These are optional and allows developers to manually specify the files which may be somewhere else in the project instead of forcing them to follow a pattern that TSD expects.

This allows us to use TSD in Jest and many other test frameworks so developers can check type definitions without leaving ecosystem.

By merging this, TSD can be used in many ways

Method 1:

Let TSD figure out everything by itself. Uses process.cwd(). Works the way it used to work.

const diagnose = await tsd();

Method 2:

Pass cwd and also the relative path to typingsFile only.

const diagnose = await tsd({
  cwd: path.join(__dirname, '/custom/path'),
  typingsFile: 'someName.d.ts'
});

Method 3:

Pass cwd and also the relative path to testFiles.

const diagnose = await tsd({
  cwd: path.join(__dirname, '/custom/path'),
  testFiles: [
    '/somewhere/app.test.ts',
    '/somewhere/else/math.test.ts'
  ]
});

Method 4:

Pass cwd and pass relative paths to both typingsFile and testFiles.

const diagnose = await tsd({
  cwd: path.join(__dirname, '/custom/path'),
  typingsFile: 'someName.d.ts',
  testFiles: [
    '/somewhere/app.test.ts',
    '/somewhere/else/math.test.ts'
  ]
});

[Ethan-Arrowood]

LGTM, can you add some unit tests?

[smartclash]

Hey, I've added some unit tests. @Ethan-Arrowood. Thanks :)

[SamVerschueren]

I like the idea. However, I believe we should go for globbing patterns for the testFiles with globby. It will still accept the array as you provided, but also allow globbing patterns to resolve the files.

Other than that, good idea to add this!

[smartclash]

Hey @SamVerschueren, testFiles option now accepts globbing patterns. Uses globby under the hood.

[SimenB]

@SamVerschueren @Ethan-Arrowood ping 🙂

[Ethan-Arrowood]

This looks good. Tests are great too! Good work 😁

[smartclash]

Yay, thanks. Also, there's another PR #75 you might want to checkout after this one

[fregante]

Hoping to see this merged. In a project with a build step, tsd is currently requiring me to keep index.test-d.ts in the dist folder.

[sindresorhus]

Same as above (needs to answer what its purpose is) and you're missing a dot at the end.

[SimenB]

Is this good to go now? 🙂 We're currently using a fork, would be lovely to use the mainline 👍

[smartclash]

I've made the changes. Let me know if it's all good @SamVerschueren :)

[SamVerschueren]

Awesome! Thanks for working on this 🙏 !