@k9n/scully-plugin-toc/lib/validator.ts

This plugin for scully provides a postRenderer to generate a table of contents for the rendered route content

import { getPluginConfig } from '@scullyio/scully';

import { TocConfig } from './interfaces';
import { TocPluginName } from './constants';

export const validator = async (/* conf */) => {
  const tocConfig = getPluginConfig<TocConfig>(TocPluginName);
  const errors: string[] = [];

  if (!tocConfig.insertSelector.length) {
    errors.push(
      'Option "insertSelector" for "toc" must be a valid string (e.g. "#toc").',
    );
  }

  if (!tocConfig.blogAreaSelector.length) {
    errors.push(
      'Option "blogAreaSelector" for "toc" must be a valid string (e.g. ".blog-content").',
    );
  }

  if (tocConfig.level && !tocConfig.level.length) {
    errors.push(
      `Option "level" for "toc" must be an array containing headings to list (e.g.: "['h2', 'h3']".`,
    );
  }

  return errors;
};