Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotindustries/ogre
Git-like repository for in-memory object versioning
https://github.com/dotindustries/ogre
git in-memory typescript versioning
Last synced: about 1 month ago
JSON representation
Git-like repository for in-memory object versioning
- Host: GitHub
- URL: https://github.com/dotindustries/ogre
- Owner: dotindustries
- License: mit
- Created: 2022-03-06T18:53:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T17:42:38.000Z (about 2 months ago)
- Last Synced: 2024-10-01T17:06:19.079Z (about 2 months ago)
- Topics: git, in-memory, typescript, versioning
- Language: TypeScript
- Homepage: https://ogre.dot.industries
- Size: 1.63 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ogre
An in-memory git-like repository for objects for when you need to
keep the history around for a bit longer. The library uses json-patch RFC6902 for representing diffs.
[](https://codecov.io/gh/dotindustries/ogre) [](https://github.com/dotindustries/ogre/actions/workflows/coverage.yml)
## Features
- Commit
- Branch
- Tags
- Checkout
- Reset (soft and hard)
- Diff
- Status
- Apply
> ⚠️ Currently with a workaround to adapt for setting a value for an undefined prop `{prop: undefined}` will result in
the `compare` call as a `replace`
operation, but will be recorded by the observer as an `add` operation.
> Applying a patch like that will result in internal retry with `add` instead of `replace`.
>
> See https://github.com/Starcounter-Jack/JSON-Patch/issues/280 for details
- Visualization via `@dotinc/ogre-react`
- Merge
- fast-forward
## Usage
```typescript
const repo = new Repository(new ComplexObject());
// apply changes
repo.data.name = "my name";
repo.data.description = "now we have a description";
// commit changes
const init = await repo.commit("initial commit", "author ");
// create a branch named savepoint pointing to the last commit
repo.createBranch("savepoint");
// switch to new branch
repo.checkout("add_details", true);
// apply changes
repo.data.name = "a fancier name";
// a) commit & merge
await repo.commit("change name", "author ");
repo.checkout("main");
repo.merge("add_details");
repo.tag("v1.0.0");
// or b) discard change and go back
// by using the branch name
repo.checkout("main");
// by using the commit hash in a detached state
repo.checkout(init);
```
## TODO
- [ ] Merge
- [ ] recursive
- [ ] octopus