docs: document fixed code

Author: gajus

.README/rules/format.md

@@ -17,3 +17,5 @@ The first option is an object with the following configuration.
 |`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|
 
 The second option is an object with the [`pg-formatter` configuration](https://github.com/gajus/pg-formatter#configuration).
+
+<!-- assertions format -->

README.md

@@ -2,7 +2,6 @@
 # eslint-plugin-sql
 
 [![Travis build status](http://img.shields.io/travis/gajus/eslint-plugin-sql/master.svg?style=flat-square)](https://travis-ci.org/gajus/eslint-plugin-sql)
-[![Coveralls](https://img.shields.io/coveralls/gajus/eslint-plugin-sql.svg?style=flat-square)](https://coveralls.io/github/gajus/eslint-plugin-sql)
 [![NPM version](http://img.shields.io/npm/v/eslint-plugin-sql.svg?style=flat-square)](https://www.npmjs.org/package/eslint-plugin-sql)
 [![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)
 [![Twitter Follow](https://img.shields.io/twitter/follow/kuizinas.svg?style=social&label=Follow)](https://twitter.com/kuizinas)
@@ -87,6 +86,59 @@ The first option is an object with the following configuration.
 
 The second option is an object with the [`pg-formatter` configuration](https://github.com/gajus/pg-formatter#configuration).
 
+The following patterns are considered problems:
+
+```js
+`SELECT 1`
+// Options: [{"ignoreInline":false,"ignoreTagless":false}]
+// Message: Format the query
+// Fixed code: 
+// `SELECT
+//     1
+// `
+
+`SELECT 2`
+// Options: [{"ignoreInline":false,"ignoreTagless":false},{"spaces":2}]
+// Message: Format the query
+// Fixed code: 
+// `SELECT
+//   2
+// `
+
+sql`SELECT 3`
+// Options: [{"ignoreInline":false}]
+// Message: Format the query
+// Fixed code: 
+// sql`SELECT
+//     3
+// `
+
+`SELECT ${'foo'} FROM ${'bar'}`
+// Options: [{"ignoreInline":false,"ignoreTagless":false}]
+// Message: Format the query
+// Fixed code: 
+// `SELECT
+//     ${'foo'}
+// FROM
+//     ${'bar'}
+// `
+```
+
+The following patterns are not considered problems:
+
+```js
+sql`SELECT 1`
+// Options: [{"ignoreInline":true}]
+
+`SELECT 2`
+// Options: [{"ignoreTagless":true}]
+
+`SELECT ${'foo'} FROM ${'bar'}`
+// Options: [{"ignoreExpressions":true,"ignoreInline":false,"ignoreTagless":false}]
+```
+
+
+
 <a name="eslint-plugin-sql-rules-no-unsafe-query"></a>
 ### <code>no-unsafe-query</code>
 
@@ -122,8 +174,8 @@ foo`SELECT ${'bar'}`
 The following patterns are not considered problems:
 
 ```js
-// Options: [{"allowLiteral":true}]
 `SELECT 1`
+// Options: [{"allowLiteral":true}]
 
 sql`SELECT 1`
 

bin/readmeAssertions.js

@@ -10,12 +10,12 @@ import glob from 'glob';
 const formatCodeSnippet = (setup) => {
   const paragraphs = [];
 
+  paragraphs.push(setup.code);
+
   if (setup.options) {
     paragraphs.push('// Options: ' + JSON.stringify(setup.options));
   }
 
-  paragraphs.push(setup.code);
-
   if (setup.errors) {
     setup.errors.forEach((message) => {
       paragraphs.push('// Message: ' + message.message);
@@ -26,6 +26,10 @@ const formatCodeSnippet = (setup) => {
     paragraphs.push('// Additional rules: ' + JSON.stringify(setup.rules));
   }
 
+  if (setup.output) {
+    paragraphs.push('// Fixed code: \n// ' + setup.output.split('\n').join('\n// '));
+  }
+
   return paragraphs.join('\n');
 };