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
  • Intercommunication between rules
  • Compare values between 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
• 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
    • includeContent
    • excludeLines
    • excludeContent
  • existence
    • ifFilesExist
  • jmespath
    • starts_with()
    • ends_with()
    • regex_match()
    • regex_matchall()
    • regex_search()
    • regex_sub()
    • regex_escape()
    • os()
    • getenv()
    • setenv()
    • rootdir_name()
    • op()
    • shlex_split()
    • shlex_join()
    • round()
    • range()
    • count()
    • find()
    • isalnum()
    • isalpha()
    • isascii()
    • isdecimal()
    • isdigit()
    • isidentifier()
    • islower()
    • isnumeric()
    • isprintable()
    • isspace()
    • istitle()
    • isupper()
    • lower()
    • lstrip()
    • partition()
    • rfind()
    • rpartition()
    • rsplit()
    • split()
    • splitlines()
    • swapcase()
    • title()
    • upper()
    • zfill()
    • enumerate()
    • to_items()
    • from_items()
    • isfile()
    • isdir()
    • exists()
    • listdir()
    • mkdir()
    • rmdir()
    • glob()
    • update()
    • insert()
    • deepmerge()
    • set()
    • unset()
    • replace()
    • removeprefix()
    • removesuffix()
    • format()
    • strip()
    • rstrip()
    • capitalize()
    • casefold()
    • center()
    • ljust()
    • rjust()
    • gh_tags()
    • JMESPathsMatch
    • crossJMESPathsMatch
    • ifJMESPathsMatch
  • pre-commit
    • preCommitHookExists
• Using on CI
  • Github Actions

In depth

• Rationale
  • Alternatives
• Fetching
  • GitHub
• 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

Tip

You can see other versions of this documentation using URLs like https://mondeja.github.io/project-config/<version>.