Function lintCheckDocs

gulpfile.mjs:401–468

(dir)

};

const lintCheckDocs = async (dir) => {
  const {
    default: {ESLint},
  } = await import('eslint');
  const esLint = new ESLint({
    overrideConfig: {
      rules: {
        'import/no-unresolved': 0,
        'no-console': 0,
        'react/prop-types': 0,
        'react-hooks/rules-of-hooks': 0,
        '@typescript-eslint/no-unused-expressions': 0,
        'max-len': [
          2,
          {code: 80, ignorePattern: '^(\\s+\\* )?((im|ex)ports?|// ->)\\W.*'},
        ],
      },
    },
  });
  const {default: prettier} = await import('prettier');
  const prettierConfig = await getPrettierConfig();
  const docConfig = {...prettierConfig, printWidth: 75};

  const filePaths = [];
  ['.js', '.d.ts'].forEach((extension) =>
    forEachDeepFile(dir, (filePath) => filePaths.push(filePath), extension),
  );
  await allOf(filePaths, async (filePath) => {
    const code = await promises.readFile(filePath, UTF8);
    await allOf(
      [...(code.matchAll(LINT_BLOCKS) ?? [])],
      async ([_, hint, docBlock]) => {
        if (hint?.trim() == 'override') {
          return; // can't lint orphaned TS methods
        }
        const code = docBlock.replace(/\n +\* ?/g, '\n').trimStart();
        let pretty = code;
        if (!(await prettier.check(code, docConfig))) {
          pretty = await prettier.format(code, docConfig);
          writeFileSync(
            filePath,
            readFileSync(filePath, UTF8).replace(
              docBlock,
              '\n' +
                pretty
                  .trim()
                  .split('\n')
                  .map((line) => (line == '' ? ' *' : ' * ' + line))
                  .join('\n') +
                '\n * ',
            ),
            UTF8,
          );
        }
        const results = await esLint.lintText(pretty);
        if (
          results.filter(
            (result) => result.errorCount > 0 || result.warningCount > 0,