CocytusDEDI commented 3 months ago

Specification

There is a .{file_name}_version_control folder per file
- file_name includes the extension of the file
Versions are saved to the folder .{file_name}_version_control/versions
- Version file names are integers.
  - The number starts at one and increases by one per version
  - The latest version will be saved as the name of an empty file in .{file_name}_version_control
- Version contents are the document but compressed
User should be able to change the contents of their document to that of any previous version

Clarification

Version number never decreases
Reversion to a previous version is not saved until the user saves the reverted document as a new version

CocytusDEDI commented 3 months ago

Version file names are hashes (SHA1 most likely)
Versions are JSON dictionaries with the keys:
- previous: a list of immediate previous versions
- next: a list of immediate next versions
- contents: the compressed contents of that version
Branches can be (optionally) named, this is done in the folder .{file_name}_version_control/versions
- Branch file names are that of the first version in that branch
- The content of the branch file is the name
- Switching branches changes the current_version file to the latest version in that branch
The current version should be stored under a file named current_version. This change makes the version control file more readable for anyone who wishes to do so.
The use of previous and next instead of parent and child is also to make the file system more readable to inexperienced users that want to look through the version control manually (not that it's suggested they should)
Reverting files:
- Reverting files only changes the current file's contents, and does not change the current_version file
- Saving changes after reverting a file saves it as the next of the current_version

'immediate' versions are versions that are in direct contact with the current version

AndycptSher commented 3 months ago