/faircopy

Getting started

Install faircopy and run your first lint.

Install

npm install -D faircopy

The faircopy meta-package pulls in the CLI, core engine, default rules, and config helper.

Add a config

Create faircopy.config.ts at the project root.

import { astro } from '@faircopy/astro'
import { defineConfig } from '@faircopy/config'

export default defineConfig({
  files: ['src/**/*.astro'],
  adapters: [astro()],
  rules: {
    'no-em-dash': 'error',
    'no-weasel-words': 'error',
    'no-rhetorical-scaffolding': 'error',
  },
})

Swap the adapter for your framework. See adapters for Astro, React, and Solid.

Lint

npx faircopy lint

faircopy prints each violation with the file path, line number, rule ID, and the reason. Fix the copy, run again, ship with fewer writing tells.

Next steps