Skip to content

We may need to allocate a separate package for custom eslint rule lint-rules/validate-jsdoc-codeblocks.js #1384

Description

@salisbury-espinosa

This is a great plugin.
It would be cool to separate it out so it can be used as a dependency in other projects.

It would be great to receive documentation tests (rust like):
https://doc.rust-lang.org/rust-by-example/testing/doc_testing.html#:~:text=The%20primary%20way%20of%20documenting%20a%20Rust,are%20compiled%20and%20used%20as%20documentation%20tests.

example:

/**
 * Adds two numbers.
 *
 * ```ts
 * import { add } from './math';
 *
 * expect(add(1, 2)).toBe(3);
 * ```
 */
export const add = (a: number, b: number): number => a + b;

Type source

No response

Search existing types and issues first

  • I tried my best to look for it

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions