Skip to content

Commit

Permalink
Merge branch 'develop' into fix/rename-camelCase-rules
Browse files Browse the repository at this point in the history
  • Loading branch information
dbale-altoros authored Dec 31, 2024
2 parents e30d25e + 22c66b6 commit ad760b4
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ title: "Rule Index of Solhint"
| [named-parameters-mapping](./rules/naming/named-parameters-mapping.md) | Solidity v0.8.18 introduced named parameters on the mappings definition. | | |
| [private-vars-leading-underscore](./rules/naming/private-vars-leading-underscore.md) | Non-external functions and state variables should start with a single underscore. Others, shouldn't | | |
| [use-forbidden-name](./rules/naming/use-forbidden-name.md) | Avoid to use letters 'I', 'l', 'O' as identifiers. | $~~~~~~~~$✔️ | |
| [var-name-mixedcase](./rules/naming/var-name-mixedcase.md) | Variable name must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming) | $~~~~~~~~$✔️ | |
| [var-name-mixedcase](./rules/naming/var-name-mixedcase.md) | Variable names must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming) | $~~~~~~~~$✔️ | |
| [func-order](./rules/order/func-order.md) | Function order is incorrect. | | $~~~~~~~$✔️ |
| [imports-on-top](./rules/order/imports-on-top.md) | Import statements must be on top. | $~~~~~~~~$✔️ | |
| [ordering](./rules/order/ordering.md) | Check order of elements in file and inside each contract, according to the style guide. | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/naming/var-name-mixedcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: "var-name-mixedcase | Solhint"

## Description
Variable name must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming)
Variable names must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming)

## Options
This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Defaults to warn.
Expand Down
2 changes: 1 addition & 1 deletion docs/shareable-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To use a shareable config, you have to add it to your Solhint configuration:
"extends": ["solhint:recommended", "protofire"]
```

This example shows the two kind of shareable configs that you can use: the ones included with Solhint, that start with `solhint:`, and the ones that you can install from npm. The latter are packages that are prefixed with `solhint-config-`, so in this case the package would be installed doing `npm install solhint-config-protofire` but used as just `protofire` when adding it.
This example shows the two types of shareable configs that you can use: the ones included with Solhint, that start with `solhint:`, and the ones that you can install from npm. The latter are packages that are prefixed with `solhint-config-`, so in this case the package would be installed doing `npm install solhint-config-protofire` but used as just `protofire` when adding it.

## Creating your own shareable config

Expand Down
2 changes: 1 addition & 1 deletion lib/rules/naming/var-name-mixedcase.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const meta = {
type: 'naming',

docs: {
description: `Variable name must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming)`,
description: `Variable names must be in mixedCase. (Does not check IMMUTABLES, use immutable-vars-naming)`,
category: 'Style Guide Rules',
},

Expand Down

0 comments on commit ad760b4

Please sign in to comment.