@layerzerolabs/solhint-config 1.5.58

package/README.md

@@ -0,0 +1,50 @@
+<h1 align="center">@layerzerolabs/solhint-config</h1>
+
+Shared solhint configuration that defines Solidity rules and their severity for [LayerZero](https://layerzero.network/) codebase. It should be used in all LayerZero repositories containing Solidity contracts to ensure the uniform conventions. The full list of `solhint` rules can be found in [`solhint` repository](https://github.com/protofire/solhint/blob/develop/docs/rules.md).
+
+## Installation
+
+1. Install version of `solhint` package specified in `peerDependencies` section of `package.config`
+2. Install `@layerzerolabs/solhint-config`
+
+```bash
+yarn add --dev @layerzerolabs/solhint-config
+```
+
+## Configuration
+
+Create `solhint.config.js` file to configure `solhint`.
+
+If you want to use only the default rules put the following line in `solhint.config.js`
+
+```javascript
+module.exports = require("@layerzerolabs/solhint-config");
+```
+
+If you want to override the default rules use the following format for `solhint.config.js`
+
+```javascript
+const defaults = require("@layerzerolabs/solhint-config");
+
+module.exports = {
+  ...defaults,
+  rules: {
+    ...defaults.rules,
+    "compiler-version": ["error", "0.8.20"], // override
+  },
+};
+```
+
+## Usage
+
+To lint all files inside `contracts` directory run
+
+```bash
+yarn solhint contracts/**/*.sol
+```
+
+To lint a single file run
+
+```bash
+yarn solhint contracts/MyContract.sol
+```

package/index.js

@@ -0,0 +1,14 @@
+module.exports = {
+    extends: 'solhint:recommended',
+    rules: {
+        'no-global-import': 'error',
+        'compiler-version': 'off',
+        'no-unused-import': 'error',
+        'explicit-types': 'error',
+        'func-name-mixedcase': 'off',
+        'func-visibility': ['warn', { ignoreConstructors: true }],
+        'immutable-vars-naming': 'off',
+        'no-inline-assembly': 'off',
+        'const-name-snakecase': 'error',
+    },
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@layerzerolabs/solhint-config",
+  "version": "1.5.58",
+  "private": false,
+  "description": "LayerZero Solhint Config",
+  "keywords": [
+    "config",
+    "solhint"
+  ],
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "format": "$npm_execpath prettier --ignore-path $(git rev-parse --show-toplevel)/.prettierignore --write .",
+    "lint": "$npm_execpath eslint --no-error-on-unmatched-pattern . --ext .js,.ts --fix"
+  },
+  "devDependencies": {
+    "eslint": "^8.33.0",
+    "prettier": "^2.8.4",
+    "prettier-plugin-packagejson": "^2.4.3"
+  },
+  "peerDependencies": {
+    "solhint": "^4.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}