Serverless JSHint Plugin - Detect errors and potential problems in your Lambda functions
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package.json

README.md

Serverless JSHint Plugin

A Serverless Plugin for the Serverless Framework which adds support for JSHint linting.

serverless npm version Build Status Dependencies Status DevDependencies Status

THIS PLUGIN REQUIRES SERVERLESS V0.5 OR HIGHER!

Introduction

This plugins adds capabilities to lint your Lambda functions before deploying. It also saves you from deploying ES6 syntax by accident.

Installation

In your project root, run:

npm install --save serverless-jshint-plugin

Add the plugin to s-project.json:

"plugins": [
  "serverless-jshint-plugin"
]

Usage

Run the jshint action to check one or multiple functions for errors:

serverless function jshint someFunction someOtherFunction

When no function names are provided, it will check all functions in the current working directory. You can also check the full project by passing the --all / -a flag.

To apply custom configuration, add a .jshintrc file in the project root.

Roadmap

  • Improve documentation
  • Add hooks to automate linting upon run or deployment

License

ISC License. See the LICENSE file.