Function assertHasSnippets

_tools/check_docs.ts:141–164

(
  doc: string,
  document: { jsDoc: JsDoc; location: Location },
)

}

function assertHasSnippets(
  doc: string,
  document: { jsDoc: JsDoc; location: Location },
) {
  const snippets = doc.match(TS_SNIPPET_REGEXP);
  assert(
    snippets !== null,
    "@example tag must have a TypeScript code snippet",
    document,
  );
  if (snippets === null) return;
  for (let snippet of snippets) {
    const delim = snippet.split(NEWLINE)[0];
    // Trim the code block delimiters
    snippet = snippet.split(NEWLINE).slice(1, -1).join(NEWLINE);
    if (!(delim?.includes("no-assert") || delim?.includes("ignore"))) {
      assert(
        snippet.match(ASSERTION_IMPORT_REGEXP) !== null,
        "Snippet must contain assertion from `@std/assert`, `@std/expect` or `@std/testing`",
        document,
      );
    }
  }
}

function assertHasExampleTag(
  document: { jsDoc: JsDoc; location: Location },