From b8ddb123de5bbcb183682e0d3b472283e6d599e9 Mon Sep 17 00:00:00 2001 From: dbale-altoros Date: Tue, 31 Dec 2024 13:36:10 -0300 Subject: [PATCH 1/2] fix: other typos --- docs/shareable-configs.md | 2 +- lib/rules/naming/var-name-mixedcase.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/shareable-configs.md b/docs/shareable-configs.md index 8e9edd27..693ab917 100644 --- a/docs/shareable-configs.md +++ b/docs/shareable-configs.md @@ -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 diff --git a/lib/rules/naming/var-name-mixedcase.js b/lib/rules/naming/var-name-mixedcase.js index 3e9581c3..66d18e18 100644 --- a/lib/rules/naming/var-name-mixedcase.js +++ b/lib/rules/naming/var-name-mixedcase.js @@ -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', }, From c41cb8593dfae0e4acb4d2e6270a80da83f41e00 Mon Sep 17 00:00:00 2001 From: dbale-altoros Date: Tue, 31 Dec 2024 13:36:26 -0300 Subject: [PATCH 2/2] fix: other typos --- docs/rules.md | 2 +- docs/rules/naming/var-name-mixedcase.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/rules.md b/docs/rules.md index 67faacb6..aa04fbab 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -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. | | | diff --git a/docs/rules/naming/var-name-mixedcase.md b/docs/rules/naming/var-name-mixedcase.md index fe391e35..5983f5ea 100644 --- a/docs/rules/naming/var-name-mixedcase.md +++ b/docs/rules/naming/var-name-mixedcase.md @@ -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.