Skip to main content

合约开发配置模板

代码格式化​

  1. 安装格式化工具
npm install --save-dev prettier prettier-plugin-solidity
  1. 添加.prettierrc

.prettierrc是指格式化规则，参考如下

{
  "overrides": [
    {
      "files": "*.sol",
      "options": {
        "bracketSpacing": false,
        "printWidth": 100,
        "tabWidth": 4,
        "useTabs": false,
        "singleQuote": false,
        "explicitTypes": "always"
      }
    },
    {
      "files": "*.ts",
      "options": {
        "printWidth": 100,
        "semi": false,
        "trailingComma": "es5"
      }
    }
  ]
}
  1. 添加.prettierignore

.prettierignore是指要把哪些目录忽略格式化，类似于.gitignore.参考:

node_modules
artifacts
cache
coverage*
gasReporterOutput.json
  1. 安装 Vscode 的 Prettier 插件

Vscode 安装Prettier

在 vscode 的settings.json里添加以下配置，保存代码时自动格式化代码

"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
  "source.fixAll": true
},
"editor.defaultFormatter": "esbenp.prettier-vscode"