.cspell.json

{
  "version": "0.2",
  "gitignoreRoot": ".",
  "useGitignore": true,
  "dictionaryDefinitions": [
    {
      "name": "project-dictionary",
      "path": "./.github/.cspell/project-dictionary.txt",
      "addWords": true
    },
    {
      "name": "rust-dependencies",
      "path": "./.github/.cspell/rust-dependencies.txt",
      "addWords": true
    }
  ],
  "dictionaries": ["project-dictionary", "rust-dependencies"],
  "ignoreRegExpList": [
    // Copyright notice
    "Copyright .*",
    // GHA actions/workflows
    "uses: .+@",
    // GHA context (repo name, owner name, etc.)
    "github.\\w+ (=|!)= '.+'",
    // GH username
    "( |\\[)@[\\w_-]+",
    // Git config username
    "git config user.name .*",
    // Username in todo comment
    "(TODO|FIXME)\\([\\w_., -]+\\)",
    // Cargo.toml authors
    "authors *= *\\[.*\\]",
    "\".* <[\\w_.+-]+@[\\w.-]+>\""
  ],
  "languageSettings": [
    {
      "languageId": ["*"],
      "dictionaries": ["bash", "rust"]
    }
  ],
  "ignorePaths": [
    // Licenses
    "**/LICENSE*",
    // Imported files
    "**/ros_msgs/**",
    // ROS package
    "**/package.xml"
  ]
}