Add miscellaneous examples

1detbiarta · Aug 23, 2019 · 79048c7 · 79048c7
1 parent 74b3d81
commit 79048c7
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 4 deletions.
diff --git a/lib/rules/miscellaneous/quotes.js b/lib/rules/miscellaneous/quotes.js
@@ -20,7 +20,21 @@ const meta = {
         description: `Type of quotes. Must be one of ${formatEnum(QUOTE_TYPES)}`,
         default: DEFAULT_QUOTES_TYPE
       }
-    ]
+    ],
+    examples: {
+      good: [
+        {
+          description: 'String with double quotes',
+          code: require('../../../test/fixtures/miscellaneous/string-with-double-quotes')
+        }
+      ],
+      bad: [
+        {
+          description: 'String with single quotes',
+          code: require('../../../test/fixtures/miscellaneous/string-with-single-quotes')
+        }
+      ]
+    }
   },
 
   isDefault: false,

diff --git a/scripts/generate-rule-docs.js b/scripts/generate-rule-docs.js
@@ -195,7 +195,7 @@ function getDefaultSeverity(rule) {
 function main() {
     const rules = loadRules()
     rules.forEach(rule => {
-        if (rule.ruleId === 'reason-string')
+        if (rule.ruleId === 'quotes')
         console.log(generateRuleDoc(rule))
     })
 }

diff --git a/test/fixtures/miscellaneous/string-with-double-quotes.js b/test/fixtures/miscellaneous/string-with-double-quotes.js
@@ -0,0 +1,3 @@
+const { contractWith } = require('./../../common/contract-builder')
+
+module.exports = contractWith('string private a = "test";')
diff --git a/test/fixtures/miscellaneous/string-with-single-quotes.js b/test/fixtures/miscellaneous/string-with-single-quotes.js
@@ -0,0 +1,3 @@
+const { contractWith } = require('./../../common/contract-builder')
+
+module.exports = contractWith("string private a = 'test';")
diff --git a/test/rules/miscellaneous/quotes.js b/test/rules/miscellaneous/quotes.js
@@ -10,7 +10,7 @@ describe('Linter - quotes', () => {
   })
 
   it('should raise quotes error', () => {
-    const code = contractWith("string private a = 'test';")
+    const code = require('../../fixtures/miscellaneous/string-with-single-quotes')
 
     const report = linter.processStr(code, {
       rules: { quotes: 'error' }
@@ -76,7 +76,7 @@ describe('Linter - quotes', () => {
   )
 
   it('should raise no error', () => {
-    const filePath = storeAsFile(contractWith('string private a = "test";'))
+    const filePath = storeAsFile(require('../../fixtures/miscellaneous/string-with-double-quotes'))
 
     const report = linter.processFile(filePath, {
       rules: { quotes: 'error' }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const { contractWith } = require('./../../common/contract-builder')

		module.exports = contractWith('string private a = "test";')
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const { contractWith } = require('./../../common/contract-builder')

		module.exports = contractWith("string private a = 'test';")