Rif, impact control program

Caution

I completed all the features that was planned. However I haven't tested enough to ensure this program works as intended. I'm currently dog fooding this program and fixing known bugs. If you want to use stable version, then you may have to wait.

About rif

Rif checks corelation between files and decide whether the files are stale or fresh. You can use this program or library(yet to come) when you need to make sure all files are up to date when files refer multiple other files.

This is a project derived from my project called gesign. Gesign was a independent editor thus not so versatile and somewhat clunky to use with other programs. On the other side, rif aims to make a file references checking easily attachable and cross platform by default.

Some use cases

Rif aims to help designers to track document changes. Especially when the documents are highly modular and interconnected. A generic usage is game design documents.

Designer can add a file to rif project and set references(children) to the file(parent). Whenever any child file changes, the parent file's status also changes. This process is manually checked by rif binary(at least for now).

For example,

Create a new file called levelmanager.md and added it into the rif project
Set "level.md" as a reference of "levelmanager.md"
Update level.md's content
Levelmanager.md's status gets updated to stale
Update levelmanager.md's content
Levelmanager.md's status gets updated to "up to date"

In this case levelmanager depends on the level because level's change can affect a behaviour of level manager. Thus change of level's content makes level manager's status to stale which informs a designer to manually reassure if level manager's content should be updated or not. After designer applys proper modification, levelmanager's status gets updated. In this way, designer can minimize logical errors derived from unnoticed file relationships.

Usage

Basics

```bash

Create new .rif file in current working directory

rif init

Show current status of the rif file

rif status -i --ignore : Ignore untracked files -v --verbose : Alsy display list output

Show item list of registered file

Optionaly give file to show only the file into the list

rif ls (optional)

Add file to rif

can be any bash glob pattern e.g "."(whole project), "*"(whole files in current directory)

rif add -f --force : Force add file even there was no change at all.

Remove file from rif

remove doesn't process directory input because it is very prone to unintended operation

you cannot revert a removal

rif rm

Set references to a file

references should exist in rif

rif set

Unset references to a file

references do not have to be valid path

becuase unset operation is technically "set -"

rif unset

Discard file modification

modification of registered files are always tracked

this command discard the tracking and pretend as if nothing has changed

rif discard

Commit addition

And check the impacts of file changes

rif commit -m --message : message to include in history ```

General Usage

Binary ```bash

Initiate rif project with default .rifginoe file

rif init -d

Add all files in current project directory

rif add .

Update a file with update message

rif commit -m "This is important update"

Show status of rif directory

rif status

Show whole rif tree without cutting anything

rif list -d 0 ```

Library

Not yet

Config

You can set several config options. I'm planning to add more config options. Config file is located inc "$PWD/.rif/config".

hook -trigger: Whether trigger hook process after check command -hook command : Process name to trigger -hook argument : Argument type that should be passed to process. It should be one of among "All, None, Fresh, Stale"

Example

Install method

```bash

Simple binary file

cargo install rif --features binary

With color prompt

cargo install rif --features binary,color ```

Build method

Make sure rust langauge is installed. Link ```

Clone the repo

git clone https://github.com/simhyeon/rif

And build with cargo, compiled binary is located in target/release

cd rif && cargo build --release ```