{"id":23099971,"url":"https://github.com/keep-network/solium-config-keep","last_synced_at":"2025-04-03T20:42:22.050Z","repository":{"id":47343849,"uuid":"190602027","full_name":"keep-network/solium-config-keep","owner":"keep-network","description":"Standard configuration for linting Solidity code using ethlint/Solium.","archived":false,"fork":false,"pushed_at":"2022-12-06T06:05:33.000Z","size":465,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-02-09T08:44:48.364Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keep-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-06T15:07:50.000Z","updated_at":"2021-05-20T15:00:21.000Z","dependencies_parsed_at":"2023-01-23T07:30:21.041Z","dependency_job_id":null,"html_url":"https://github.com/keep-network/solium-config-keep","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keep-network%2Fsolium-config-keep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keep-network%2Fsolium-config-keep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keep-network%2Fsolium-config-keep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keep-network%2Fsolium-config-keep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keep-network","download_url":"https://codeload.github.com/keep-network/solium-config-keep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247078783,"owners_count":20879950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T23:29:13.826Z","updated_at":"2025-04-03T20:42:22.014Z","avatar_url":"https://github.com/keep-network.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# solium-config-keep\n\nStandard configuration for linting Solidity code using [ethlint/Solium](https://github.com/duaraghav8/Ethlint). Uses the `solium:recommended` ruleset, which itself is taken from the [Solidity Style Guide](https://solidity.readthedocs.io/en/v0.5.9/style-guide.html).\n\n## Installation\n\n`npm i https://github.com/keep-network/solium-config-keep.git`\n\n## Usage\n\n### Setting up a project\n\n 1. Install the linter and config - `npm i -D ethlint https://github.com/keep-network/solium-config-keep.git`\n 2. Create your `.soliumrc.json`:\n ```json\n{\n  \"extends\": \"keep\",\n  \"plugins\": [\n    \"security\"\n  ]\n}\n ```\n 3. Add commands for linting to your `package.json`:\n ```json\n{\n  \"scripts\": {\n    \"sol:lint\": \"solium -d contracts/\",\n    \"sol:lint:fix\": \"solium -d contracts/ --fix\"\n  }\n}\n ```\n\n### Disabling the linter\n#### Directory\nEdit the `.soliumrc.json`.\n\n#### File\n`/* solium-disable */`\n\n#### Code block\n`/* solium-disable */`\n`/* solium-enable */`\n\n#### Line\nPrefer `/*` over `//`, as it looks different to a comment on the rationale of code. \n\n`/* solium-disable-next-line \u003crules\u003e */`\n`/* solium-disable-previous-line \u003crules\u003e */`\n\n\n### Adding a pre-commit hook\n```yaml\n- repo: local\n   hooks:\n    - id: solium\n      name: Solidity linter\n      language: node\n      entry: solium\n      files: '\\.sol$'\n      args:\n      - --dir=./contracts/\n      - --config=./.soliumrc.json\n      additional_dependencies:\n      - ethlint@1.2.3\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeep-network%2Fsolium-config-keep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeep-network%2Fsolium-config-keep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeep-network%2Fsolium-config-keep/lists"}