checks.js

module.exports = {
  checkList: {
    content_readme: {
      config: 'base',
      kind: 'content_contain_string',
      file: 'README.md',
      contains: ['Voxgig'],
    },

    exist_codeconduct: {
      config: 'base',
      kind: 'file_exist',
      file: 'CODE_OF_CONDUCT.md',
    },

    exist_dist: {
      config: 'ts',
      kind: 'fileX_exist_if_contain_json',
      fileX: '',
      file: 'package.json',
      contains: ['main'],
      contains_type: 'key',
      contains_is_not: 'dist/index.js',
    },

    exist_entry: {
      config: 'js',
      kind: 'fileX_exist_if_contain_json',
      fileX: '',
      file: 'package.json',
      contains: ['main'],
      contains_type: 'key',
      contains_is_not: 'index.js',
    },

    exist_license: {
      config: 'base',
      kind: 'file_exist',
      file: 'LICENSE',
    },

    exist_pkgjson: {
      config: 'base',
      kind: 'file_exist',
      file: 'package.json',
    },

    exist_readme: {
      config: 'base',
      kind: 'file_exist',
      file: 'README.md',
    },

    readme_headings: {
      config: 'base',
      kind: 'content_contain_markdown',
      file: 'README.md',
      contains: [
        { type: 'heading', depth: 1, text: '<package.name>' },
        { type: 'heading', depth: 2, text: 'Install' },
        { type: 'heading', depth: 2, text: 'Quick Example' },
        { type: 'heading', depth: 2, text: 'More Examples' },
        { type: 'heading', depth: 2, text: 'Motivation' },
        { type: 'heading', depth: 2, text: 'Support' },
        { type: 'heading', depth: 2, text: 'API' },
        { type: 'heading', depth: 2, text: 'Contributing' },
        { type: 'heading', depth: 2, text: 'Background' },
      ],
    },

    test_pkgjson: {
      config: 'base',
      kind: 'content_contain_json',
      file: 'package.json',
      contains: ['scripts', 'test'],
      contains_type: 'key',
    },

    check_default: {
      config: 'base',
      kind: 'check_branch',
      branch: 'main',
    },

    version_codeconduct: {
      config: 'base',
      kind: 'content_contain_string',
      file: 'CODE_OF_CONDUCT.md',
      contains: [
        'version 2.1',
        'https://www.contributor-covenant.org/version/2/1/',
      ],
    },
  },
}