solidity-docgen/src/hardhat/index.ts

Documentation generator for Solidity smart contracts.

import { extendConfig, task } from 'hardhat/config';
import { BuildInfo } from 'hardhat/types';
import fs from 'fs/promises';

import './type-extensions';

extendConfig((config, userConfig) => {
  const path = require('path') as typeof import('path');
  config.docgen ??= {};
  config.docgen.root = config.paths.root;
  config.docgen.sourcesDir = path
    .relative(config.paths.root, config.paths.sources)
    .split(path.sep)
    .join(path.posix.sep);
});

task('docgen', async (_, hre) => {
  await hre.run('compile');

  const { promises: fs } = await import('fs');
  const { main } = await import('../main');

  const buildInfoPaths = await hre.artifacts.getBuildInfoPaths();
  const builds = await Promise.all(
    buildInfoPaths.map(async p => ({
      mtime: (await fs.stat(p)).mtimeMs,
      data: JSON.parse(await fs.readFile(p, 'utf8')) as BuildInfo,
    })),
  );

  // Sort most recently modified first
  builds.sort((a, b) => b.mtime - a.mtime);

  await main(builds.map(b => b.data), hre.config.docgen);
});