@dotinc/ogre 0.7.0 → 0.8.0

package/.tap/test-results/src/checkout.test.ts.tap

@@ -4,19 +4,19 @@ TAP version 14
     ok 2 - incorrect \# of commits
     ok 3 - points to wrong commit
     ok 4 - repo is not in detached state
-    ok 5 - has a nested object when it shouldn't: {"uuid":"161511a5-022f-4c79-a404-0405eefd476c","name":"my first process template","description":"now we have a description","nested":[]}
+    ok 5 - has a nested object when it shouldn't: {"uuid":"468adbe2-06cc-40aa-bd5d-a21042630c88","name":"my first process template","description":"now we have a description","nested":[]}
     1..5
-ok 1 - checkout prev commit # time=102.861ms
+ok 1 - checkout prev commit # time=109.073ms
 
 # Subtest: checkout new branch with simple name
     ok 1 - HEAD is not moved to target branch
     1..1
-ok 2 - checkout new branch with simple name # time=2.982ms
+ok 2 - checkout new branch with simple name # time=3.238ms
 
 # Subtest: checkout new branch with full ref name
     ok 1 - HEAD is not moved to target branch
     1..1
-ok 3 - checkout new branch with full ref name # time=2.381ms
+ok 3 - checkout new branch with full ref name # time=2.418ms
 
 # Subtest: checkout commit which has two refs pointing leaves HEAD detached
     ok 1 - main does not point to commit
@@ -24,29 +24,29 @@ ok 3 - checkout new branch with full ref name # time=2.381ms
     ok 3 - HEAD is not detached at commit
     ok 4 - HEAD is not pointing to commit
     1..4
-ok 4 - checkout commit which has two refs pointing leaves HEAD detached # time=2.553ms
+ok 4 - checkout commit which has two refs pointing leaves HEAD detached # time=2.813ms
 
 # Subtest: checkout new branch moves head to new branch
     ok 1 - HEAD is not moved to target branch
     1..1
-ok 5 - checkout new branch moves head to new branch # time=2.161ms
+ok 5 - checkout new branch moves head to new branch # time=2.408ms
 
 # Subtest: checkout and create new branch on empty main
     ok 1 - HEAD should point to empty branch
     ok 2 - branch still should be empty
     1..2
-ok 6 - checkout and create new branch on empty main # time=0.672ms
+ok 6 - checkout and create new branch on empty main # time=0.719ms
 
 # Subtest: checkout and create new branch with at least 1 commit
     ok 1 - HEAD should point to new branch
     ok 2 - branch is not pointing to last HEAD commit
     1..2
-ok 7 - checkout and create new branch with at least 1 commit # time=1.557ms
+ok 7 - checkout and create new branch with at least 1 commit # time=2.355ms
 
 # Subtest: replacing default branch on empty master removes main
     ok 1 - new branch w/ incorrect \# of changelog entries
     ok 2 - expected to throw
     1..2
-ok 8 - replacing default branch on empty master removes main # time=5.393ms
+ok 8 - replacing default branch on empty master removes main # time=14.352ms
 
 1..8

package/.tap/test-results/src/commit.test.ts.tap

@@ -3,58 +3,58 @@ TAP version 14
     ok 1 - has changelog entries
     ok 2 - incorrect \# of commits
     1..2
-ok 1 - baseline with 1 commit and zero changelog entries # time=226.717ms
+ok 1 - baseline with 1 commit and zero changelog entries # time=310.08ms
 
 # Subtest: head points to main
     ok 1 - head not pointing where it should
     1..1
-ok 2 - head points to main # time=1.377ms
+ok 2 - head points to main # time=0.969ms
 
 # Subtest: changes are available for commit if starting from empty
     ok 1 - Status does not contain the right amount of changes
     ok 2 - (unnamed test)
     1..2
-ok 3 - changes are available for commit if starting from empty # time=7.555ms
+ok 3 - changes are available for commit if starting from empty # time=12.618ms
 
 # Subtest: no commit without changes
     ok 1 - expected to reject
     1..1
-ok 4 - no commit without changes # time=7.86ms
+ok 4 - no commit without changes # time=19.287ms
 
 # Subtest: no commit without changes after recent commit
     ok 1 - expected to reject
     1..1
-ok 5 - no commit without changes after recent commit # time=30.66ms
+ok 5 - no commit without changes after recent commit # time=4.051ms
 
 # Subtest: overwrite nested array changes are recognized
     1..0
-ok 6 - overwrite nested array changes are recognized # time=14.517ms
+ok 6 - overwrite nested array changes are recognized # time=4.302ms
 
 # Subtest: change of nested array element is recognized
     1..0
-ok 7 - change of nested array element is recognized # time=4.234ms
+ok 7 - change of nested array element is recognized # time=17.639ms
 
 # Subtest: treeHash of commit is matching content
     ok 1 - should be equal
     ok 2 - tree hash mismatch
     1..2
-ok 8 - treeHash of commit is matching content # time=2.734ms
+ok 8 - treeHash of commit is matching content # time=3.081ms
 
 # Subtest: no commit --amend without commit
     ok 1 - expected to reject
     1..1
-ok 9 - no commit --amend without commit # time=2.185ms
+ok 9 - no commit --amend without commit # time=2.163ms
 
 # Subtest: main moves to recent commit
     ok 1 - head does not point to recent commit
     1..1
-ok 10 - main moves to recent commit # time=2.257ms
+ok 10 - main moves to recent commit # time=1.891ms
 
 # Subtest: two commits with 3 changes
     ok 1 - incorrect \# of changelog entries
     ok 2 - incorrect \# of commits
     1..2
-ok 11 - two commits with 3 changes # time=2.852ms
+ok 11 - two commits with 3 changes # time=14.949ms
 
 # Subtest: array push double-change, 6 changes, 3 commits
     ok 1 - incorrect \# of changelog entries
@@ -62,7 +62,7 @@ ok 11 - two commits with 3 changes # time=2.852ms
     ok 3 - \#incorrect \# of changes in commit\#1
     ok 4 - \#incorrect \# of changes in commit\#2
     1..4
-ok 12 - array push double-change, 6 changes, 3 commits # time=9.258ms
+ok 12 - array push double-change, 6 changes, 3 commits # time=5.731ms
 
 # Subtest: all refs OK, when committing on new branch while main is empty main
     ok 1 - main should not point to a commit
@@ -70,7 +70,7 @@ ok 12 - array push double-change, 6 changes, 3 commits # time=9.258ms
     ok 3 - branch should now be visible
     ok 4 - HEAD is pointing to wrong branch
     1..4
-ok 13 - all refs OK, when committing on new branch while main is empty main # time=10.789ms
+ok 13 - all refs OK, when committing on new branch while main is empty main # time=3.891ms
 
 # Subtest: commit --amend changes hash on content change
     ok 1 - hash should have changed
@@ -80,7 +80,7 @@ ok 13 - all refs OK, when committing on new branch while main is empty main # ti
     ok 5 - we are on the wrong branch
     ok 6 - main should point to changed commit hash
     1..6
-ok 14 - commit --amend changes hash on content change # time=17.168ms
+ok 14 - commit --amend changes hash on content change # time=41.767ms
 
 # Subtest: commit --amend changes hash on message change
     ok 1 - hash should have changed
@@ -90,7 +90,7 @@ ok 14 - commit --amend changes hash on content change # time=17.168ms
     ok 5 - we are on the wrong branch
     ok 6 - main should point to changed commit hash
     1..6
-ok 15 - commit --amend changes hash on message change # time=3.43ms
+ok 15 - commit --amend changes hash on message change # time=20.981ms
 
 # Subtest: commit at detached HEAD does not affect main, but moves head
     ok 1 - HEAD did not move to commit
@@ -99,12 +99,12 @@ ok 15 - commit --amend changes hash on message change # time=3.43ms
     ok 4 - HEAD did not move to commit
     ok 5 - main branch did not stay at last commit
     1..5
-ok 16 - commit at detached HEAD does not affect main, but moves head # time=21.498ms
+ok 16 - commit at detached HEAD does not affect main, but moves head # time=29.839ms
 
 # Subtest: commit at detached HEAD saved to a branch
     ok 1 - savepoint branch should point to last detached commit
     1..1
-ok 17 - commit at detached HEAD saved to a branch # time=2.548ms
+ok 17 - commit at detached HEAD saved to a branch # time=3.199ms
 
 # Subtest: commit --amend changes hash on message change even in detached HEAD
     ok 1 - hash should have changed
@@ -114,6 +114,6 @@ ok 17 - commit at detached HEAD saved to a branch # time=2.548ms
     ok 5 - HEAD is not pointing to detached commit
     ok 6 - main should point to changed commit hash
     1..6
-ok 18 - commit --amend changes hash on message change even in detached HEAD # time=14.447ms
+ok 18 - commit --amend changes hash on message change even in detached HEAD # time=14.841ms
 
 1..18

package/.tap/test-results/src/merge.test.ts.tap

@@ -2,7 +2,7 @@ TAP version 14
 # Subtest: merge with no commit fails
     ok 1 - expected to throw
     1..1
-ok 1 - merge with no commit fails # time=37.307ms
+ok 1 - merge with no commit fails # time=23.359ms
 
 # Subtest: merge fast-forward
     ok 1 - HEAD not pointing to new_branch
@@ -11,6 +11,6 @@ ok 1 - merge with no commit fails # time=37.307ms
     ok 4 - master is not at expected commit
     ok 5 - fast-forward failed, superfluous commit detected
     1..5
-ok 2 - merge fast-forward # time=11.162ms
+ok 2 - merge fast-forward # time=8.655ms
 
 1..2

package/.tap/test-results/src/repository.test.ts.tap

@@ -1,9 +1,9 @@
 TAP version 14
 # Subtest: diff is ok
     ok 1 - main is pointing at wrong commit
-    ok 2 - invalid \# of change entries: [{"op":"add","path":"/nested/0","value":{"uuid":"c768856c-151b-45c6-8485-2f03e2611703","name":"new name"}},{"op":"add","path":"/nested/1","value":{"uuid":"755120b7-aae7-4248-8c70-18be55c63c81","name":"first name"}}]
+    ok 2 - invalid \# of change entries: [{"op":"add","path":"/nested/0","value":{"uuid":"d7c4a756-6ce4-41a2-8bac-298267bce00f","name":"new name"}},{"op":"add","path":"/nested/1","value":{"uuid":"fbf2e9a6-d72a-445b-878e-f1cde3a8bd11","name":"first name"}}]
     1..2
-ok 1 - diff is ok # time=73.047ms
+ok 1 - diff is ok # time=58.541ms
 
 # Subtest: restore
     # Subtest: history check
@@ -13,7 +13,7 @@ ok 1 - diff is ok # time=73.047ms
         ok 4 - incorrect \# of commits
         ok 5 - incorrect \# of changelog entries
         1..5
-    ok 1 - history check # time=83.173ms
+    ok 1 - history check # time=83.156ms
     
     # Subtest: reconstruct with 2 commits
         ok 1 - main is pointing at wrong commit
@@ -22,10 +22,10 @@ ok 1 - diff is ok # time=73.047ms
         ok 4 - incorrect \# of commits
         ok 5 - incorrect \# of changelog entries
         1..5
-    ok 2 - reconstruct with 2 commits # time=8.194ms
+    ok 2 - reconstruct with 2 commits # time=5.333ms
     
     1..2
-ok 2 - restore # time=135.274ms
+ok 2 - restore # time=132.936ms
 
 # Subtest: history
     # Subtest: history contains HEAD ref
@@ -34,15 +34,15 @@ ok 2 - restore # time=135.274ms
         ok 3 - should be equal
         ok 4 - should be equal
         1..4
-    ok 1 - history contains HEAD ref # time=81.692ms
+    ok 1 - history contains HEAD ref # time=54.656ms
     
     # Subtest: empty history unreachable HEAD
         ok 1 - expected to throw
         1..1
-    ok 2 - empty history unreachable HEAD # time=2.603ms
+    ok 2 - empty history unreachable HEAD # time=2.576ms
     
     1..2
-ok 3 - history # time=181.711ms
+ok 3 - history # time=112.596ms
 
 # Subtest: reset
     # Subtest: reset hard
@@ -50,54 +50,54 @@ ok 3 - history # time=181.711ms
         ok 2 - wrong \# of changes in diff
         ok 3 - failed to reset
         1..3
-    ok 1 - reset hard # time=2.672ms
+    ok 1 - reset hard # time=2.3ms
     
     1..1
-ok 4 - reset # time=65.698ms
+ok 4 - reset # time=56.424ms
 
 # Subtest: status
     # Subtest: clean repo no change
         ok 1 - Shouldn't have pending changes
         1..1
-    ok 1 - clean repo no change # time=436.139ms
+    ok 1 - clean repo no change # time=395.567ms
     
     # Subtest: clean repo pending change
         ok 1 - Status doesn't contain the expected \# of changes: [{"op":"replace","path":"/name","value":"changed name"}]
         1..1
-    ok 2 - clean repo pending change # time=0.664ms
+    ok 2 - clean repo pending change # time=0.632ms
     
     # Subtest: reading status shouldn't clean observer
         ok 1 - Status doesn't contain the expected \# of changes: [{"op":"replace","path":"/name","value":"changed name"}]
         ok 2 - Status doesn't contain the expected \# of changes: [{"op":"replace","path":"/name","value":"changed name"}]
         ok 3 - why different pending changes??
         1..3
-    ok 3 - reading status shouldn't clean observer # time=1.015ms
+    ok 3 - reading status shouldn't clean observer # time=1.058ms
     
     # Subtest: after commit no change
         ok 1 - Shouldn't have pending changes
         1..1
-    ok 4 - after commit no change # time=1.323ms
+    ok 4 - after commit no change # time=1.177ms
     
     # Subtest: after commit pending change
         ok 1 - Shouldn't have pending changes
         ok 2 - Status doesn't contain changes
         1..2
-    ok 5 - after commit pending change # time=1.537ms
+    ok 5 - after commit pending change # time=1.347ms
     
     # Subtest: after commit pending change for rewrite array
         ok 1 - Shouldn't have pending changes
         ok 2 - Status doesn't contain changes
         1..2
-    ok 6 - after commit pending change for rewrite array # time=1.504ms
+    ok 6 - after commit pending change for rewrite array # time=1.355ms
     
     # Subtest: change of nested array element prop
         ok 1 - Shouldn't have pending changes
         ok 2 - Status doesn't contain changes
         1..2
-    ok 7 - change of nested array element prop # time=1.993ms
+    ok 7 - change of nested array element prop # time=1.673ms
     
     1..7
-ok 5 - status # time=506.042ms
+ok 5 - status # time=462.807ms
 
 # Subtest: apply
     # Subtest: single patch
@@ -107,7 +107,7 @@ ok 5 - status # time=506.042ms
         ok 4 - Status doesn't contain changes
         ok 5 - It should have the right changes
         1..5
-    ok 1 - single patch # time=107.281ms
+    ok 1 - single patch # time=107.416ms
     
     # Subtest: patch for undefined props with workaround
         ok 1 - Shouldn't have pending changes
@@ -115,7 +115,7 @@ ok 5 - status # time=506.042ms
         ok 3 - The final state should match up
         ok 4 - Status should contain 1 change
         1..4
-    ok 2 - patch for undefined props with workaround # time=1.395ms
+    ok 2 - patch for undefined props with workaround # time=1.687ms
     
     # Subtest: multiple patches
         ok 1 - Shouldn't have pending changes
@@ -124,14 +124,14 @@ ok 5 - status # time=506.042ms
         ok 4 - It should have the right changes
         ok 5 - The final state does not match up
         1..5
-    ok 3 - multiple patches # time=1.515ms
+    ok 3 - multiple patches # time=1.817ms
     
     1..3
-ok 6 - apply # time=183.987ms
+ok 6 - apply # time=164.57ms
 
 # Subtest: restoring from history
     ok 1 - restored object does not equal last version.
     1..1
-ok 7 - restoring from history # time=2.752ms
+ok 7 - restoring from history # time=2.868ms
 
 1..7

package/.tap/test-results/src/tag.test.ts.tap

@@ -2,18 +2,18 @@ TAP version 14
 # Subtest: cannot tag on an empty repo
     ok 1 - expected to throw
     1..1
-ok 1 - cannot tag on an empty repo # time=24.701ms
+ok 1 - cannot tag on an empty repo # time=26.484ms
 
 # Subtest: can create simple tag pointing to HEAD
     ok 1 - should be equal
     ok 2 - tag is not pointing to expected commit
     ok 3 - reference was not present in history
     1..3
-ok 2 - can create simple tag pointing to HEAD # time=9.977ms
+ok 2 - can create simple tag pointing to HEAD # time=20.333ms
 
 # Subtest: cannot create tag with whitespace
     ok 1 - expected to throw
     1..1
-ok 3 - cannot create tag with whitespace # time=2.361ms
+ok 3 - cannot create tag with whitespace # time=3.092ms
 
 1..3

package/.tap/test-results/src/utils.test.ts.tap

@@ -3,41 +3,41 @@ TAP version 14
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 1 - author <email@domain.info> # time=3.845ms
+ok 1 - author <email@domain.info> # time=3.718ms
 
 # Subtest: author with space <email@domain.info>
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 2 - author with space <email@domain.info> # time=0.829ms
+ok 2 - author with space <email@domain.info> # time=0.644ms
 
 # Subtest: author @handle
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 3 - author @handle # time=0.553ms
+ok 3 - author @handle # time=0.429ms
 
 # Subtest: author with space @handle
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 4 - author with space @handle # time=0.561ms
+ok 4 - author with space @handle # time=0.447ms
 
 # Subtest: email@domain.info
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 5 - email@domain.info # time=0.709ms
+ok 5 - email@domain.info # time=0.602ms
 
 # Subtest: @handle
     ok 1 - should be equal
     ok 2 - should be equal
     1..2
-ok 6 - @handle # time=0.843ms
+ok 6 - @handle # time=0.585ms
 
 # Subtest: empty author
     ok 1 - expected to throw
     1..1
-ok 7 - empty author # time=3.216ms
+ok 7 - empty author # time=2.222ms
 
 1..7

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.8.0 (Sat Mar 23 2024)
+
+#### 🚀 Enhancement
+
+- feat: expose util functions [#160](https://github.com/dotindustries/ogre/pull/160) ([@nadilas](https://github.com/nadilas))
+- feat: expose util functions ([@nadilas](https://github.com/nadilas))
+
+#### Authors: 1
+
+- [@nadilas](https://github.com/nadilas)
+
+---
+
 # v0.7.0 (Sat Mar 23 2024)
 
 #### 🚀 Enhancement

package/lib/git2json.js

@@ -1,21 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatGit2Json = void 0;
-const repository_1 = require("./repository");
 const utils_1 = require("./utils");
 const findRefs = (commit, refs) => {
     const list = [];
-    const headRef = refs.get(repository_1.REFS_HEAD_KEY);
+    const headRef = refs.get(utils_1.REFS_HEAD_KEY);
     for (const [key, ref] of refs.entries()) {
         if (ref.value === commit.hash) {
-            if ((0, repository_1.isTagRef)(key)) {
+            if ((0, utils_1.isTagRef)(key)) {
                 list.push(`tag: ${ref.name}`);
             }
             else {
                 list.push(ref.name);
             }
             // also check if HEAD is pointing to this ref
-            if (headRef && headRef.value === (0, repository_1.createHeadRefValue)(key)) {
+            if (headRef && headRef.value === (0, utils_1.createHeadRefValue)(key)) {
                 list.push(headRef.name);
             }
         }

package/lib/repository.d.ts

@@ -1,8 +1,6 @@
-import { Operation, JsonPatchError } from "fast-json-patch";
+import { JsonPatchError, Operation } from "fast-json-patch";
 import { Commit } from "./commit";
 import { History, Reference } from "./interfaces";
-export declare const REFS_HEAD_KEY = "HEAD";
-export declare const REFS_MAIN_KEY: string;
 export interface RepositoryOptions<T extends {
     [k: string]: any;
 }> {
@@ -87,18 +85,3 @@ export declare class Repository<T extends {
     ref(reference: string): string | undefined;
     tag(tag: string): string;
 }
-export declare const createHeadRefValue: (refKey: string) => string;
-export declare const isTagRef: (refKey: string) => boolean;
-export declare const cleanRefValue: (ref: string) => string;
-export declare const brancheNameToRef: (name: string) => string;
-export declare const tagToRef: (tag: string) => string;
-export declare const validateBranchName: (name: string) => void;
-export declare const validateRef: (name: string, oneLevel?: boolean) => void;
-/**
- * Prints the underlying changelog of a repository
- * @param repository
- */
-export declare const printChangeLog: <T extends {
-    [k: string]: any;
-}>(repository: RepositoryObject<T>) => void;
-export declare const printChange: (chg: Operation) => void;