.textlintrc.js

/* eslint-disable import/no-commonjs */
const textlintMode = process.env.TEXTLINT_MODE;

const allRules = {
  alex: {
    allow: ['color', 'hook', 'host-hostess', 'itch'],
  },
  'common-misspellings': true,
  'en-capitalization': false,
  'stop-words': {
    exclude: [
      'relative to', // We need to talk about links "relative to the root",
      'pick out', // Needed word, not to clumsy
      'encounter', // Needed word, not to clumsy
      'proceed',
      'therefore',
      'this command',
      'Failure to',
      'frequently',
      'ALL of',
      'in addition to',
      'in addition',
      'Take a look at',
      'In addition to',
      'In addition',
      'simply',
      'deem'
    ],
  },
  terminology: {
    defaultTerms: false,
    terms: `${__dirname}/.textlint.terms.json`,
  },
  'write-good': {
    passive: true,
    severity: 'warning',
  },
};

// Not all rules are automatically fixable, so when running `yarn run
// lint:md:fix`, we only run the one that can be fixed.
const fixableRules = {
  'common-misspellings': allRules['common-misspellings'],
  'en-capitalization': allRules['en-capitalization'],
  terminology: allRules['terminology'],
};

module.exports = {
  rules: textlintMode === 'fix' ? fixableRules : allRules,
};