Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
hardhat-preprocessor
Advanced tools
Readme
This plugin allows to pre-process contract source code before compilation
Hardhat preprocessor plugin.
This plugin allow you to specify a function that is executed on every line of all contracts (or specified contracts) so that you can pre-process the code.
A typical example (included) is to remove console.log for production ready contracts.
Note that this plugin, by default, does not touch the filesystem. It happens in memory and transform contract on-demand.
This is done by simply importing the plugin in the hardhat.config.js
It also include a task that can be invoked to render the transformation on disk instead.
npm install hardhat-preprocessor
And add the following statement to your hardhat.config.js
:
import 'hardhat-preprocessor';
Nothing required
hardhat compile
will read config from hardhat.config.ts
and then preprocess in-memory (ie changes will never hit the file system and you won't need to commit the changes).
hardhat-preprocessor
also add a new task: preprocess
hardhat preprocess [--dest <destination folder> --files <specific files or glob pattern to preprocess>]
dest
option is set, it will write in that folder instead (and keep sources intact).files
option is set, it will only pre-process those files or matching glob (instead of all files). The path to the files is relative to the source path.
Eg:npx hardhat preprocess --files Greeter.sol
OR
npx hardhat preprocess --files */*.sol
No extra fields added to the envirobment.
This plugin extends the Hardhat Config with one new field: preprocess
This field is an object with a field : eachLine
that itself is a function that accept the HRE as argument and must return either an object with a transform
field or a promise to such object.
The transform
function expect a string as argument (a line of a contract) and must return a string.
The object containing the transform
function can also have a settings
field that is used for caching. If no settings field is set, no caching will take place and contracts will be recompiled. If the settings field is set, then the contract will be recompiled only if the settings changed.
Note that instead of returning (or resolving a function), it is possible to return undefined to skip the preprocessing entirely. This will recompile contract if the previous invocation had returned something.
Basic example that add a comment on each line:
import 'hardhat-preprocessor';
export default {
preprocess: {
eachLine: (hre) => ({
transform: (line) => line + '// comment at the end of each line',
settings: {comment: true} // ensure the cache is working, in that example it can be anything as there is no option, the preprocessing happen all the time
})
},
};
The plugin comes also with a preprocess function to remove console.log
(achieving the same thing as this plugin but without changing the files on disk)
You can use it as follow :
import {removeConsoleLog} from 'hardhat-preprocessor';
export default {
preprocess: {
eachLine: removeConsoleLog((hre) => hre.network.name !== 'hardhat' && hre.network.name !== 'localhost'),
},
};
In this example the preprocessing do not happen when used against hardhat (testing) or localhost
There are no additional steps you need to take for this plugin to work.
FAQs
Hardhat plugin that can preprocess contracts without writing to filesystem
The npm package hardhat-preprocessor receives a total of 2,307 weekly downloads. As such, hardhat-preprocessor popularity was classified as popular.
We found that hardhat-preprocessor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.