Joblint

Test tech job specs for issues with sexism, culture, expectations, and recruiter fails.

Writing a job spec? Use Joblint to make your job attractive to a much broader range of candidates.
Getting swamped in job specs? Use Joblint to filter out the bad ones.

Current Version: 1.0.0
Build Status:
Node Support: 0.10

$ joblint path/to/spec.txt

Installing

Joblint runs on Node.js, and is installed with npm:

$ npm install joblint

Command Line Tool

Joblint can be used on the command line with the joblint command:

$ joblint --help

  Usage: joblint [options] <file>

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -r, --reporter [type]  Use the specified reporter [cli]

Joblint supports either specifying a file name:

$ joblint path/to/spec.txt

Or piping the job spec into the command:

$ echo "This is a job spec" | joblint

You can use this to pipe the contents of the clipboard into the command, which is really useful if you're copying specs from emails:

# On Mac:
$ pbpaste | joblint

# On Linux (with xclip installed):
$ xclip -o | joblint

Node.js

You can also use Joblint directly from a Node.js script:

var joblint = require('joblint');

var result = joblint("This is a job spec");
console.log(result);

Writing Your Own Rules

I'm intending on writing some documentation for this, but for now you're best-placed reading through some of the code in lib/rule.

Development

If you wish to contribute to Joblint, clone this repository locally and install dependencies with npm install. Now you can run the following commands to lint and test the code.

$ make lint  # Run JSHint on the code
$ make test  # Run unit tests

Please ensure there are no lint errors or failing tests before opening a pull request.

Thanks

The following excellent people helped massively with defining the lint rules:

License

Joblint is licensed under the MIT license.

xinhui/joblint