fix: rename pascalcase to capwords

dbale-altoros · dbale-altoros · commit 4e8fba72eba0 · 2024-12-31T13:53:46.000-03:00
diff --git a/conf/rulesets/solhint-all.js b/conf/rulesets/solhint-all.js
@@ -38,8 +38,8 @@ module.exports = Object.freeze({
     'comprehensive-interface': 'warn',
     quotes: ['error', 'double'],
     'const-name-snakecase': 'warn',
-    'contract-name-pascalcase': 'warn',
-    'event-name-pascalcase': 'warn',
+    'contract-name-capwords': 'warn',
+    'event-name-capwords': 'warn',
     'foundry-test-functions': ['warn', ['setUp']],
     'func-name-mixedcase': 'warn',
     'func-named-parameters': ['warn', 4],
diff --git a/conf/rulesets/solhint-recommended.js b/conf/rulesets/solhint-recommended.js
@@ -23,8 +23,8 @@ module.exports = Object.freeze({
     'gas-custom-errors': 'warn',
     quotes: ['error', 'double'],
     'const-name-snakecase': 'warn',
-    'contract-name-pascalcase': 'warn',
-    'event-name-pascalcase': 'warn',
+    'contract-name-capwords': 'warn',
+    'event-name-capwords': 'warn',
     'func-name-mixedcase': 'warn',
     'immutable-vars-naming': [
       'warn',
diff --git a/docs/rules.md b/docs/rules.md
@@ -29,8 +29,8 @@ title:       "Rule Index of Solhint"
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
 | [interface-starts-with-i](./rules/naming/interface-starts-with-i.md)                 | Solidity Interfaces names should start with an `I`                                                            |              |             |
 | [const-name-snakecase](./rules/naming/const-name-snakecase.md)                       | Constant name must be in capitalized SNAKE_CASE. (Does not check IMMUTABLES, use immutable-vars-naming)       | $~~~~~~~~$✔️ |             |
-| [contract-name-pascalcase](./rules/naming/contract-name-pascalcase.md)               | Contract, Structs and Enums should be in PascalCase.                                                          | $~~~~~~~~$✔️ |             |
-| [event-name-pascalcase](./rules/naming/event-name-pascalcase.md)                     | Event name must be in PascalCase.                                                                             | $~~~~~~~~$✔️ |             |
+| [contract-name-capwords](./rules/naming/contract-name-capwords.md)                   | Contract, Structs and Enums should be in CapWords.                                                            | $~~~~~~~~$✔️ |             |
+| [event-name-capwords](./rules/naming/event-name-capwords.md)                         | Event name must be in CapWords.                                                                               | $~~~~~~~~$✔️ |             |
 | [foundry-test-functions](./rules/naming/foundry-test-functions.md)                   | Enforce naming convention on functions for Foundry test cases                                                 |              |             |
 | [func-name-mixedcase](./rules/naming/func-name-mixedcase.md)                         | Function name must be in mixedCase.                                                                           | $~~~~~~~~$✔️ |             |
 | [func-named-parameters](./rules/naming/func-named-parameters.md)                     | Enforce named parameters for function calls with 4 or more arguments. This rule may have some false positives |              |             |
diff --git a/docs/rules/naming/contract-name-capwords.md b/docs/rules/naming/contract-name-capwords.md
@@ -0,0 +1,42 @@
+---
+warning:     "This is a dynamically generated file. Do not edit manually."
+layout:      "default"
+title:       "contract-name-capwords | Solhint"
+---
+
+# contract-name-capwords
+![Recommended Badge](https://img.shields.io/badge/-Recommended-brightgreen)
+![Category Badge](https://img.shields.io/badge/-Style%20Guide%20Rules-informational)
+![Default Severity Badge warn](https://img.shields.io/badge/Default%20Severity-warn-yellow)
+> The {"extends": "solhint:recommended"} property in a configuration file enables this rule.
+
+
+## Description
+Contract, Structs and Enums should be in CapWords.
+
+## Options
+This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Defaults to warn.
+
+### Example Config
+```json
+{
+  "rules": {
+    "contract-name-capwords": "warn"
+  }
+}
+```
+
+### Notes
+- Solhint allows this rule to automatically fix the code with `--fix` option
+- The FIX will only change first letter and remove underscores
+
+## Examples
+This rule does not have examples.
+
+## Version
+This rule is introduced in the latest version.
+
+## Resources
+- [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/naming/contract-name-capwords.js)
+- [Document source](https://github.com/protofire/solhint/blob/master/docs/rules/naming/contract-name-capwords.md)
+- [Test cases](https://github.com/protofire/solhint/blob/master/test/rules/naming/contract-name-capwords.js)
diff --git a/docs/rules/naming/event-name-capwords.md b/docs/rules/naming/event-name-capwords.md
@@ -0,0 +1,42 @@
+---
+warning:     "This is a dynamically generated file. Do not edit manually."
+layout:      "default"
+title:       "event-name-capwords | Solhint"
+---
+
+# event-name-capwords
+![Recommended Badge](https://img.shields.io/badge/-Recommended-brightgreen)
+![Category Badge](https://img.shields.io/badge/-Style%20Guide%20Rules-informational)
+![Default Severity Badge warn](https://img.shields.io/badge/Default%20Severity-warn-yellow)
+> The {"extends": "solhint:recommended"} property in a configuration file enables this rule.
+
+
+## Description
+Event name must be in CapWords.
+
+## Options
+This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Defaults to warn.
+
+### Example Config
+```json
+{
+  "rules": {
+    "event-name-capwords": "warn"
+  }
+}
+```
+
+### Notes
+- Solhint allows this rule to automatically fix the code with `--fix` option
+- The FIX will only change first letter and remove underscores
+
+## Examples
+This rule does not have examples.
+
+## Version
+This rule is introduced in the latest version.
+
+## Resources
+- [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/naming/event-name-capwords.js)
+- [Document source](https://github.com/protofire/solhint/blob/master/docs/rules/naming/event-name-capwords.md)
+- [Test cases](https://github.com/protofire/solhint/blob/master/test/rules/naming/event-name-capwords.js)
diff --git a/e2e/08-autofix/contract-name-pascalcase/.solhint.json b/e2e/08-autofix/contract-name-pascalcase/.solhint.json
@@ -1,5 +1,5 @@
 {
   "rules": {
-    "contract-name-pascalcase": "error"
+    "contract-name-capwords": "error"
   }
 }
diff --git a/e2e/08-autofix/event-name-pascalcase/.solhint.json b/e2e/08-autofix/event-name-pascalcase/.solhint.json
@@ -1,5 +1,5 @@
 {
   "rules": {
-    "event-name-pascalcase": "error"
+    "event-name-capwords": "error"
   }
 }
diff --git a/e2e/autofix-test.js b/e2e/autofix-test.js
@@ -476,9 +476,9 @@ describe('e2e', function () {
     })
   })
 
-  describe('autofix rule: contract-name-pascalcase', () => {
+  describe('autofix rule: contract-name-capwords', () => {
     before(function () {
-      params = retrieveParams('contract-name-pascalcase/')
+      params = retrieveParams('contract-name-capwords/')
       currentConfig = `${params.path}${params.subpath}.solhint.json`
       currentFile = `${params.path}${params.subpath}Foo1.sol`
       beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
@@ -522,9 +522,9 @@ describe('e2e', function () {
     })
   })
 
-  describe('autofix rule: event-name-pascalcase', () => {
+  describe('autofix rule: event-name-capwords', () => {
     before(function () {
-      params = retrieveParams('event-name-pascalcase/')
+      params = retrieveParams('event-name-capwords/')
       currentConfig = `${params.path}${params.subpath}.solhint.json`
       currentFile = `${params.path}${params.subpath}Foo1.sol`
       beforeFixFile = `${params.path}${params.subpath}Foo1BeforeFix.sol`
diff --git a/lib/common/identifier-naming.js b/lib/common/identifier-naming.js
@@ -11,12 +11,12 @@ module.exports = {
     return !this.isMixedCase(text)
   },
 
-  isPascalCase(text) {
+  isCapWords(text) {
     return match(text, /[A-Z$]+[a-zA-Z0-9$]*/)
   },
 
-  isNotPascalCase(text) {
-    return !this.isPascalCase(text)
+  isNotCapWords(text) {
+    return !this.isCapWords(text)
   },
 
   isUpperSnakeCase(text) {
diff --git a/lib/rules/naming/contract-name-capwords.js b/lib/rules/naming/contract-name-capwords.js
@@ -1,12 +1,12 @@
 const BaseChecker = require('../base-checker')
 const naming = require('../../common/identifier-naming')
 
-const ruleId = 'contract-name-pascalcase'
+const ruleId = 'contract-name-capwords'
 const meta = {
   type: 'naming',
 
   docs: {
-    description: 'Contract, Structs and Enums should be in PascalCase.',
+    description: 'Contract, Structs and Enums should be in CapWords.',
     category: 'Style Guide Rules',
     notes: [
       {
@@ -25,7 +25,7 @@ const meta = {
   schema: null,
 }
 
-class ContractNamePascalcaseChecker extends BaseChecker {
+class ContractNameCapWordsChecker extends BaseChecker {
   constructor(reporter) {
     super(reporter, ruleId, meta)
   }
@@ -43,7 +43,7 @@ class ContractNamePascalcaseChecker extends BaseChecker {
   }
 
   validateName(node, type) {
-    if (naming.isNotPascalCase(node.name)) {
+    if (naming.isNotCapWords(node.name)) {
       this._error(node, type)
     }
   }
@@ -73,10 +73,10 @@ class ContractNamePascalcaseChecker extends BaseChecker {
   _error(node, type) {
     this.error(
       node,
-      'Contract, Structs and Enums should be in PascalCase',
+      'Contract, Structs and Enums should be in CapWords',
       this.fixStatement(node, type)
     )
   }
 }
 
-module.exports = ContractNamePascalcaseChecker
+module.exports = ContractNameCapWordsChecker
diff --git a/lib/rules/naming/event-name-capwords.js b/lib/rules/naming/event-name-capwords.js
@@ -1,12 +1,12 @@
 const BaseChecker = require('../base-checker')
 const naming = require('../../common/identifier-naming')
 
-const ruleId = 'event-name-pascalcase'
+const ruleId = 'event-name-capwords'
 const meta = {
   type: 'naming',
 
   docs: {
-    description: 'Event name must be in PascalCase.',
+    description: 'Event name must be in CapWords.',
     category: 'Style Guide Rules',
     notes: [
       {
@@ -25,7 +25,7 @@ const meta = {
   schema: null,
 }
 
-class EventNamePascalCaseChecker extends BaseChecker {
+class EventNameCapWordsChecker extends BaseChecker {
   constructor(reporter) {
     super(reporter, ruleId, meta)
   }
@@ -53,10 +53,10 @@ class EventNamePascalCaseChecker extends BaseChecker {
   }
 
   EventDefinition(node) {
-    if (naming.isNotPascalCase(node.name)) {
-      this.error(node, 'Event name must be in PascalCase', this.fixStatement(node))
+    if (naming.isNotCapWords(node.name)) {
+      this.error(node, 'Event name must be in CapWords', this.fixStatement(node))
     }
   }
 }
 
-module.exports = EventNamePascalCaseChecker
+module.exports = EventNameCapWordsChecker
diff --git a/lib/rules/naming/index.js b/lib/rules/naming/index.js
@@ -1,6 +1,6 @@
 const ConstNameSnakecaseChecker = require('./const-name-snakecase')
-const ContractNamePascalCaseChecker = require('./contract-name-pascalcase')
-const EventNamePascalCaseChecker = require('./event-name-pascalcase')
+const ContractNameCapWordsChecker = require('./contract-name-capwords')
+const EventNameCapWordsChecker = require('./event-name-capwords')
 const FuncNameMixedcaseChecker = require('./func-name-mixedcase')
 const FuncParamNameMixedcaseChecker = require('./func-param-name-mixedcase')
 const ModifierNameMixedcaseChecker = require('./modifier-name-mixedcase')
@@ -16,8 +16,8 @@ const ImportsOrderChecker = require('./imports-order')
 module.exports = function checkers(reporter, config) {
   return [
     new ConstNameSnakecaseChecker(reporter),
-    new ContractNamePascalCaseChecker(reporter),
-    new EventNamePascalCaseChecker(reporter),
+    new ContractNameCapWordsChecker(reporter),
+    new EventNameCapWordsChecker(reporter),
     new FuncNameMixedcaseChecker(reporter),
     new FuncParamNameMixedcaseChecker(reporter),
     new ModifierNameMixedcaseChecker(reporter),
diff --git a/test/rules/naming/contract-name-capwords.js b/test/rules/naming/contract-name-capwords.js
@@ -2,38 +2,38 @@ const assert = require('assert')
 const linter = require('../../../lib/index')
 const contractWith = require('../../common/contract-builder').contractWith
 
-describe('Linter - contract-name-pascalcase', () => {
+describe('Linter - contract-name-capwords', () => {
   it('should raise struct name error', () => {
     const code = contractWith('struct a {}')
 
     const report = linter.processStr(code, {
-      rules: { 'contract-name-pascalcase': 'error' },
+      rules: { 'contract-name-capwords': 'error' },
     })
 
     assert.equal(report.errorCount, 1)
-    assert.ok(report.messages[0].message.includes('PascalCase'))
+    assert.ok(report.messages[0].message.includes('CapWords'))
   })
 
   it('should raise contract name error', () => {
     const code = 'contract a {}'
 
     const report = linter.processStr(code, {
-      rules: { 'contract-name-pascalcase': 'error' },
+      rules: { 'contract-name-capwords': 'error' },
     })
 
     assert.equal(report.errorCount, 1)
-    assert.ok(report.messages[0].message.includes('PascalCase'))
+    assert.ok(report.messages[0].message.includes('CapWords'))
   })
 
   it('should raise enum name error', () => {
     const code = contractWith('enum abc {}')
 
     const report = linter.processStr(code, {
-      rules: { 'contract-name-pascalcase': 'error' },
+      rules: { 'contract-name-capwords': 'error' },
     })
 
     assert.equal(report.errorCount, 1)
-    assert.ok(report.messages[0].message.includes('PascalCase'))
+    assert.ok(report.messages[0].message.includes('CapWords'))
   })
 
   describe('Struct name with $ character', () => {
@@ -47,7 +47,7 @@ describe('Linter - contract-name-pascalcase', () => {
     for (const [key, code] of Object.entries(WITH_$)) {
       it(`should not raise contract name error for Structs ${key}`, () => {
         const report = linter.processStr(code, {
-          rules: { 'contract-name-pascalcase': 'error' },
+          rules: { 'contract-name-capwords': 'error' },
         })
 
         assert.equal(report.errorCount, 0)
@@ -66,7 +66,7 @@ describe('Linter - contract-name-pascalcase', () => {
     for (const [key, code] of Object.entries(WITH_$)) {
       it(`should not raise contract name error for Enums ${key}`, () => {
         const report = linter.processStr(code, {
-          rules: { 'contract-name-pascalcase': 'error' },
+          rules: { 'contract-name-capwords': 'error' },
         })
 
         assert.equal(report.errorCount, 0)
@@ -85,7 +85,7 @@ describe('Linter - contract-name-pascalcase', () => {
     for (const [key, code] of Object.entries(WITH_$)) {
       it(`should not raise contract name error for Contracts ${key}`, () => {
         const report = linter.processStr(code, {
-          rules: { 'contract-name-pascalcase': 'error' },
+          rules: { 'contract-name-capwords': 'error' },
         })
 
         assert.equal(report.errorCount, 0)
diff --git a/test/rules/naming/event-name-capwords.js b/test/rules/naming/event-name-capwords.js
@@ -2,12 +2,12 @@ const assert = require('assert')
 const linter = require('../../../lib/index')
 const contractWith = require('../../common/contract-builder').contractWith
 
-describe('Linter - event-name-pascalcase', () => {
+describe('Linter - event-name-capwords', () => {
   it('should raise event name error for event in mixedCase', () => {
     const code = contractWith('event EventCap(uint a);')
 
     const report = linter.processStr(code, {
-      rules: { 'event-name-pascalcase': 'error' },
+      rules: { 'event-name-capwords': 'error' },
     })
 
     assert.equal(report.errorCount, 0)
@@ -17,11 +17,11 @@ describe('Linter - event-name-pascalcase', () => {
     const code = contractWith('event event1(uint a);')
 
     const report = linter.processStr(code, {
-      rules: { 'event-name-pascalcase': 'error' },
+      rules: { 'event-name-capwords': 'error' },
     })
 
     assert.equal(report.errorCount, 1)
-    assert.ok(report.messages[0].message.includes('PascalCase'))
+    assert.ok(report.messages[0].message.includes('CapWords'))
   })
 
   describe('Event name with $ character', () => {
@@ -35,7 +35,7 @@ describe('Linter - event-name-pascalcase', () => {
     for (const [key, code] of Object.entries(WITH_$)) {
       it(`should not raise event name error for Events ${key}`, () => {
         const report = linter.processStr(code, {
-          rules: { 'event-name-pascalcase': 'error' },
+          rules: { 'event-name-capwords': 'error' },
         })
 
         assert.equal(report.errorCount, 0)

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"rules": {`
`3`		`- "contract-name-pascalcase": "error"`
	`3`	`+ "contract-name-capwords": "error"`
`4`	`4`	`}`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"rules": {`
`3`		`- "event-name-pascalcase": "error"`
	`3`	`+ "event-name-capwords": "error"`
`4`	`4`	`}`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`const BaseChecker = require('../base-checker')`
`2`	`2`	`const naming = require('../../common/identifier-naming')`
`3`	`3`
`4`		`-const ruleId = 'contract-name-pascalcase'`
	`4`	`+const ruleId = 'contract-name-capwords'`
`5`	`5`	`const meta = {`
`6`	`6`	`type: 'naming',`
`7`	`7`
`8`	`8`	`docs: {`
`9`		`- description: 'Contract, Structs and Enums should be in PascalCase.',`
	`9`	`+ description: 'Contract, Structs and Enums should be in CapWords.',`
`10`	`10`	`category: 'Style Guide Rules',`
`11`	`11`	`notes: [`
`12`	`12`	`{`
`@@ -25,7 +25,7 @@ const meta = {`
`25`	`25`	`schema: null,`
`26`	`26`	`}`
`27`	`27`
`28`		`-class ContractNamePascalcaseChecker extends BaseChecker {`
	`28`	`+class ContractNameCapWordsChecker extends BaseChecker {`
`29`	`29`	`constructor(reporter) {`
`30`	`30`	`super(reporter, ruleId, meta)`
`31`	`31`	`}`
`@@ -43,7 +43,7 @@ class ContractNamePascalcaseChecker extends BaseChecker {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`validateName(node, type) {`
`46`		`- if (naming.isNotPascalCase(node.name)) {`
	`46`	`+ if (naming.isNotCapWords(node.name)) {`
`47`	`47`	`this._error(node, type)`
`48`	`48`	`}`
`49`	`49`	`}`
`@@ -73,10 +73,10 @@ class ContractNamePascalcaseChecker extends BaseChecker {`
`73`	`73`	`_error(node, type) {`
`74`	`74`	`this.error(`
`75`	`75`	`node,`
`76`		`- 'Contract, Structs and Enums should be in PascalCase',`
	`76`	`+ 'Contract, Structs and Enums should be in CapWords',`
`77`	`77`	`this.fixStatement(node, type)`
`78`	`78`	`)`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
`82`		`-module.exports = ContractNamePascalcaseChecker`
	`82`	`+module.exports = ContractNameCapWordsChecker`