Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-04-04 22:39:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add some documentation and somet testing

Browse Source
This commit is contained in:
BluJ
2022-07-18 13:27:51 -06:00
parent cb39f5f3ba
commit 17d4b8048f
7 changed files with 296 additions and 249 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
emver-lite/mod.ts
View File

@@ -125,6 +125,12 @@ export class EmVer {
public lessThan(other: EmVer): boolean {
return !this.greaterThanOrEqual(other);
}
/**
* Return a enum string that describes (used for switching/iffs)
* to know comparison
* @param other
* @returns
*/
public compare(other: EmVer) {
if (this.equals(other)) {
return "equal" as const;
@@ -134,6 +140,11 @@ export class EmVer {
return "less" as const;
}
}
/**
* Used when sorting emver's in a list using the sort method
* @param other
* @returns
*/
public compareForSort(other: EmVer) {
return matches.matches(this.compare(other))
.when("equal", () => 0 as const)
@@ -250,6 +261,7 @@ export class Checker {
return true;
});
}
public or(...others: (Checker | string)[]): Checker {
return new Checker((value) => {
if (this.check(value)) {
@@ -263,6 +275,11 @@ export class Checker {
return false;
});
}
/**
* A useful example is making sure we don't match an exact version, like !=1.2.3
* @returns
*/
public not(): Checker {
return new Checker((value) => !this.check(value));
}

372
emver-lite/test.ts
View File

@@ -1,240 +1,244 @@
import { expect } from "https://deno.land/x/expect@v0.2.9/mod.ts";
import { notRange, rangeAnd, rangeOf, rangeOr } from "./mod.ts";
import { EmVer, notRange, rangeAnd, rangeOf, rangeOr } from "./mod.ts";
const { test } = Deno;
{
const checker = rangeOf("*");
test("rangeOf('*')", () => {
expect(checker.check("1")).toBe(true);
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
})
test("rangeOf('*') invalid", () => {
expect(() => checker.check("a")).toThrow();
expect(() => checker.check("")).toThrow();
expect(() => checker.check("1..3")).toThrow();
})
const checker = rangeOf("*");
test("rangeOf('*')", () => {
expect(checker.check("1")).toBe(true);
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
});
test("rangeOf('*') invalid", () => {
expect(() => checker.check("a")).toThrow();
expect(() => checker.check("")).toThrow();
expect(() => checker.check("1..3")).toThrow();
});
}
{
const checker = rangeOf(">1.2.3.4");
test(`rangeOf(">1.2.3.4") valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("1.2.3.5")).toBe(true);
expect(checker.check("1.2.3.4.1")).toBe(true);
})
const checker = rangeOf(">1.2.3.4");
test(`rangeOf(">1.2.3.4") valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("1.2.3.5")).toBe(true);
expect(checker.check("1.2.3.4.1")).toBe(true);
});
test(`rangeOf(">1.2.3.4") invalid`, () => {
expect(checker.check("1.2.3.4")).toBe(false);
expect(checker.check("1.2.3")).toBe(false);
expect(checker.check("1")).toBe(false);
})
test(`rangeOf(">1.2.3.4") invalid`, () => {
expect(checker.check("1.2.3.4")).toBe(false);
expect(checker.check("1.2.3")).toBe(false);
expect(checker.check("1")).toBe(false);
});
}
{
const checker = rangeOf("=1.2.3");
test(`rangeOf("=1.2.3") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
})
const checker = rangeOf("=1.2.3");
test(`rangeOf("=1.2.3") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
});
test(`rangeOf("=1.2.3") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.1")).toBe(false);
expect(checker.check("1.2")).toBe(false);
})
test(`rangeOf("=1.2.3") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.1")).toBe(false);
expect(checker.check("1.2")).toBe(false);
});
}
{
const checker = rangeOf(">=1.2.3.4");
test(`rangeOf(">=1.2.3.4") valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("1.2.3.5")).toBe(true);
expect(checker.check("1.2.3.4.1")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
})
const checker = rangeOf(">=1.2.3.4");
test(`rangeOf(">=1.2.3.4") valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("1.2.3.5")).toBe(true);
expect(checker.check("1.2.3.4.1")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
});
test(`rangeOf(">=1.2.3.4") invalid`, () => {
expect(checker.check("1.2.3")).toBe(false);
expect(checker.check("1")).toBe(false);
})
test(`rangeOf(">=1.2.3.4") invalid`, () => {
expect(checker.check("1.2.3")).toBe(false);
expect(checker.check("1")).toBe(false);
});
}
{
const checker = rangeOf("<1.2.3.4");
test(`rangeOf("<1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
expect(checker.check("1.2.3.4")).toBe(false);
})
const checker = rangeOf("<1.2.3.4");
test(`rangeOf("<1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
expect(checker.check("1.2.3.4")).toBe(false);
});
test(`rangeOf("<1.2.3.4") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
})
test(`rangeOf("<1.2.3.4") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
});
}
{
const checker = rangeOf("<=1.2.3.4");
test(`rangeOf("<=1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
})
const checker = rangeOf("<=1.2.3.4");
test(`rangeOf("<=1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
});
test(`rangeOf("<=1.2.3.4") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
})
test(`rangeOf("<=1.2.3.4") valid`, () => {
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("1.2.3.4")).toBe(true);
});
}
{
const checkA = rangeOf(">1");
const checkB = rangeOf("<=2");
const checkA = rangeOf(">1");
const checkB = rangeOf("<=2");
const checker = rangeAnd(checkA, checkB);
test(`simple and(checkers) valid`, () => {
expect(checker.check("2")).toBe(true);
const checker = rangeAnd(checkA, checkB);
test(`simple and(checkers) valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("1.1")).toBe(true);
})
test(`simple and(checkers) invalid`, () => {
expect(checker.check("2.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("0")).toBe(false);
})
expect(checker.check("1.1")).toBe(true);
});
test(`simple and(checkers) invalid`, () => {
expect(checker.check("2.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("0")).toBe(false);
});
}
{
const checkA = rangeOf("<1");
const checkB = rangeOf("=2");
const checkA = rangeOf("<1");
const checkB = rangeOf("=2");
const checker = rangeOr(checkA, checkB);
test(`simple or(checkers) valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("0.1")).toBe(true);
})
test(`simple or(checkers) invalid`, () => {
expect(checker.check("2.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("1.1")).toBe(false);
})
const checker = rangeOr(checkA, checkB);
test(`simple or(checkers) valid`, () => {
expect(checker.check("2")).toBe(true);
expect(checker.check("0.1")).toBe(true);
});
test(`simple or(checkers) invalid`, () => {
expect(checker.check("2.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("1.1")).toBe(false);
});
}
{
const checker = rangeOf('1.2.*');
test(`rangeOf(1.2.*) valid`, () => {
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.1")).toBe(true);
})
test(`rangeOf(1.2.*) invalid`, () => {
expect(checker.check("1.3")).toBe(false);
expect(checker.check("1.3.1")).toBe(false);
const checker = rangeOf("1.2.*");
test(`rangeOf(1.2.*) valid`, () => {
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.1")).toBe(true);
});
test(`rangeOf(1.2.*) invalid`, () => {
expect(checker.check("1.3")).toBe(false);
expect(checker.check("1.3.1")).toBe(false);
expect(checker.check("1.1.1")).toBe(false);
expect(checker.check("1.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("1.1.1")).toBe(false);
expect(checker.check("1.1")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("2")).toBe(false);
})
}
{
const checker = notRange(rangeOf('1.2.*'));
test(`notRange(rangeOf(1.2.*)) valid`, () => {
expect(checker.check("1.3")).toBe(true);
expect(checker.check("1.3.1")).toBe(true);
expect(checker.check("1.1.1")).toBe(true);
expect(checker.check("1.1")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("2")).toBe(true);
})
test(`notRange(rangeOf(1.2.*)) invalid `, () => {
expect(checker.check("1.2")).toBe(false);
expect(checker.check("1.2.1")).toBe(false);
})
expect(checker.check("2")).toBe(false);
});
}
{
const checker = rangeOf('!1.2.*');
test(`!(rangeOf(1.2.*)) valid`, () => {
expect(checker.check("1.3")).toBe(true);
expect(checker.check("1.3.1")).toBe(true);
const checker = notRange(rangeOf("1.2.*"));
test(`notRange(rangeOf(1.2.*)) valid`, () => {
expect(checker.check("1.3")).toBe(true);
expect(checker.check("1.3.1")).toBe(true);
expect(checker.check("1.1.1")).toBe(true);
expect(checker.check("1.1")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("1.1.1")).toBe(true);
expect(checker.check("1.1")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("2")).toBe(true);
})
test(`!(rangeOf(1.2.*)) invalid `, () => {
expect(checker.check("1.2")).toBe(false);
expect(checker.check("1.2.1")).toBe(false);
})
expect(checker.check("2")).toBe(true);
});
test(`notRange(rangeOf(1.2.*)) invalid `, () => {
expect(checker.check("1.2")).toBe(false);
expect(checker.check("1.2.1")).toBe(false);
});
}
{
test(`no and ranges`, () => {
expect(() => rangeAnd()).toThrow()
})
test(`no or ranges`, () => {
expect(() => rangeOr()).toThrow()
})
const checker = rangeOf("!1.2.*");
test(`!(rangeOf(1.2.*)) valid`, () => {
expect(checker.check("1.3")).toBe(true);
expect(checker.check("1.3.1")).toBe(true);
expect(checker.check("1.1.1")).toBe(true);
expect(checker.check("1.1")).toBe(true);
expect(checker.check("1")).toBe(true);
expect(checker.check("2")).toBe(true);
});
test(`!(rangeOf(1.2.*)) invalid `, () => {
expect(checker.check("1.2")).toBe(false);
expect(checker.check("1.2.1")).toBe(false);
});
}
{
test(`no and ranges`, () => {
expect(() => rangeAnd()).toThrow();
});
test(`no or ranges`, () => {
expect(() => rangeOr()).toThrow();
});
}
{
const checker = rangeOf("!>1.2.3.4");
test(`rangeOf("!>1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
})
const checker = rangeOf("!>1.2.3.4");
test(`rangeOf("!>1.2.3.4") invalid`, () => {
expect(checker.check("2")).toBe(false);
expect(checker.check("1.2.3.5")).toBe(false);
expect(checker.check("1.2.3.4.1")).toBe(false);
});
test(`rangeOf("!>1.2.3.4") valid`, () => {
expect(checker.check("1.2.3.4")).toBe(true);
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
})
test(`rangeOf("!>1.2.3.4") valid`, () => {
expect(checker.check("1.2.3.4")).toBe(true);
expect(checker.check("1.2.3")).toBe(true);
expect(checker.check("1")).toBe(true);
});
}
test(">1 && =1.2", () => {
const checker = rangeOf(">1 && =1.2");
const checker = rangeOf(">1 && =1.2");
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.1")).toBe(false);
})
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1.2.1")).toBe(false);
});
test("=1 || =2", () => {
const checker = rangeOf("=1 || =2");
expect(checker.check("1")).toBe(true);
expect(checker.check("2")).toBe(true);
expect(checker.check("3")).toBe(false);
})
const checker = rangeOf("=1 || =2");
expect(checker.check("1")).toBe(true);
expect(checker.check("2")).toBe(true);
expect(checker.check("3")).toBe(false);
});
test(">1 && =1.2 || =2", () => {
const checker = rangeOf(">1 && =1.2 || =2");
const checker = rangeOf(">1 && =1.2 || =2");
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1")).toBe(false);
expect(checker.check("2")).toBe(true);
expect(checker.check("3")).toBe(false);
})
expect(checker.check("1.2")).toBe(true);
expect(checker.check("1")).toBe(false);
expect(checker.check("2")).toBe(true);
expect(checker.check("3")).toBe(false);
});
test("&& before || order of operationns: <1.5 && >1 || >1.5 && <3", () => {
const checker = rangeOf("<1.5 && >1 || >1.5 && <3");
expect(checker.check("1.1")).toBe(true);
expect(checker.check("2")).toBe(true);
const checker = rangeOf("<1.5 && >1 || >1.5 && <3");
expect(checker.check("1.1")).toBe(true);
expect(checker.check("2")).toBe(true);
expect(checker.check("1.5")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("3")).toBe(false);
expect(checker.check("1.5")).toBe(false);
expect(checker.check("1")).toBe(false);
expect(checker.check("3")).toBe(false);
});
})
test("Compare function on the emver", () => {
const a = EmVer.from("1.2.3");
const b = EmVer.from("1.2.4");
expect(a.compare(b) === "less");
expect(b.compare(a) === "greater");
expect(a.compare(a) === "equal");
});
test("Compare for sort function on the emver", () => {
const a = EmVer.from("1.2.3");
const b = EmVer.from("1.2.4");
expect(a.compareForSort(b) === -1);
expect(b.compareForSort(a) === 1);
expect(a.compareForSort(a) === 0);
});