@dragonshorn-studios/elyseum-cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # Elyseum CLI
2
+
3
+ > **Notice:** This is a work-in-progress personal package. Use at your own risk.
4
+
5
+ Elyseum CLI is a command-line tool for coverage reporting. It provides various reporters to display coverage information in different formats.
6
+
7
+ ## Installation
8
+
9
+ You can install the package globally using npm:
10
+
11
+ ```bash
12
+ npm install -g @dragonshorn/elyseum-cli
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ### Commands
18
+
19
+ - `diff-coverage`: Calculate coverage for changed files.
20
+ - `coverage`: Calculate coverage for all files.
21
+
22
+ ### Options
23
+
24
+ - `--reporter.coverage`: Coverage reporter(s), separated by commas. Available reporters: `cli-table`, `github-pr-comment`.
25
+ - `--reporter.coverage.colors`: Use colors in coverage reporter (if supported).
26
+ - `--reporter.coverage.details`: Show coverage details.
27
+ - `--reporter.coverage.quality-gate`: Coverage quality gate.
28
+
29
+ ### Examples
30
+
31
+ #### Calculate Coverage for Changed Files
32
+
33
+ ```bash
34
+ elyseum-cli diff-coverage --head <HEAD_COMMIT> --base <BASE_COMMIT>
35
+ ```
36
+
37
+ #### Calculate Coverage for All Files
38
+
39
+ ```bash
40
+ elyseum-cli coverage
41
+ ```
42
+
43
+ #### Use Multiple Reporters
44
+
45
+ ```bash
46
+ elyseum-cli diff-coverage --reporter.coverage=cli-table,github-pr-comment
47
+ ```
48
+
49
+ #### Use Colors in Coverage Reporter
50
+
51
+ ```bash
52
+ elyseum-cli diff-coverage --reporter.coverage.colors
53
+ ```
54
+
55
+ #### Show Coverage Details
56
+
57
+ ```bash
58
+ elyseum-cli diff-coverage --reporter.coverage.details
59
+ ```
60
+
61
+ #### Set Coverage Quality Gate
62
+
63
+ ```bash
64
+ elyseum-cli diff-coverage --reporter.coverage.quality-gate=80
65
+ ```
66
+
67
+ ## Configuration
68
+
69
+ You can also configure the CLI using a `.elyseum.yml` file. Here is an example configuration:
70
+
71
+ ```yaml
72
+ reporter:
73
+ coverage:
74
+ cli-table:
75
+ color: true
76
+ diff: true
77
+ github-pr-comment:
78
+ file: "github.pr.coverage.md"
79
+ qualityGate: 80
80
+ ```
81
+
82
+ ## License
83
+
84
+ This project is licensed under the MIT License.
@@ -0,0 +1,7 @@
1
+ export declare class CoverageCommand {
2
+ constructor();
3
+ run(args: any): Promise<void>;
4
+ private calculateCoverage;
5
+ private getCoverageReport;
6
+ }
7
+ //# sourceMappingURL=coverage-command.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"coverage-command.d.ts","sourceRoot":"","sources":["../../src/commands/coverage-command.ts"],"names":[],"mappings":"AASA,qBAAa,eAAe;;IAGb,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;YAoB5B,iBAAiB;YA4DjB,iBAAiB;CAWhC"}
@@ -0,0 +1,8 @@
1
+ export declare class DiffCoverageCommand {
2
+ constructor();
3
+ run(args: any): Promise<void>;
4
+ private calculateDiffCoverage;
5
+ private getCoverageReport;
6
+ private getChangedFiles;
7
+ }
8
+ //# sourceMappingURL=diff-coverage-command.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"diff-coverage-command.d.ts","sourceRoot":"","sources":["../../src/commands/diff-coverage-command.ts"],"names":[],"mappings":"AAaA,qBAAa,mBAAmB;;IAGjB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;YAwD5B,qBAAqB;YAoIrB,iBAAiB;YAYjB,eAAe;CA4E9B"}
@@ -0,0 +1,10 @@
1
+ declare class Config {
2
+ private static instance;
3
+ private config;
4
+ private constructor();
5
+ static getInstance(args?: any): Config;
6
+ get(key: string, defaultValue?: any): any;
7
+ getFirst(keys: string[], defaultValue?: any): any;
8
+ }
9
+ export default Config;
10
+ //# sourceMappingURL=config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,cAAM,MAAM;IACV,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,OAAO,CAAC,MAAM,CAAM;IAEpB,OAAO;WA6BO,WAAW,CAAC,IAAI,GAAE,GAAQ,GAAG,MAAM;IAO1C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,GAAU,GAAG,GAAG;IAa/C,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,YAAY,GAAE,GAAU,GAAG,GAAG;CAS/D;AAED,eAAe,MAAM,CAAC"}
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}