Function test

scripts/write-heading-ids.ts:43–78

Test that getCustomId handles different formats correctly

()

/** Test that getCustomId handles different formats correctly */
function test() {
  expect(
    getCustomId(
      `The line width of each object, in units specified by widthUnits (default pixels). `
    )?.[2],
    undefined,
    'not header'
  );
  expect(getCustomId(`## Learning deck.gl`)?.[2], undefined, 'does not contain code');
  expect(getCustomId(`## Changes to \`TileLayer\``)?.[2], undefined, 'is not api');
  expect(getCustomId(`## \`pickObjects\``)?.[2], '{#pickobjects}', 'single word api');
  expect(getCustomId(`## \`@deck.gl/extensions\``)?.[2], undefined, 'Package name');
  expect(
    getCustomId(`## \`strokeOpacity\` (Number)`)?.[2],
    '{#strokeopacity}',
    'with type annotation 1'
  );
  expect(
    getCustomId(`## \`backgroundPadding:number[]\``)?.[2],
    '{#backgroundpadding}',
    'with type annotation 2'
  );
  expect(
    getCustomId(`## \`onBeforeRender(gl: WebGLRenderingContext)\``)?.[2],
    '{#onbeforerender}',
    'with call signature'
  );
  expect(
    getCustomId(
      `##### \`getWidth\` ([Function](../../developer-guide/using-layers.md#accessors)|Number, optional) ![transition-enabled](https://img.shields.io/badge/transition-enabled-green.svg?style=flat-square")`
    )?.[2],
    '{#getwidth}',
    'with extra flag'
  );
  console.log('All tests pass!\n');
}

/** Traverse all files in the docs directory, append custom ids if necessary */
async function main() {