sort builds to prioritize most recent

Author: frangio

package-lock.json

@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@types/mocha": "^7.0.2",
-    "@types/node": "^12.20.37",
+    "@types/node": "^14.18.26",
     "ava": "^4.0.0",
     "c8": "^7.10.0",
     "code-style": "github:OpenZeppelin/code-style",

package.json

@@ -1,5 +1,6 @@
 import { extendConfig, task } from 'hardhat/config';
 import { BuildInfo } from 'hardhat/types';
+import fs from 'fs/promises';
 
 import './type-extensions';
 
@@ -20,9 +21,15 @@ task('docgen', async (_, hre) => {
   const { main } = await import('../main');
 
   const buildInfoPaths = await hre.artifacts.getBuildInfoPaths();
-  const builds: BuildInfo[] = await Promise.all(
-    buildInfoPaths.map(async p => JSON.parse(await fs.readFile(p, 'utf8'))),
+  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,
+    })),
   );
 
-  await main(builds, hre.config.docgen);
+  // Sort most recently modified first
+  builds.sort((a, b) => b.mtime - a.mtime);
+
+  await main(builds.map(b => b.data), hre.config.docgen);
 });

src/hardhat/index.ts

@@ -56,7 +56,6 @@ export function buildSite(builds: Build[], siteConfig: SiteConfig, properties: P
 
   const seen = new Set<string>();
   const allItems: DocItemWithContext[] = [];
-  const topLevelItems: DocItemWithContext[] = [];
   const pages: Record<string, DocItemWithContext[]> = {};
 
   for (let { input, output } of builds) {
@@ -67,8 +66,7 @@ export function buildSite(builds: Build[], siteConfig: SiteConfig, properties: P
     const build = { input, output, deref };
 
     for (const { ast: file } of Object.values(output.sources)) {
-      // Some files may appear in different builds but we only use one.
-      if (seen.has(file.src)) continue;
+      const isNewItem = !seen.has(file.src);
       seen.add(file.src);
 
       for (const topLevelItem of file.nodes) {
@@ -80,18 +78,16 @@ export function buildSite(builds: Build[], siteConfig: SiteConfig, properties: P
           __item_context: { page, item: topLevelItem as DocItemWithContext, file, build },
         });
 
-        topLevelItems.push(withContext);
-        allItems.push(withContext);
-
         if (page !== undefined) {
           (pages[page] ??= []).push(withContext);
         }
 
         for (const item of findAll(docItemTypes, topLevelItem)) {
+          if (isNewItem) allItems.push(item as DocItemWithContext);
           if (item === topLevelItem) continue;
           const contract = topLevelItem.nodeType === 'ContractDefinition' ? topLevelItem : undefined;
-          const __item_context: DocItemContext  = { page, item: item as DocItemWithContext, contract, file, build };
-          allItems.push(Object.assign(item, { __item_context }));
+          const __item_context: DocItemContext = { page, item: item as DocItemWithContext, contract, file, build };
+          Object.assign(item, { __item_context });
         }
       }
     }
@@ -105,7 +101,7 @@ export function buildSite(builds: Build[], siteConfig: SiteConfig, properties: P
   }
 
   return {
-    items: topLevelItems,
+    items: allItems.filter(i => i[DOC_ITEM_CONTEXT].contract === undefined),
     pages: Object.entries(pages).map(([id, items]) => ({ id, items })),
   };
 }