Introduce prototype of a new Solidity resolver

Author: alcuadrado

pnpm-lock.yaml

@@ -66,6 +66,7 @@ export const ERROR_CATEGORIES: {
   },
   ARGUMENTS: { min: 500, max: 599, websiteTitle: "Arguments related errors" },
   BUILTIN_TASKS: { min: 600, max: 699, websiteTitle: "Built-in tasks errors" },
+  SOLIDITY: { min: 700, max: 799, websiteTitle: "Solidity related errors" },
 };
 
 export const ERRORS = {
@@ -473,4 +474,111 @@ Please double check your script's path.`,
 Please check Hardhat's output for more details.`,
     },
   },
+  SOLIDITY: {
+    RESOLVING_INCORRECT_FILE_AS_PROJECT_FILE: {
+      number: 700,
+      messageTemplate:
+        "File {file} is being resolved as a project file, but it's not part of the project.",
+      websiteTitle: "Solidity project file is outside the project",
+      websiteDescription: `Tried to resolve a file as a project file, but it's not part of the project.`,
+    },
+    RESOLVING_NONEXISTENT_PROJECT_FILE: {
+      number: 701,
+      messageTemplate:
+        "File {file} is being resolved as a project file, but it doesn't exist.",
+      websiteTitle: "Solidity project file doesn't exist",
+      websiteDescription: `Tried to resolve a file as a project file, but it doesn't exist.`,
+    },
+    IMPORTED_FILE_DOESNT_EXIST: {
+      number: 702,
+      messageTemplate: 'The import "{importPath} from "{from}" doesn\'t exist.',
+      websiteTitle: "Imported file doesn't exist",
+      websiteDescription: `An imported file doesn't exist.`,
+    },
+    IMPORTED_FILE_WITH_ICORRECT_CASING: {
+      number: 703,
+      messageTemplate:
+        'The import "{importPath} from "{from}" exists, but its casing is incorrect. The correct casing is "{correctCasing}".',
+      websiteTitle: "Imported file with incorrect casing",
+      websiteDescription: `Hardhat enforces that you import your files with the correct casing (as stored in the filesystem).
+
+This error is thrown when you import a file with the wrong casing under a case insensitve filesystem.`,
+    },
+    IMPORTED_NPM_DEPENDENCY_NOT_INSTALLED: {
+      number: 704,
+      messageTemplate:
+        'The import "{importPath}" from "{from}" is trying to use an uinstalled npm dependency.',
+      websiteTitle: "Uninstaleld npm solidity dependency",
+      websiteDescription: `One of your files is traying to import a dependency using npm, but it hasn't been installed`,
+    },
+    IMPORTED_NPM_DEPENDENCY_THAT_USES_EXPORTS: {
+      number: 705,
+      messageTemplate:
+        'The import "{importPath}" from "{from}" is trying to use an npm dependency that uses pacakge#exports, which is not supported by Hardhat.',
+      websiteTitle:
+        "Using a npm solidity dependency with pacakge.json#exports is not supported",
+      websiteDescription: `One of your files is traying to import a dependency using npm, but it uses pacakge.json#exports, which Hardhat doesn't support`,
+    },
+    USER_REMAPPING_WITH_NPM_CONTEXT: {
+      number: 706,
+      messageTemplate:
+        'The remapping "{remapping}" has a context starting with "npm/", which is forbidden. Hardhat doesn\'t allow changing the behaviour of npm package\'s imports.',
+      websiteTitle: "Remapping imports in npm packages is not allowed",
+      websiteDescription: `This error happened because you are trying to change how the imports within an npm package, which is not allowed.
+      
+While Hardhat supports user-defined remappings, it doesn't support remapping the behavior of npm packages to ensure that everything what's imported via npm uses the same npm resolution logic.`,
+    },
+    REMAPPING_WITH_INVALID_SYNTAX: {
+      number: 707,
+      messageTemplate: `The remapping "{remapping}" is invalid.`,
+      websiteTitle: "Invalid remapping",
+      websiteDescription: `You are trying to set a user remapping, but it's syntax is invalid.
+      
+Please double check your remmpaings' syntax.`,
+    },
+    REMAPPING_TO_UNINSTALLED_PACKAGE: {
+      number: 708,
+      messageTemplate: `The remapping "{remapping}" is trying to use the npm package "{package}", which is not installed`,
+      websiteTitle: "Remapping into an uninstaleld npm package",
+      websiteDescription: `You are trying to set a user remapping that uses an npm pacakge as target, but it's not installed.
+      
+Please make sure to install the package or fix the remapping.`,
+    },
+    REMAPPING_TO_PACKAGE_USING_EXPORTS: {
+      number: 709,
+      messageTemplate: `The remapping "{remapping}" is using the npm package "{package}", which uses pacakge.json#exports, which is not supported by Hardhat`,
+      websiteTitle:
+        "Remapping into an npm package that uses pacakge.json#exports",
+      websiteDescription: `You are trying to set a user remapping that uses an npm pacakge as target, but it uses pacakge.json#exports, which Hardhat doesn't support.`,
+    },
+    REMAPPING_NPM_PACKAGE_AS_MONOREPO: {
+      number: 710,
+      messageTemplate: `The remapping "{remapping}" targets the npm pacakge "{pacakge}" as if it were part of this repository, but version "{version}" is installed instead`,
+      websiteTitle:
+        "Remapping into a monorepo package but found an npm package instead",
+      websiteDescription: `You are trying to set a remapping setting a monorepo package as target, but Hardhat found the pacakge to be installed from the npm regristry instead.`,
+    },
+    REMAPPING_HARDHAT_PROJECT_AS_MONOREPO_PACKAGE: {
+      number: 711,
+      messageTemplate: `The remapping "{remapping}" is trying to set the npm package "{package}" as target, but that's the project is the Hardhat project, so it shouldn't be remapped through npm/, but as internal project remappings.`,
+      websiteTitle: `Remapping into the project using npm`,
+      websiteDescription: `You are trying to set a remapping whose target uses the npm/ syntax, but is within your Hardhat project.
+      
+Please don't use npm/... as target, but use normal internal project remapping istead.`,
+    },
+    REMAPPING_INCORRECT_VERSION: {
+      number: 712,
+      messageTemplate: `The remapping "{remapping}" is trying to set the npm package "{package}" version "{expectedVersion}" as target, but found version "{actualVersion}" instead.`,
+      websiteTitle: `Remapping into incorrect npm package version`,
+      websiteDescription: `You are trying to set a remapping into an npm package, but the version that you are using is not the currently installed one.
+      
+Please change your remapping to match the installed version, or installed the correct one.`,
+    },
+    INVALID_NPM_IMPORT: {
+      number: 713,
+      messageTemplate: `The import "{imporPath}" in "{from}" is treated as an npm import as it's first directory doesn't exist in your project, but it's syntax is not that of a valid npm import either.`,
+      websiteTitle: `Invalid npm import`,
+      websiteDescription: `You are trying to import a file that is not a valid npm import. Please double check that you are using the correct syntax.`,
+    },
+  },
 } as const;

v-next/hardhat-errors/src/descriptors.ts

@@ -0,0 +1,3 @@
+const { createConfig } = require("../../config-v-next/eslint.cjs");
+
+module.exports = createConfig(__filename, ["src/index.ts"]);

v-next/resolver/.eslintrc.cjs

@@ -0,0 +1,5 @@
+# Node modules
+/node_modules
+
+# Compilation output
+/dist

v-next/resolver/.gitignore

@@ -0,0 +1,3 @@
+/node_modules
+/dist
+CHANGELOG.md

v-next/resolver/.prettierignore

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Nomic Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

v-next/resolver/LICENSE

@@ -0,0 +1,11 @@
+# Template package
+
+This is a template package with a base configuration that should be shared by other packages.
+
+It sets up the following things:
+
+- Typescript
+- eslint
+- prettier
+- npm scripts
+- package.json' export field

v-next/resolver/README.md

@@ -0,0 +1,65 @@
+{
+  "name": "@nomicfoundation/resolver",
+  "version": "3.0.0",
+  "description": "Hardhat's v3 resolver",
+  "homepage": "https://github.com/nomicfoundation/hardhat/tree/v-next/v-next/template-package",
+  "repository": "github:nomicfoundation/hardhat",
+  "author": "Nomic Foundation",
+  "license": "MIT",
+  "type": "module",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": "./dist/src/index.js"
+  },
+  "keywords": [
+    "ethereum",
+    "smart-contracts",
+    "hardhat"
+  ],
+  "scripts": {
+    "lint": "pnpm prettier --check && pnpm eslint",
+    "lint:fix": "pnpm prettier --write && pnpm eslint --fix",
+    "eslint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "prettier": "prettier \"**/*.{ts,js,md,json}\"",
+    "test": "node --import tsx/esm --test --test-reporter=@ignored/hardhat-vnext-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",
+    "test:only": "node --import tsx/esm --test --test-only --test-reporter=@ignored/hardhat-vnext-node-test-reporter \"test/*.ts\" \"test/!(fixture-projects|helpers)/**/*.ts\"",
+    "pretest": "pnpm build",
+    "build": "tsc --build .",
+    "prepublishOnly": "pnpm build",
+    "clean": "rimraf dist"
+  },
+  "files": [
+    "dist/src/",
+    "src/",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+    "@nomicfoundation/eslint-plugin-hardhat-internal-rules": "workspace:^",
+    "@nomicfoundation/eslint-plugin-slow-imports": "workspace:^",
+    "@ignored/hardhat-vnext-node-test-reporter": "workspace:^3.0.0-next.2",
+    "@nomicfoundation/hardhat-test-utils": "workspace:^",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "c8": "^9.1.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-no-only-tests": "3.1.0",
+    "expect-type": "^0.19.0",
+    "nyc": "^15.1.0",
+    "prettier": "3.2.5",
+    "rimraf": "^5.0.5",
+    "tsx": "^4.11.0",
+    "typescript": "~5.5.0",
+    "typescript-eslint": "7.7.1"
+  },
+  "dependencies": {
+    "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.2",
+    "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.2"
+  }
+}