Skip to content

Commit

Permalink
feat: 🚀 release 2.0.0 (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
muenzpraeger authored Jan 29, 2021
1 parent e2ecb37 commit dc374da
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/compare/1.2.1...2.0.0) - 2021-01-29

- Add URI support for partial matches of allowed terms [muenzpraeger](https://github.com/muenzpraeger) [`PR 14`](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/pull/14)

- Add JSX support [stevenweber](https://github.com/stevenweber) [`PR 21`](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/pull/21)

- Add support for multiple suggestions and (auto)correction [stevenweber](https://github.com/stevenweber) [reverbdotcom](https://github.com/reverbdotcom) [`PR 21`](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/pull/21)

## [1.2.1](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/compare/1.2.0...1.2.1) - 2020-07-19

- Add URI support for partial matches of allowed terms [muenzpraeger](https://github.com/muenzpraeger) [`PR 14`](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/pull/14)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ An ESLint plugin to raise awareness for using inclusive language not only in you

[![Github Workflow](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/workflows/build%20primary/badge.svg?branch=primary)](https://github.com/muenzpraeger/eslint-plugin-inclusive-language/actions) [![Version](https://img.shields.io/npm/v/eslint-plugin-inclusive-language.svg)](https://npmjs.org/package/eslint-plugin-inclusive-language)

> If you're upgrading from 1.x.x. to 2.x.x, please read the [migration document here first](/docs/migration_200.md).
## What is inclusive language anyway?

This is a great question to ask.
Expand Down
25 changes: 25 additions & 0 deletions docs/migration_200.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Migrating from 1.2.x to 2.0.0

Starting with release 2.0.0 multiple word replacement options are now possible. If you just use the standard configuration this won't have an effect.

If you maintain a custom configuration you will have to update the keyword `suggestion` to the plural form `suggestions`. The value type needs to switch from an array to a string of arrays.

Before 2.0.0:

```json
{
"word": "guys",
"suggestion": "people", // This line
"explanation": "The usage of the non-inclusive word '{{word}}' is discouraged, use '{{suggestion}}' instead."
}
```

Starting with 2.0.0:

```json
{
"word": "guys",
"suggestions": ["people"], // This line
"explanation": "The usage of the non-inclusive word '{{word}}' is discouraged, use '{{suggestion}}' instead."
}
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-inclusive-language",
"version": "1.2.1",
"version": "2.0.0",
"description": "An ESLint plugin to raise awareness for using inclusive language not only in your codebase, but in life.",
"main": "lib/index.js",
"repository": "muenzpraeger/eslint-plugin-inclusive-language",
Expand Down

0 comments on commit dc374da

Please sign in to comment.