IntelliSense for config

Packages that ship with TypeScript typings can leverage IDE’s intellisense with jsdoc type hints in JS files.

Vite

/**
 * @type {import('vite').UserConfig}
 */
const config = {
  // ...
}

export default config

SvelteKit

/**
 * @type {import('@sveltejs/kit').Config}
 */
const config = {
	// ...
};

export default config;

Tailwind

/** @type {import("@types/tailwindcss/tailwind-config").TailwindConfig } */

Unfortunately I cannot get this working with MDsveX:

/**
 * @type {import('mdsvex').MdsvexOptions}
 **/
const config = {
	extensions: ['.svx', '.md']
};

module.exports = config;

config is still any

I noticed when typing out the path for the others the types/ts files are listed:

But when doing the same for mdsvex no typescript files are shown:

Perhaps its an issue how the types are being bundled? (I have no idea how the npm packaging works but just a guess)

---

Its not majorly important but it is nice 😄

_Originally posted by @michael0liver in https://github.com/pngwn/MDsveX/discussions/280_

[pngwn]

I’m not actually using it, it is probably just a leftover from my struggles to generate types the way I wanted to. I’m using rollup-plugin-dts to generate type iirc. This is because I want to bundle types together as much as possible and not require that a bunch of transitory dependencies have to be installed just for types. The TS compiler does not support this out of the box.

[pngwn]

V1 is being worked and will support both:

/**
 * @type {import('mdsvex').MdsvexOptions}
 **/
 export const mdsvex_config = { ... };

And a config function that provides types:

import { config } from 'mdsvex';

export const mdsvex_config = config({ ... });

This is similar to how vite works.