Merge pull request #13 from GeraldIr/preset-global-updates

1.2.0

Author: rtmiz

.github/workflows/commit-test.yml

@@ -1,24 +1,24 @@
-name: Run Unit Test via Pytest  
-  
-on: [push]  
-  
-jobs:  
-  build:  
-    runs-on: ubuntu-latest  
-    strategy:  
-      matrix:  
-        python-version: ["3.10", "3.11", "3.12", "3.13"]  
-  
-    steps:  
-      - uses: actions/checkout@v3  
-      - name: Set up Python ${{ matrix.python-version }}  
-        uses: actions/setup-python@v4  
-        with:  
-          python-version: ${{ matrix.python-version }}  
-          
+name: Run Unit Test via Pytest
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
       - name: Bootstrap poetry
         run: |
-          curl -sL https://install.python-poetry.org | python - -y 
+          curl -sL https://install.python-poetry.org | python - -y
 
       - name: Update PATH
         run: echo "$HOME/.local/bin" >> $GITHUB_PATH
@@ -47,10 +47,10 @@ jobs:
       - name: Pre-commit hooks
         run: poetry run pre-commit run --all-files
 
-      - name: Test with pytest  
-        run: |  
-          coverage run -m pytest  -v -s 
-          
-      - name: Generate Coverage Report  
-        run: |  
-          coverage report -m
+      - name: Run pytest
+        run: poetry run pytest --cov --cov-branch --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -0,0 +1,5 @@
+.*
+!.xet
+!.pre-commit-config.yaml
+**/__pycache__
+poetry.lock

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.9.0
+  hooks:
+    - id: pyupgrade
+      args:
+        - --keep-runtime-typing
+        - --py39-plus
+
+- repo: https://github.com/python-poetry/poetry
+  rev: 1.5.1
+  hooks:
+    - id: poetry-check
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+    - id: isort
+      name: isort (python)
+      args: ["--profile", "black"]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  -   id: trailing-whitespace
+  -   id: end-of-file-fixer
+  -   id: check-yaml
+
+- repo: https://github.com/psf/black
+  rev: 23.7.0
+  hooks:
+  -   id: black
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: "v0.0.280"
+  hooks:
+  - id: ruff

.xet

@@ -1,23 +1,23 @@
 {
-    "pyversion": {
+    "ppversion": {
         "type": "tag",
-        "filepath": "xet/xet.py",
-        "flags": "ver",
+        "filepath": "pyproject.toml",
+        "flags": null,
         "wrapper": "\"",
         "presets": null,
         "ssh": null,
-        "tag": "VERSION = ",
+        "tag": "version = ",
         "occurences": ":",
         "end": ""
     },
-    "ppversion": {
+    "pyversion": {
         "type": "tag",
-        "filepath": "pyproject.toml",
-        "flags": "ver",
+        "filepath": "xet/xet.py",
+        "flags": null,
         "wrapper": "\"",
         "presets": null,
         "ssh": null,
-        "tag": "version = ",
+        "tag": "VERSION = ",
         "occurences": ":",
         "end": ""
     }

README.md

@@ -7,32 +7,37 @@
 ## Overview
 
 xet is a command-line tool for managing and modifying values in multiple files using a configuration file (`.xet`). It supports various methods of identifying and modifying values, including tags, line/column positions, and regular expressions.
+You can create presets and change between them on the fly.
 
 ## Installation
 
 
 ```sh
-pip install xet
+pipx install xet
 ```
 or
 ```sh
-pipx install xet
+pip install xet
 ```
 
 
 ## Commands
 
-### Initialize Configuration
+### Configuration
+
+#### Initialize Configuration
 
 ```sh
 xet init
 ```
 - Options:
-   - `-g, --global`: Global Mode. Creates a `.xet` file in the XDG_CONFIG_HOME folder instead of locally. 
+   - `-g, --global`: Global Mode. Creates a `.xet` file in the XDG_CONFIG_HOME folder instead of locally.
 
 Creates an empty `.xet` if it does not already exist.
 
-Any xet command will use the `.xet` file in the immediate directory, unless the  `-g, --global` flag is set, then the global  `.xet` file will be used instead.
+Any xet command will use the `.xet` file in the immediate directory, if there is no local `.xet` the global  `.xet` file will be used instead. You can force the usage of the global `.xet` using the `-g, --global` flag.
+
+#### Open .xet in editor
 
 ```sh
 xet edit
@@ -42,10 +47,33 @@ xet edit
 
 Opens `.xet` in your standard editor or nano.
 
+#### Clarify .xet directory
+
+```sh
+xet which
+```
 
-### Add Entries to Configuration
+Shows the absolute path to the default `.xet` that will be used if any xet command is run.
 
-#### Add a Tag-Based Entry
+#### Print .xet entries
+
+```sh
+xet show [options]
+```
+
+Options:
+   - `-e, --except <flags>`: Exclude entries with specified flags.
+   - `-o, --only <flags>`: Include only entries with specified flags.
+   - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
+   - `-g, --global`: Use the global `.xet`.
+
+Shows the `.xet` entries with the given optional filters applied.
+
+
+#### Add Entries to Configuration
+
+##### Add a Tag-Based Entry
 
 ```sh
 xet add tag <name> <filepath> <tag> [options]
@@ -59,12 +87,12 @@ xet add tag <name> <filepath> <tag> [options]
    - `-w, --wrapper <char>`: Wrap the value with a character (e.g., quotes), also gets stripped in get mode.
    - `-o, --occurences <index or slice>`: Specify which occurrences to modify (string formatted like a list index in python, can be slices).
    - `-e, --end <str>`: Will get appended in the line after value and wrappers, also gets stripped in get mode.
-   - `-p, --preset <str> <str>`: Name and value of preset, option can be repeated to add multiple presets. 
+   - `-p, --preset <str> <str>`: Name and value of preset, option can be repeated to add multiple presets.
    - `-s, --ssh <str>`: Hostname of ssh-host the file is found at, as found in openSSH config file.
    - `-g, --global`: Add the entry to the global `.xet`.
 
 
-#### Add a Line/Column-Based Entry
+##### Add a Line/Column-Based Entry
 
 ```sh
 xet add lc <name> <filepath> <line> <column> [options]
@@ -79,7 +107,7 @@ xet add lc <name> <filepath> <line> <column> [options]
    - `-s, --ssh <str>`: Hostname of ssh-host the file is found at, as found in openSSH config file.
    - `-g, --global`: Add the entry to the global `.xet`.
 
-#### Add a Regex-Based Entry
+##### Add a Regex-Based Entry
 
 ```sh
 xet add regex <name> <filepath> <regex> [options]
@@ -95,32 +123,86 @@ xet add regex <name> <filepath> <regex> [options]
    - `-s, --ssh <str>`: Hostname of ssh-host the file is found at, as found in openSSH config file.
    - `-g, --global`: Add the entry to the global `.xet`.
 
-### Get Values from Configured Files
+#### Update Entries
+
+```sh
+xet update <key> <value> [options]
+```
+- `<key>`: The key of the property to update ('name' will update the key of the entry).
+- `<value>`: The new value for the property.
+Options:
+   - `-e, --except <flags>`: Exclude entries with specified flags.
+   - `-o, --only <flags>`: Include only entries with specified flags.
+   - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
+   - `-g, --global`: Use the global `.xet`.
+
+Updates the value of a property across filtered entries in the `.xet`.
+
+#### Remove Entries
+
+```sh
+xet remove [options]
+```
+
+Options:
+   - `-e, --except <flags>`: Exclude entries with specified flags.
+   - `-o, --only <flags>`: Include only entries with specified flags.
+   - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
+   - `-g, --global`: Use the global `.xet`.
+
+Removes the specified entries from the `.xet`.
+
+#### Snapshot
 
 ```sh
-xet get [-e <flags>] [-o <flags>] [-n <names>]
+xet snapshot <preset> [options]
+```
+- `<preset>`: The name of the new preset.
+Options:
+   - `--first`: When there is divergent values in seperate occurences in an entry, use the first value for the preset.
+   - `--split`: When there is divergent values in seperate occurences in an entry, split the entry such that no divergences remain.
+   - `-e, --except <flags>`: Exclude entries with specified flags.
+   - `-o, --only <flags>`: Include only entries with specified flags.
+   - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
+   - `-g, --global`: Use the global `.xet`.
+
+
+Adds a preset to the filtered entries using their current values.
+
+### Modifying Values
+
+#### Get Values from Configured Files
+
+```sh
+xet get [options]
 ```
 
 Options:
    - `-e, --except <flags>`: Exclude entries with specified flags.
    - `-o, --only <flags>`: Include only entries with specified flags.
    - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
    - `-g, --global`: Use the global `.xet`.
 
-### Set Values in Configured Files
+
+#### Set Values in Configured Files
 
 ```sh
-xet set <value> [-e <flags>] [-o <flags>] [-n <names>]
+xet set <value> [options]
 ```
 
 - `<value>`: The new value to be set.
 Options:
    - `-e, --except <flags>`: Exclude entries with specified flags.
    - `-o, --only <flags>`: Include only entries with specified flags.
    - `-n, --names <names>`: Include only entries with specified names.
+   - `-p, --path <path>`: Include only entries with specified path.
    - `-g, --global`: Use the global `.xet`.
 
-### Set Values to Preset
+#### Set Values to Preset
 
 ```sh
 xet preset <preset>
@@ -130,16 +212,31 @@ xet preset <preset>
 - Options:
    - `-g, --global`: Use the global `.xet`.
 
-### Remove an Entry
+### History
+
+#### Undo
 
 ```sh
-xet remove <name>
+xet undo
 ```
-- `<name>`: Name of the entry to be removed.
-- Options:
-   - `-g, --global`: Remove the specified entry from the global `.xet`.
 
-Removes the specified entry from `.xet` file.
+Undoes the changes of the last command.
+
+#### Redo
+
+```sh
+xet redo
+```
+
+Redoes the last undone changes.
+
+#### Forget
+
+```sh
+xet forget
+```
+
+Reset history file.
 
 ## Example Usage
 
@@ -172,4 +269,3 @@ Removes the specified entry from `.xet` file.
    ```sh
    xet remove version
    ```
-