11ty/eleventy-plugin-inclusive-language

A linter plugin to check for inclusive language in markdown files.

eleventy-plugin-inclusive-language

An Eleventy linter plugin to check for inclusive language in markdown files. Inspired by CSS Tricks’ Words to Avoid in Educational Writing. No browser/client JavaScript here—everything is this plugin is done at build-time.

Installation

Available on npm.

npm install @11ty/eleventy-plugin-inclusive-language --save-dev

Open up your Eleventy config file (probably .eleventy.js) and use addPlugin:

const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");

module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(inclusiveLangPlugin);
};

Read more about Eleventy plugins.

Options

Optionally pass in an options object as the second argument to addPlugin to further customize this plugin.

const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");

module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(inclusiveLangPlugin, {
    templateFormats: ["md"], // default, add more file extensions here

    // accepts an array or a comma-delimited string
    words: "simply,obviously,basically,of course,clearly,just,everyone knows,however,easy"
  });
};

eleventy-plugin-inclusive-language's Issues

Ability to exclude certain files from linting

Hi @zachleat,

I know, you haven't looked at this repo in a while.
But I noticed, that this plugin scans my imported tweets as well.
Is there a way to tell the plugin to ignore certain files / directories / collections?

For example, I could compare the inputPath argument of

eleventy-plugin-inclusive-language/.eleventy.js

Line 20 in 8d9a092

eleventyConfig.addLinter("inclusive-language", function(content, inputPath, outputPath) {

against certain conditions.

Would trim down my logging quite a lot :-)

Once we came up with a nice API, I'd be willing to submit a PR!

Use `main` as primary branch name

This repository currently uses master instead of main as the primary branch name.

GitHub now supports using main as the primary branch name. Maintainers should update the repo settings to use main instead of the other branch name.

Recommendation for handling "master" in file paths

We have a lot of links in our docs to github.com/branch/master/whatever and the linter flags these. I tried doing words: [' master '] but it looks like the plugin calls trim() and strips those spaces out. Any suggestions?

Use selfdefined.app as source

In https://twitter.com/AndreJaenisch/status/1264638560839360520 I asked, whether there would be interest to use tatianamac/selfdefined definitions for the linter.

You offered a bounty on the issue: https://twitter.com/eleven_ty/status/1264664123998167053

Evaluate usage of retext

Hi @zachleat,

today, I was looking whether I could apply some readbility estimation to my blog posts.
I stumbled upon retext, which is fairly configurable, but settled with text-readability for now.

Perhaps you want to use it (since markdown-it allows plugins as well).