https://github.com/errata-ai/joblint

A Vale-compatible implementation of the Joblint linter
https://github.com/errata-ai/joblint

vale vale-linter-style vale-style

Last synced: about 1 month ago
JSON representation

A Vale-compatible implementation of the Joblint linter

• Host: GitHub
• URL: https://github.com/errata-ai/joblint
• Owner: errata-ai
• License: mit
• Created: 2019-05-31T02:39:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-07T19:23:48.000Z (over 3 years ago)
• Last Synced: 2024-02-23T15:36:54.975Z (10 months ago)
• Topics: vale, vale-linter-style, vale-style
• Language: Gherkin
• Homepage:
• Size: 20.5 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Joblint [![Build Status](https://travis-ci.org/errata-ai/Joblint.svg?branch=master)](https://travis-ci.org/errata-ai/Joblint) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)

> [`Joblint`](https://github.com/rowanmanning/joblint): Test tech job posts for issues with sexism, culture, expectations, and recruiter fails.

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the guidelines enforced by the `Joblint` ([LICENSE](https://github.com/rowanmanning/joblint/blob/master/LICENSE)) linter.

## Getting Started

> :exclamation: Joblint requires Vale >= **1.7.0**. :exclamation:

Download the [latest release](https://github.com/errata-ai/Joblint/releases), copy the "Joblint" directory to your `StylesPath`, and include it in your configuration file:

```ini

# This goes in a file named either `.vale.ini` or `_vale.ini`.

StylesPath = path/to/some/directory

MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.

[*.{md,txt}]

# List of styles to load.

BasedOnStyles = Joblint

```

See [Usage](https://github.com/errata-ai/vale/#usage) for more information.

## Using the Template

This repository serves as a [template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for creating your own style. The following files/folders should be edited with your own infomation:

- [`Joblint`](https://github.com/errata-ai/Joblint/tree/master/Joblint): This is where your actual style should be implemented. Re-name the folder and replace its content with your `.yml` rule files.

- [`features`](https://github.com/errata-ai/Joblint/tree/master/features) + [`fixtures`](https://github.com/errata-ai/Joblint/tree/master/fixtures): This is where your tests should reside.

- [`LICENSE`](https://github.com/errata-ai/Joblint/blob/master/LICENSE): replace with your own license information.

- [`.travis.yml`](https://github.com/errata-ai/Joblint/blob/master/.travis.yml): Replace all instances of "Joblint" with the name of your style. You'll also need to add your own [`$GITHUB_TOKEN`](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) to your [Travis CI repository settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings).