From 4aab7babfb8e71169a3e928bb82103de934f8720 Mon Sep 17 00:00:00 2001 From: Jochen Sengier Date: Thu, 2 Apr 2020 10:23:26 +0200 Subject: [PATCH] Update documentation on custom object formatter --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 237abf1..8da99a5 100644 --- a/README.md +++ b/README.md @@ -109,10 +109,11 @@ You can also provide an object with the following contract to implement your own ```js { - id: 'string', // Name passed to csslint.formatter + id: 'string', // ID passed to csslint.formatter + name: 'string', // Name passed to csslint.formatter startFormat: function() {}, // Called before parsing any files, should return a string - startFormat: function() {}, // Called after parsing all files, should return a string - formatResult: function (results, filename, options) {} // Called with a results-object per file linted. Optionally called with a filename, and options passed to csslint.formatter(*formatter*, *options*) + endFormat: function() {}, // Called after parsing all files, should return a string + formatResults: function (results, filename, options) {} // Called with a results-object per file linted. Optionally called with a filename, and options passed to csslint.formatter(*formatter*, *options*) } ```