Prepare Hardhat 3 and Solidstate release

README.md

@@ -2,42 +2,44 @@
 
 Output Solidity contract sizes with Hardhat.
 
+> Versions of this plugin prior to `3.0.0` were released as `hardhat-contract-sizer`, outside of the `@solidstate` namespace.
+
 > Versions of this plugin prior to `2.0.0` were released as `buidler-contract-sizer`.
 
 ## Installation
 
 ```bash
-npm install --save-dev hardhat-contract-sizer
+npm install --save-dev @solidstate/hardhat-contract-sizer
 # or
-yarn add --dev hardhat-contract-sizer
+yarn add --dev @solidstate/hardhat-contract-sizer
 ```
 
 ## Usage
 
 Load plugin in Hardhat config:
 
 ```javascript
-require('hardhat-contract-sizer');
+require('@solidstate/hardhat-contract-sizer');
 ```
 
 Add configuration under the `contractSizer` key:
 
-| option              | description                                                                                                                 | default |
-| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `alphaSort`         | whether to sort results table alphabetically (default sort is by contract size)                                             | `false` |
-| `runOnCompile`      | whether to output contract sizes automatically after compilation                                                            | `false` |
-| `disambiguatePaths` | whether to output the full path to the compilation artifact (relative to the Hardhat root directory)                        | `false` |
-| `strict`            | whether to throw an error if any contracts exceed the size limit (may cause compatibility issues with `solidity-coverage`)  | `false` |
-| `only`              | `Array` of `String` matchers used to select included contracts, defaults to all contracts if `length` is 0                  | `[]`    |
-| `except`            | `Array` of `String` matchers used to exclude contracts                                                                      | `[]`    |
-| `outputFile`        | file path to write contract size report                                                                                     | `null`  |
-| `unit`              | unit of measurement for the size of contracts, which can be expressed in 'B' (bytes), 'kB' (kilobytes) or 'KiB' (kibibytes) | `KiB`   |
+| option         | description                                                                                                                 | default |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `alphaSort`    | whether to sort results table alphabetically (default sort is by contract size)                                             | `false` |
+| `runOnCompile` | whether to output contract sizes automatically after compilation                                                            | `false` |
+| `flat`         | whether to hide the full path to the compilation artifact and output only the contract name                                 | `false` |
+| `strict`       | whether to throw an error if any contracts exceed the size limit (may cause compatibility issues with `solidity-coverage`)  | `false` |
+| `only`         | `Array` of `String` matchers used to select included contracts, defaults to all contracts if `length` is 0                  | `[]`    |
+| `except`       | `Array` of `String` matchers used to exclude contracts                                                                      | `[]`    |
+| `outputFile`   | file path to write contract size report                                                                                     | `null`  |
+| `unit`         | unit of measurement for the size of contracts, which can be expressed in 'B' (bytes), 'kB' (kilobytes) or 'KiB' (kibibytes) | `KiB`   |
 
 ```javascript
 contractSizer: {
   alphaSort: true,
-  disambiguatePaths: false,
   runOnCompile: true,
+  flat: true,
   strict: true,
   only: [':ERC20$'],
 }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "hardhat-contract-sizer",
-  "version": "2.10.0",
+  "name": "@solidstate/hardhat-contract-sizer",
+  "version": "3.0.0",
   "license": "MIT",
   "description": "Output Solidity contract sizes with Hardhat",
   "keywords": [
@@ -15,7 +15,7 @@
     "wow",
     "bytecode"
   ],
-  "repository": "https://github.com/ItsNickBarry/hardhat-contract-sizer",
+  "repository": "github:solidstate-network/hardhat-contract-sizer",
   "author": "Nick Barry",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -47,5 +47,8 @@
     "chalk": "^4.0.0",
     "cli-table3": "^0.6.0",
     "strip-ansi": "^6.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

src/index.ts

@@ -7,8 +7,8 @@ declare module 'hardhat/types/config' {
   interface HardhatUserConfig {
     contractSizer?: {
       alphaSort?: boolean;
-      disambiguatePaths?: boolean;
       runOnCompile?: boolean;
+      flat?: boolean;
       strict?: boolean;
       only?: string[];
       except?: string[];
@@ -20,8 +20,8 @@ declare module 'hardhat/types/config' {
   interface HardhatConfig {
     contractSizer: {
       alphaSort: boolean;
-      disambiguatePaths: boolean;
       runOnCompile: boolean;
+      flat: boolean;
       strict: boolean;
       only: string[];
       except: string[];
@@ -35,8 +35,8 @@ extendConfig((config, userConfig) => {
   config.contractSizer = Object.assign(
     {
       alphaSort: false,
-      disambiguatePaths: false,
       runOnCompile: false,
+      flat: false,
       strict: false,
       only: [],
       except: [],

src/tasks/size_contracts.ts

@@ -5,6 +5,7 @@ import fs from 'fs';
 import { TASK_COMPILE } from 'hardhat/builtin-tasks/task-names';
 import { task } from 'hardhat/config';
 import { HardhatPluginError } from 'hardhat/plugins';
+import { parseFullyQualifiedName } from 'hardhat/utils/contract-names';
 import path from 'path';
 import stripAnsi from 'strip-ansi';
 
@@ -89,9 +90,9 @@ task('size-contracts', 'Output the size of compiled contracts')
 
         outputData.push({
           fullName,
-          displayName: config.disambiguatePaths
-            ? fullName
-            : fullName.split(':').pop() ?? '',
+          displayName: config.flat
+            ? parseFullyQualifiedName(fullName).contractName
+            : fullName,
           deploySize,
           previousDeploySize: previousSizes[fullName],
           initSize,
@@ -100,6 +101,18 @@ task('size-contracts', 'Output the size of compiled contracts')
       }),
     );
 
+    outputData.reduce((acc, { displayName }) => {
+      if (acc.has(displayName)) {
+        throw new HardhatPluginError(
+          pluginName,
+          `ambiguous contract name: ${displayName}`,
+        );
+      }
+
+      acc.add(displayName);
+      return acc;
+    }, new Set());
+
     if (config.alphaSort) {
       outputData.sort((a, b) =>
         a.displayName.toUpperCase() > b.displayName.toUpperCase() ? 1 : -1,