feat: user-defined required constructor options

[gr2m]

closes #60

TODOs

• create examples/required-options folder with a README, code & tests that implements and tests a user-defined required constructor options
• adapt npm test to run all code & type tests from both the root folder
• remove the hard-coded version required option from Base and make it dynamic based on user-defined options instead
• update tests in /index.d-test.ts that test for the required version option and move them to examples/required-options/index.test-d.ts instead

[gr2m]

@JoshuaKGoldberg I think I'm all set from my side, I added the example repository with some code and tests. It's all up for discussion if something is unclear or if you want to suggest a simpler/better implementation

[gr2m]

I forgot about moving the tests for the required option into the new example folder, I added a TODO

• update tests in /index.d-test.ts that test for the required version option and move them to examples/required-options/index.test-d.ts instead

[gr2m]

@JoshuaKGoldberg are you done from your side? Tests are still failing so I'm not sure if you are still looking into it, happy to review it as is and try to fix the remaining problems

[gr2m]

Currently the IntelliSense in VS Code is happy about this code, but tsd fails with

Expected 1 arguments, but got 0

for the last line 👇🏼

const BaseLevelOne = Base.plugin(fooPlugin).defaults({
  defaultOne: "value",
  required: "1.2.3",
});

// Because 'required' is already provided, this needs no argument
new BaseLevelOne();

[JoshuaKGoldberg]

Ah sorry, I ended up running out of time yesterday. Will tackle more tonight!

[gr2m]

no problem at all, I was just checking in

[JoshuaKGoldberg]

This was an odd little issue. tsd was giving different issues the different errors than VS Code's intellisense. My best guess for a root cause would be something about different compiler options in tsd' defaults vs. VS Code's when there isn't a tsconfig.json.

I debugged by adding a debugKeys: NonOptionalKeys<RemainingRequirements<PredefinedOptions>>; in the class returned by ConstructorRequiringVersion's new: 32744ac

...which showed itself to be type never in VS Code but type undefined in tsd. 💡

expectType<{ intentionallyFailAlways: true }>(new BaseLevelOne().debugKeys)

I switched from never to undefined to make sure both variants of possible compiler options work.

[gr2m]

My best guess for a root cause would be something about different compiler options in tsd' defaults

just fyi, here is tsd's default config:

{
	"strict": true,
	"jsx": "react",
	"target": "es2017",
	"lib": ["es2017"],
	"module": "commonjs",
	// The following option is set and is not overridable:
	"moduleResolution": "node"
}

https://github.com/SamVerschueren/tsd#custom-typescript-config

[JoshuaKGoldberg]

@gr2m now it's ready 👍

[gr2m]

awesome work, thanks for making it work, and for the insights on how you debugged the different behavior between tsd and VS Code's IntelliSense

[github-actions]

🎉 This PR is included in version 3.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀