Document createDefineConfig

[rijkvanzanten]

Describe the feature

I was just about to open a feature request to suggest adding a util / type to allow the easy creation of your own defineConfig type for use with .ts files, and to my big surprise, it already exists!

c12/src/types.ts

Lines 103 to 108 in d239195

	export function createDefineConfig<
	T extends UserInputConfig = UserInputConfig,
	MT extends ConfigLayerMeta = ConfigLayerMeta
	>(): DefineConfig<T, MT> {
	return (input: InputConfig<T, MT>) => input;
	}

Howeverrrrrrr now I have no clue how to actually use it 👀 A starting point is by copying:

c12/test/types.ts

Lines 4 to 22 in d239195

	interface MyConfig {
	foo: string;
	}
	interface MyMeta {
	metaFoo: string;
	}
	const defineMyConfig = createDefineConfig<MyConfig, MyMeta>();
	const userConfig = defineMyConfig({
	foo: "bar",
	$meta: {
	metaFoo: "bar",
	},
	$development: {
	foo: "bar",
	},
	});

and hacking around, but that leaves me with the question: what's $meta? How is it intended to be used as opposed to "regular" options? The PR that implements it ended with a "resolved in discord discussion" which leaves me hanging 🙈

Happy to open a PR to document this in the readme once the $meta question is answered 🙂👍🏻

Additional information

• Would you be willing to help implement this feature?

[pi0]

Hi dear @rijkvanzanten sorry for answering too late. $meta is a reserved namespace intended for layer meta itself. A configuration such as a layer name, author, repo, creds, etc goes in there separating it from the standard user-intended configuration.