check-config 0.8.6__tar.gz → 0.9.0a1__tar.gz

{check_config-0.8.6 → check_config-0.9.0a1}/CHANGES.md

@@ -1,5 +1,9 @@
 # CHANGES
 
+## 0.9.0.alpha.1
+
+- BREAKING: refactor the check-config toml files. See documentation for new format.
+
 ## 0.8.6
 
 - The path specified on the cli with, can also be a URL.
@@ -30,7 +34,7 @@
 
 ## 0.8.0
 
-- Add __replacements_regex in lines_present
+- Add \_\_replacements_regex in lines_present
 - BREAKING: use [__config__] in stead of [check-config] as config table
 - BREAKING: use `check-config.toml` as default name
 - preserve formatting of toml files, including comments

{check_config-0.8.6 → check_config-0.9.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: check-config
-Version: 0.8.6
+Version: 0.9.0a1
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -39,14 +39,16 @@ Define your configuration requirements in simple TOML files, then let check-conf
 
 ```toml
 # Set your preferred editor
-["~/.bashrc".lines_present]
-__lines__ = "export EDITOR=hx"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
 ```
 
 ```toml
 # Ensure git signing is configured
-["~/.gitconfig".lines_present]
-__lines__ = """
+[[lines_present]]
+file = "~/.gitconfig"
+lines = """
 [gpg]
         format = ssh
 [commit]
@@ -101,8 +103,9 @@ Make a `check-config.toml` according your needs:
 
 ```toml
 # Set your preferred editor
-["~/.bashrc".lines_present]
-__lines__ = "export EDITOR=hx"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
 ```
 
 And use it:

{check_config-0.8.6 → check_config-0.9.0a1}/README.md

@@ -12,14 +12,16 @@ Define your configuration requirements in simple TOML files, then let check-conf
 
 ```toml
 # Set your preferred editor
-["~/.bashrc".lines_present]
-__lines__ = "export EDITOR=hx"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
 ```
 
 ```toml
 # Ensure git signing is configured
-["~/.gitconfig".lines_present]
-__lines__ = """
+[[lines_present]]
+file = "~/.gitconfig"
+lines = """
 [gpg]
         format = ssh
 [commit]
@@ -74,8 +76,9 @@ Make a `check-config.toml` according your needs:
 
 ```toml
 # Set your preferred editor
-["~/.bashrc".lines_present]
-__lines__ = "export EDITOR=hx"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
 ```
 
 And use it:

{check_config-0.8.6 → check_config-0.9.0a1}/docs/checkers.md

@@ -1,13 +1,13 @@
 # Checkers
 
-Check Config uses `checkers` which define the desired state of the configuration files. There are several
+`check-config` uses `checkers` which define the desired state of the configuration files. There are several
 checker types (and more to come):
 
-| name | description | fixable |
+| checker type | description | fixable |
 |------|-------------|---------|
 | [file_absent](#file-absent) |  the file must be absent | yes |
 | [file_present](#file-present) |  the file must be present, indifferent the content | yes |
-| [file_regex_match](#file-regex-match) |  the content of the file must match the regex expression | when placeholder is prsent |
+| [file_regex_match](#file-regex-match) |  the content of the file must match the regex expression | when placeholder is present |
 | [key_absent](#key-absent) | a specified key must be absent in a toml / yaml / json file  | yes |
 | [key_value_present](#key-value-present) | a specified key with a specified value must be present in a toml / yaml / json file  | yes |
 | [key_value_regex_match](#key-value-regex-match) | the value of a specified key must be match the specified regex in a toml / yaml / json file  | no |
@@ -16,12 +16,12 @@ checker types (and more to come):
 | [lines_absent](#lines-absent) | the specified lines must be absent | yes |
 | [lines_present](#lines-present) | the specified lines must be present | yes |
 
-## Checker.toml
+## check-config.toml
 
-The `check-config.toml` consist of an optional toplevel keys with configuration for check-config itself:
+The `check-config.toml` is the default entrypoint to define all checkers and configure check-config:
 
 ```toml
-__include__ = [  # optional list of toml files with additional checks
+include = [  # optional list of toml files with additional checks
     "/home/me/.checkers/check.toml",  # absolute path
     "~/.checkers/check.toml",  # relative to home dir of current user
     "check.toml", # relative to this parent toml, indifferent if it is a filesystem path or a webserver path
@@ -30,26 +30,35 @@ __include__ = [  # optional list of toml files with additional checks
 ]
 ```
 
+Note: When using a path to a Python package to include checkers, the activated Python (virtual) environment will be used.
+
 And one or more checkers
 
 ```toml
-["<file_path>".<checker_name>.<checker_keys>]
-key = "value"
+[[<checker_name>]]
+<checker object> = "<file_path>"
+<checker specific key/values>
 ```
 
-The syntax is slightly different per check type. See the next sections for help about the checker definitions.
+Note the double square brackets. We use an array of tables to define the checkers, so multiple
+checkers of the same type may exist in the same toml file. If you use only one checker for
+a certain type, you can also use single square brackets. However, to be consistent and
+extensible, we advice to always use double brackets.
+
+The syntax is slightly different per checker type. See the next sections for help about the checker definitions.
 
 You can use arrays of toml tables when when a check has to be done more than once, ie:
 
 ```toml
-[[".gitignore".lines_present]]
-__lines__ = "__pycache__"
+[[lines_present]]
+file = ".gitignore"
+lines = "__pycache__"
 
-[[".gitignore".lines_present]]
-__lines__ = ".cache"
-```
 
-When using a path to a Python package to include checkers, the activated Python (virtual) environment will be used.
+[[lines_present]]
+file = ".gitignore"
+lines = ".cache"
+```
 
 ## Tags
 
@@ -57,9 +66,10 @@ All checkers can have a `__tags__` key to make it possible to exclude or include
 See [cli tags options](usage#Tags) for more information.
 
 ```toml
-[[".gitignore".lines_present]]
-__tags__ = ["linux"]
-__lines__ = ".cache"
+[[lines_present]]
+file = ".gitignore"
+tags = ["linux"]
+lines = ".cache"
 ```
 
 ## File Absent
@@ -69,7 +79,8 @@ __lines__ = ".cache"
 The next example will check that `test/absent_file` will be absent.
 
 ```toml
-["test/absent_file".file_absent]
+[[file_absent]]
+file = "test/absent_file"
 ```
 
 ## File Present
@@ -80,67 +91,101 @@ The next example will check that `test/present_file` will be present. It will
 not check the contents.
 
 ```toml
-["test/present_file".file_present]
+[[file_present]]
+file = "test/present_file"
 ```
 
 When the file does not exists, running with fix will create the file. At default an empty file
-will be created. When a placeholder is given, the created file will contain the placeholder as content.
+will be created.
+
+This checker type can handle any text file.
+
+This checker can also check for:
+- placeholder
+- regex
+- permissions
+
+### Placeholder
+
+When a placeholder is given, the created file will contain the placeholder as content.
 
 ```toml
-["test/present_file".file_present]
-__placeholder__ = "sample content"
+[[file_present]]
+file = "test/present_file"
+placeholder = "sample content"
 ```
 
-## Key Absent
+### Regex Match
 
-`key_absent` will check if the key is not present in the file.
-
-The next example will check that `test/present_file` has no key named `key`.
+Checks whether the contents of the file matches the regex expression.
 
 ```toml
-["test/present.toml".key_absent.key]
+[[file_present]]
+file = ".bashrc"
+regex = 'export KEY=.*'
 ```
 
-The key can be nested. In the next case it is sufficient that `key` is not present.
-`super_key` may be present or absent.
+Multiple regex can be given when the file.checker_type pair is an array, ie:
 
 ```toml
-["test/present.toml".key_absent.super_key.key]
+[[file_present]]
+file = ".bashrc"
+regex = 'export KEY=.*'
+
+[[file_present]]
+file = ".bashrc"
+regex = 'export ANOTHER_KEY=.*'
 ```
 
-This checker type can handle different kind of [mapping file types](#mapping-file-types)
+Note: specify the regex as a raw toml string (single quotes) to prevent escaping.
 
-## File Regex Match
+### Permissions
 
-Checks whether the contents of the file matches the regex expression.
+On Unix systems, you can check for the permissions:
 
 ```toml
-[".bashrc".file_regex_match]
-__regex__ = 'export KEY=.*'
+[[file_present]]
+file = ".bashrc"
+permissions = "644"
 ```
 
-Multiple regex can be given when the file.checker_type pair is an array, ie:
+The permissions need to be defined in the octal representation. See [chmod calculator](https://chmod-calculator.com/)
+an explanation.
 
-```toml
-[[".bashrc".file_regex_match]]
-__regex__ = 'export KEY=.*'
+### Combinations
+
+These extra checks can also be combined in one definition:
 
-[[".bashrc".file_regex_match]]
-__regex__ = 'export ANOTHER_KEY=.*'
+```toml
+[[file_present]]
+file = ".bashrc"
+regex = 'export KEY=.*'
+placeholder = "export KEY=hi"
+permissions = "644"
 ```
 
-When the file does not exists, running with fix will create the file if a `__placeholder__` value is given
-with that value as content. If no `__placeholder__` is given, no file is created.
+## Key Absent
+
+`key_absent` will check if the key is not present in the file.
+
+The next example will check that `test/present_file` has no key named `key_to_be_absent`.
 
 ```toml
-[".bashrc".file_regex_match]
-__regex__ = 'export KEY=.*'
-__placeholder__ = "export KEY=value"
+[[key_absent]]
+file = "test/present.toml"
+key.key_to_be_absent = {}
 ```
 
-Note: specify the regex as a raw toml string (single quotes) to prevent escaping.
+The key can be nested. In the next case it is sufficient that `key_to_be_absent` is not present.
+`super_key` will not be removed if it contains also other keys.
 
-This checker type can handle any text file.
+```toml
+[[key_absent]]
+file = "test/present.toml"
+key.super_key.key_to_be_absent = {}
+```
+
+This checker type can handle different kind of [mapping file types](#mapping-file-types)
 
 ## Key Value Present
 
@@ -149,37 +194,44 @@ Keys may be nested. Intermediate keys has to have mappings as values. When inter
 are not present, they will be added.
 
 ```toml
-["test/present.toml".key_value_present]
-key1 = 1
-key2 = "value"
+[[key_value_present]]
+file = "test/present.toml"
+key.key_to_add = 1
+key.key_to_add_also = "value"
 ```
 
 ```toml
-["test/present.toml".key_value_present.super_key]
-key1 = 1
-key2 = "value"
+[key_value_present.super_key]
+file = "test/present.toml"
+key.super_key.key_to_add = {"inline_table" = "is also possible"}
 ```
 
 This checker type can handle different kind of [mapping file types](#mapping-file-types)
 
 ## Entry Absent
 
-`entry_absent` will check that specified `__items__` are not present on the specified path.
+`entry_absent` will check that all array items `entry.key<.key> = ["item"]` will be removed from the specified
+file.
 
 ```toml
-["test/present.toml".entry_absent.key]
-__items__ = [1, 2]
+[[entry_absent]]
+file = "test/present.toml"
+key.list = [1, 2]
 ```
 
+This checker type can handle different kind of [mapping file types](#mapping-file-types)
 ## Entry Present
 
-`entry_present` will check that specified `__items__` are not present on the specified path.
+`entry_present` will check that all array items `entry.key<.key> = ["item"]` will be added to the specified
+file, if they do not exists already.
 
 ```toml
-["test/present.toml".entry_present.key]
-__items__ = [1, 2]
+[[entry_present]]
+file = "test/present.toml"
+key.list = [1, 2]
 ```
 
+This checker type can handle different kind of [mapping file types](#mapping-file-types)
 ## Key Value Regex Match
 
 `key_value_regex_match` will check that the keys specified are present and the value matches the specified regex.
@@ -188,13 +240,9 @@ Keys may be nested. Intermediate keys has to have mappings as values. When inter
 are not present, they will be added.
 
 ```toml
-["test/present.toml".key_value_regex_match]
-key = 'v.*'
-```
-
-```toml
-["test/present.toml".key_value_regex_match.super_key]
-key = '[0-9]*'
+[[key_value_regex_match]]
+file = "test/present.toml"
+key.key = 'v.*'
 ```
 
 Note: specify the regex as a raw string (single quotes) to be prevent escaping.
@@ -206,22 +254,25 @@ This checker type can handle different kind of [mapping file types](#mapping-fil
 `lines_absent` will check that the file does not contain the lines as specified.
 
 ```toml
-["test/present.txt".lines_absent]
-__lines__ = """\
+[[lines_absent]]
+file = "test/present.txt"
+lines = """\
 multi
 line"""
 ```
 
 ```toml
-["test/present.txt".lines_absent]
-__lines__ = """single line"""
+[lines_absent]
+file = "test/present.txt"
+lines = """single line"""
 ```
 
 You can also remove text between markers which removes the markers also
 
 ```toml
-["test/present.txt".lines_absent]
-__marker_ = "# marker""
+[[lines_absent]]
+file = "test/present.txt"
+marker = "# marker""
 ```
 
 This will change the next text:
@@ -246,32 +297,36 @@ Bla
 `lines_present` will check that the file does contain the lines as specified.
 
 ```toml
-["test/present.txt".lines_present]
-__lines__ = """\
+[[lines_present]]
+file = "test/present.txt"
+lines = """\
 multi
 line"""
 ```
 
 ```toml
 ["test/present.txt".lines_present]
-__lines__ = """single line"""
+file = "test/present.txt"
+lines = """single line"""
 ```
 
 Optionnally it can replace strings by regex, ie if you want to replace an export with a new value:
 
 ```toml
-["~/.bahsrc".lines_present]
-__lines__ = "export EDITOR=hx"
-__replacement_regex = "(?m)^export EDITOR=.*$"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
+replacement_regex = "(?m)^export EDITOR=.*$"
 ```
 
 Or you can use marker lines:
 
 
 ```toml
-["~/.bahsrc".lines_present]
-__lines__ = "export EDITOR=hx"
-__marker = "# marker"
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
+marker = "# marker"
 ```
 
 Which replaces text from
@@ -311,8 +366,8 @@ which contains mappings:
 The filetype will be determined by the extension. You can override this by specifying the filetype:
 
 ```toml
-["test/present.toml".key_value_present]
-__filetype__ = "json"
-key1 = 1
-key2 = "value"
+[[key_value_present]]
+file = "test/present.toml" 
+file_type = "json"
+key.key = 1
 ```

check_config-0.9.0a1/docs/examples.md

@@ -0,0 +1,32 @@
+# Examples
+
+## Python
+
+```toml
+{! ../example_checkers/python.toml!}
+```
+
+## Ruff
+
+```toml
+{! ../example_checkers/ruff.toml!}
+```
+
+## Black
+
+```toml
+{! ../example_checkers/black.toml!}
+```
+
+## Mypy
+
+```toml
+{! ../example_checkers/mypy.toml!}
+```
+
+## Bashrc
+
+```toml
+{! ../example_checkers/bash.toml!}
+```
+

check_config-0.9.0a1/docs/glossary.md

@@ -0,0 +1,8 @@
+# Glossary
+
+| item | definition|
+|------|-----------|
+| checker type | A type of the check to be executed. Like `lines_present` |
+| checker object | The object being checked, like a file |
+| checker | A concrete instance of a check to be executed, like an `lines_present` for the object `~/.bashrc` |
+| check | A concrete execution of a checker |

{check_config-0.8.6 → check_config-0.9.0a1}/docs/index.md

@@ -34,6 +34,7 @@ Run `check-config --fix` to apply changes, or `check-config` to verify everythin
 ### 🔧 **Shareable Configuration Snippets**
 
 Traditional dotfile repositories force users to adopt entire configuration files. check-config lets you share just the essential parts:
+
 - Share your preferred Python formatting rules without forcing your entire `pyproject.toml`
 - Distribute security settings without overwriting personal aliases
 - Collaborate on team standards while preserving individual preferences
@@ -55,6 +56,7 @@ Perfect for ensuring tools like Ruff, Black, and ESLint use consistent settings
 ### 📦 **Composable Configuration**
 
 Combine multiple configuration files to build your complete setup:
+
 - Base configurations for your team
 - Personal tweaks and preferences  
 - Project-specific requirements
@@ -63,6 +65,7 @@ Combine multiple configuration files to build your complete setup:
 ## Beyond Simple Lines
 
 check-config supports multiple checker types for different configuration needs:
+
 - **Lines present/absent**: Shell configs, text files
 - **Key-value pairs**: TOML, JSON, YAML files
 - **File existence**: Ensure critical files exist

{check_config-0.8.6 → check_config-0.9.0a1}/docs/usage.md

@@ -127,7 +127,6 @@ check-config --any-tags tag1,tag2 --all-tags tag3,tag4 --skip-tags tag5,tag6
 This invocation call checkers which has one of [tag1, tag2], all of [tag3, tag4] and not one of [tag5, tag6]
 specified in their `__tags__` key.
 
-
 ## Pre-commit
 
 [pre-commit](https://pre-commit.com/) helps checking your code before committing git, so you can catch errors
@@ -139,7 +138,7 @@ you want to use:
 ```yaml
 repos:
   - repo: https://github.com/mrijken/check-config
-    rev: v0.8.6
+    rev: v0.9.0.alpha.1
     hooks:
       # Install via Cargo and execute `check-config --fix`
       - id: check_config_fix_install_via_rust

check_config-0.9.0a1/example/check-config-for-usage-doc.toml

@@ -0,0 +1,22 @@
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export SHELL=/bin/bash"
+
+[[lines_present]]
+file = "~/.bashrc"
+lines = "export EDITOR=hx"
+
+
+[[key_value_present]]
+file = "test.json"
+key1.key2.key3="value"
+
+
+[[key_value_present]]
+file = "test.toml"
+inline_table.key="value"
+
+
+[[key_value_present.table]]
+file = "test.toml"
+key="value"