project-config’s documentation

Project configuration linter. Enforce the same set of settings between multiple projects.

Quickstart

• Installation
• Basic usage
• Examples
  • Basic usage
  • project-config self configuration
  • Files absence
  • Conditionals
  • Conditionals files existence
  • Compare values between serializable files
  • JMESPath against online sources
  • Assert root directory name
  • TOML sections order
  • Editing a .gitignore file
  • Replacing code blocks languages in RST documents
  • Autofixing .editorconfig
  • Setting hooks in .pre-commit-config.yaml
  • Intercommunication between rules
• Tutorials
  • Best practices
  • Linting a package.json file

Reference

• project-config CLI
  • Reporting
  • Examples of usage
• Configuration
  • style (string or string[])
  • cache (string)
  • cli (object)
    • cli.rootdir (string)
    • cli.reporter (string)
    • cli.color (boolean)
    • cli.colors (object)
    • cli.only_hints (boolean)
• Styling
  • rules (object[])
    • files (string[] or object{not{} | not[]})
    • hint (string)
  • extends (string[])
  • plugins (string[])
• Plugins
  • inclusion
    • includeLines
    • ifIncludeLines
    • excludeContent
  • existence
    • ifFilesExist
  • jmespath
    • JMESPathsMatch
    • crossJMESPathsMatch
    • ifJMESPathsMatch

In depth

• Rationale
  • Alternatives
• Objects serialization
  • JSON
  • JSON5
  • YAML (v1.2)
  • TOML (v1)
  • INI
  • Editorconfig
  • Python
  • Text

For developers

• Writing third party plugins
• Writing third party reporters
• Changelog
• Contributing
• Reference