pre-commit-example-setup-for-french.md

Example pre-commit setup for French

Common configuration

pre-commit-config.yaml configuration

Extend the pre-commit hook config from the README.md with additional_dependencies. For example:

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/streetsidesoftware/cspell-cli
    rev: v6.7.0
    hooks:
      - id: cspell
        additional_dependencies:
          - "@cspell/dict-fr-fr"
          - "@cspell/dict-fr-reforme"

For a complete list of available dictionaries, see: https://github.com/streetsidesoftware/cspell-dicts.

Using French as the locale

Use a cspell.json such as the following:

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "import": [
    "@cspell/dict-fr-fr/cspell-ext.json",
    "@cspell/dict-fr-reforme/cspell-ext.json"
  ],
  "language": "fr",
  "version": "0.2"
}

A file such as mots-française.md containing:

# Testing french in Markdown

## Les mots

Voici, nous avons les mots française.

When cspell is invoked mots-française.md should not show errors

Applying to specific files

And to apply those dictionaries to files with the .md extension (Markdown), use a cspell.json such as:

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "import": [
    "@cspell/dict-fr-fr/cspell-ext.json",
    "@cspell/dict-fr-reforme/cspell-ext.json"
  ],
  "overrides": [
    {
      "filename": "**/*.md",
      "language": "fr,fr-fr,fr-90"
    }
  ],
  "version": "0.2"
}

And the following, as mots-française.md:

# Testing french in Markdown

## Les mots

Voici, nous avons les mots française

as again as mots-française.err:

# Testing french in Markdown

## Les mots

Voici, nous avons les mots française

When cspell is invoked mots-française.md should not show errors, but mots-française.err should.

Invoking CSpell

Via pre-commit

Prerequisites

• Project folder initialized as a git repository via git init or as part of a git repository cloned via git clone

• 'pre-commit' installed

• A .pre-commit-config.yaml such as:

  fail_fast: true
  minimum_pre_commit_version: 2.18.1
  
  repos:
  - repo: "https://github.com/streetsidesoftware/cspell-cli"
    rev: v6.7.0
    hooks:
    - id: cspell

Triggering CSpell using pre-commit

• Stage all files

  git add --all .
  

• Check all files in git against pre-commit hooks

  pre-commit run --all-files

• OR commit the changes

  git commit

Via Command line

• Execute

  cspell '**'