Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsheiko/grunt-jscodesniffer
⛔️ [DEPRECATED] A grunt task for running JS Codesniffer validator
https://github.com/dsheiko/grunt-jscodesniffer
depricated obsoleted
Last synced: about 2 months ago
JSON representation
⛔️ [DEPRECATED] A grunt task for running JS Codesniffer validator
- Host: GitHub
- URL: https://github.com/dsheiko/grunt-jscodesniffer
- Owner: dsheiko
- License: mit
- Created: 2013-06-24T16:30:14.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-05-07T09:45:42.000Z (over 3 years ago)
- Last Synced: 2024-11-09T09:41:01.147Z (2 months ago)
- Topics: depricated, obsoleted
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-jscodesniffer
[](http://unmaintained.tech/)
> WARNING - THIS PROJECT IS NO LONGER MAINTAINED!!!
[](https://nodei.co/npm/grunt-jscodesniffer/)
A grunt task for running jscodesniffer validator
> Note: This used to be called 'grunt-contrib-jscs' in the npm registry, but as of version 0.1.10 it has taken over the 'grunt-jscodesniffer' name.
## Getting Started
This plugin requires Grunt `~0.4.1`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-jscodesniffer --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks( "grunt-jscodesniffer" );
```
## The "jscs" task
### Overview
In your project's Gruntfile, add a section named `jscs` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
jscs: {
all: {
options: {
// Task-specific options go here.
},
files: {
src: [ "dir", "file", "dir" ] // Target-specific file/directory goes here.
}
}
}
})
```
### Options
#### options.standard
Type: `String`
Default Idiomatic
- apply specified standard (Idiomatic, Jquery)
#### options.reportFull
Type: `Boolean`
Default 'false'
full report with source codes
#### options.reportFile
Type: `String`
Default 'Undefined'
write the report to the specified file path
#### options.report
Type: `String`
Default 'Undefined'
xml for printing an XML report
checkstyle for printing Jenkins-friendly checkstyle report
### Usage Examples
#### Default Options
```js
grunt.initConfig({
jscs: {
all: {
options: {
"standard": "Jquery"
},
files: {
src: [ "tasks" ]
}
}
}
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
[](http://githalytics.com/dsheiko/grunt-jscodesniffer)