ssssota/doc-vitest

Documentation tests with Vitest

doc-vitest's Issues

Testing md snippets

I have a fairly simple use case where I'm trying to test code snippets in README.md. However, vitest gives Error: Failed to parse source for import analysis because the content contains invalid JS syntax. You may need to install appropriate plugins to handle the .md file format, or if it's an asset, add "**/*.md" to assetsInclude in your configuration.. Any idea what could be wrong?

vite.config.ts:

export default defineConfig({
  plugins: [doctest(), dts({ rollupTypes: true })],
  test: {
    includeSource: ["./src/**/*.[jt]s?(x)", "./README.md"],
  },
  ...
})

versions:

    "vite": "^5.2.11",
    "vite-plugin-doctest": "^1.0.0",
    "vite-plugin-dts": "^3.9.1",
    "vitest": "^1.6.0",

full error stack:

Error: Failed to parse source for import analysis because the content contains invalid JS syntax. You may need to install appropriate plugins to handle the .md file format, or if it's an asset, add "**/*.md" to `assetsInclude` in your configuration.
 ❯ formatError node_modules/.pnpm/[email protected]_@[email protected]/node_modules/vite/dist/node/chunks/dep-cNe07EU9.js:50830:46
 ❯ TransformContext.error node_modules/.pnpm/[email protected]_@[email protected]/node_modules/vite/dist/node/chunks/dep-cNe07EU9.js:50824:19
 ❯ TransformContext.transform node_modules/.pnpm/[email protected]_@[email protected]/node_modules/vite/dist/node/chunks/dep-cNe07EU9.js:66069:22
 ❯ Object.transform node_modules/.pnpm/[email protected]_@[email protected]/node_modules/vite/dist/node/chunks/dep-cNe07EU9.js:51139:30
 ❯ loadAndTransform node_modules/.pnpm/[email protected]_@[email protected]/node_modules/vite/dist/node/chunks/dep-cNe07EU9.js:53894:29

More tests

Markdown support

Support `import` declaration

Sourcemap

type check

for GitHub Actions

Type check

Test discovery in `class`es fails unless all fields contain doctest

Hello! Thank you for this plugin. I sorely missed doctests, coming from Rust.

Here is a minimum example of the issue:

class Foo {
	public constructor() { }

	/** some note about this property */ // ← this causes the test discovery to fail
	private readonly bar: number = 3;

	/**
	 * @import.meta.vitest
	 * ```ts
	 * assert(false);
	 * ```
	 */
	public readonly baz = (): void => { }
}