Add dontOverrideCompile setting and fix a bug (#714)

Co-authored-by: Patricio Palladino <email@patriciopalladino.com>

Author: krzkaczor

Diff for: .changeset/five-onions-notice.md

@@ -0,0 +1,5 @@
+---
+"@typechain/hardhat": patch
+---
+
+Add `dontOverrideCompile` setting

Diff for: examples/hardhat-truffe-v5/package.json

@@ -24,7 +24,7 @@
     "chai-as-promised": "^7.1.1",
     "chai-bn": "^0.2.1",
     "dotenv": "^8.2.0",
-    "hardhat": "^2.0.10",
+    "hardhat": "^2.9.9",
     "ts-generator": "0.0.8",
     "ts-node": "^10.7.0",
     "typechain": "workspace:^8.0.0",

Diff for: examples/hardhat/package.json

@@ -27,7 +27,7 @@
     "@ethersproject/providers": "5.4.0",
     "@ethersproject/contracts": "5.4.0",
     "@ethersproject/abi": "5.4.0",
-    "hardhat": "^2.0.10",
+    "hardhat": "^2.9.9",
     "ts-node": "^10.7.0",
     "typechain": "workspace:^8.0.0",
     "typescript": "^4.6"

Diff for: packages/hardhat-test/package.json

@@ -21,7 +21,7 @@
     "@typechain/ethers-v5": "workspace:^10.0.0",
     "@typechain/hardhat": "workspace:^6.0.0",
     "ethers": "^5.4.7",
-    "hardhat": "^2.0.10",
+    "hardhat": "^2.9.9",
     "test-utils": "1.0.0",
     "typechain": "workspace:^8.0.0"
   }

Diff for: packages/hardhat/README.md

@@ -104,6 +104,7 @@ module.exports = {
     target: 'ethers-v5',
     alwaysGenerateOverloads: false, // should overloads with full signatures like deposit(uint256) be generated always, even if there are no overloads?
     externalArtifacts: ['externalArtifacts/*.json'], // optional array of glob patterns with external artifacts to process (for example external libs from node_modules)
+    dontOverrideCompile: false // defaults to true for javascript projects
   },
 }
 ```

Diff for: packages/hardhat/package.json

@@ -42,7 +42,7 @@
     "@types/lodash": "^4.14.139",
     "@types/rimraf": "^3.0.0",
     "ethers": "^5.4.7",
-    "hardhat": "^2.0.10",
+    "hardhat": "^2.9.9",
     "rimraf": "^3.0.2",
     "typechain": "workspace:^8.0.0",
     "typescript": "^4"
@@ -52,7 +52,7 @@
     "@ethersproject/providers": "^5.4.7",
     "@typechain/ethers-v5": "workspace:^10.0.0",
     "ethers": "^5.4.7",
-    "hardhat": "^2.0.10",
+    "hardhat": "^2.9.9",
     "typechain": "workspace:^8.0.0"
   }
 }

Diff for: packages/hardhat/src/config.ts

@@ -9,6 +9,7 @@ export function getDefaultTypechainConfig(config: HardhatConfig): TypechainConfi
     alwaysGenerateOverloads: false,
     discriminateTypes: false,
     tsNocheck: false,
+    dontOverrideCompile: config.paths.configFile.endsWith('.js'),
   }
 
   return {

Diff for: packages/hardhat/src/index.ts

@@ -16,11 +16,11 @@ extendConfig((config) => {
   config.typechain = getDefaultTypechainConfig(config)
 })
 
-task(TASK_COMPILE, 'Compiles the entire project, building all artifacts')
+task(TASK_COMPILE)
   .addFlag('noTypechain', 'Skip Typechain compilation')
-  .setAction(async ({ noTypechain }: { global: boolean; noTypechain: boolean }, _, runSuper) => {
+  .setAction(async ({ noTypechain }: { global: boolean; noTypechain: boolean }, { config }, runSuper) => {
     // just save task arguments for later b/c there is no easier way to access them in subtask
-    taskArgsStore.noTypechain = noTypechain!!
+    taskArgsStore.noTypechain = noTypechain!! || config.typechain.dontOverrideCompile
 
     await runSuper()
   })
@@ -37,9 +37,7 @@ subtask(TASK_TYPECHAIN_GENERATE_TYPES)
   .addParam('compileSolOutput', 'Solidity compilation output', {}, types.any)
   .setAction(async ({ compileSolOutput }, { config, artifacts }) => {
     const artifactFQNs: string[] = getFQNamesFromCompilationOutput(compileSolOutput)
-    const artifactPaths = uniq(
-      artifactFQNs.map((fqn) => (artifacts as any)._getArtifactPathFromFullyQualifiedName(fqn)),
-    )
+    const artifactPaths = uniq(artifactFQNs.map((fqn) => artifacts.formArtifactPathFromFullyQualifiedName(fqn)))
 
     if (taskArgsStore.noTypechain) {
       return compileSolOutput
@@ -107,7 +105,7 @@ task(
   'Clears the cache and deletes all artifacts',
   async ({ global }: { global: boolean }, { config }, runSuper) => {
     if (global) {
-      return
+      return runSuper()
     }
 
     if (await fsExtra.pathExists(config.typechain.outDir)) {

Diff for: packages/hardhat/src/types.ts

@@ -5,6 +5,7 @@ export interface TypechainConfig {
   discriminateTypes: boolean
   tsNocheck: boolean
   externalArtifacts?: string[]
+  dontOverrideCompile: boolean
 }
 
 export interface TypechainUserConfig extends Partial<TypechainConfig> {}

Diff for: packages/hardhat/test/fixture-projects/no-override-project/contracts/c.sol

@@ -0,0 +1,4 @@
+pragma solidity ^0.7.3;
+
+contract C {
+}

Diff for: packages/hardhat/test/fixture-projects/no-override-project/hardhat.config.ts

@@ -0,0 +1,14 @@
+// We load the plugin here.
+import '../../../src/index'
+
+import { HardhatUserConfig } from 'hardhat/types'
+
+const config: HardhatUserConfig = {
+  solidity: '0.7.3',
+  defaultNetwork: 'hardhat',
+  typechain: {
+    dontOverrideCompile: true,
+  },
+}
+
+export default config

Diff for: packages/hardhat/test/project.test.ts

@@ -131,6 +131,30 @@ describe('Typechain x Hardhat', function () {
   })
 })
 
+describe('dontOverrideCompile', function () {
+  useEnvironment('no-override-project')
+  let originalCwd: typeof process.cwd
+
+  beforeEach(async function () {
+    originalCwd = process.cwd
+    await this.hre.run('clean')
+  })
+
+  this.afterEach(() => {
+    process.cwd = originalCwd
+  })
+
+  it('should desible typechain for the compile task', async function () {
+    const exists = existsSync(this.hre.config.typechain.outDir)
+    expect(exists).toEqual(false)
+
+    await this.hre.run('compile')
+
+    const existsAfter = existsSync(this.hre.config.typechain.outDir)
+    expect(existsAfter).toEqual(false)
+  })
+})
+
 const contractDir = join(__dirname, 'fixture-projects/hardhat-project/contracts')
 const fixtureFilesDir = join(__dirname, 'fixture-files')
 const TestContract2OriginPath = join(fixtureFilesDir, 'TestContract2.sol')