Skip to content

Update documentation on custom object formatter #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation on custom object formatter #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*)
}
```

Expand Down