@greenarmor/ges-report-generator 0.3.0 → 0.3.2
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 +60 -0
- package/package.json +6 -6
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# @greenarmor/ges-report-generator
|
|
2
|
+
|
|
3
|
+
Compliance and security report generation for the [Green Engineering Standard Framework (GESF)](https://github.com/greenarmor/gesf).
|
|
4
|
+
|
|
5
|
+
Produces formatted compliance reports in Markdown and HTML, combining framework scores, evaluated controls, and audit findings into professional documents.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @greenarmor/ges-report-generator
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
| Function | Description |
|
|
16
|
+
|----------|-------------|
|
|
17
|
+
| `generateMarkdownReport(options, score, controls, findings?)` | Generate a full compliance report in Markdown |
|
|
18
|
+
| `generateHtmlReport(options, score, controls, findings?)` | Generate a full compliance report in HTML |
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { generateMarkdownReport, generateHtmlReport } from '@greenarmor/ges-report-generator';
|
|
24
|
+
import { generateScoreFile } from '@greenarmor/ges-scoring-engine';
|
|
25
|
+
import { createGDPRControls } from '@greenarmor/ges-compliance-engine';
|
|
26
|
+
|
|
27
|
+
const controls = createGDPRControls();
|
|
28
|
+
const score = generateScoreFile(controls, ['GDPR', 'OWASP', 'NIST', 'CIS']);
|
|
29
|
+
|
|
30
|
+
const markdown = generateMarkdownReport(
|
|
31
|
+
{ projectName: 'MyApp', format: 'markdown', frameworks: ['GDPR', 'OWASP'] },
|
|
32
|
+
score,
|
|
33
|
+
controls
|
|
34
|
+
);
|
|
35
|
+
|
|
36
|
+
const html = generateHtmlReport(
|
|
37
|
+
{ projectName: 'MyApp', format: 'html', frameworks: ['GDPR', 'OWASP'] },
|
|
38
|
+
score,
|
|
39
|
+
controls
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Report Contents
|
|
44
|
+
|
|
45
|
+
- Executive summary with overall compliance score
|
|
46
|
+
- Per-framework breakdown with pass/fail/warning counts
|
|
47
|
+
- Individual control details with status and remediation guidance
|
|
48
|
+
- Audit findings from source code scans (when provided)
|
|
49
|
+
- Recommendations and next steps
|
|
50
|
+
|
|
51
|
+
## Related Packages
|
|
52
|
+
|
|
53
|
+
- [`@greenarmor/ges-core`](https://www.npmjs.com/package/@greenarmor/ges-core) — Types and constants
|
|
54
|
+
- [`@greenarmor/ges-scoring-engine`](https://www.npmjs.com/package/@greenarmor/ges-scoring-engine) — Score generation
|
|
55
|
+
- [`@greenarmor/ges-audit-engine`](https://www.npmjs.com/package/@greenarmor/ges-audit-engine) — Source code audit findings
|
|
56
|
+
- [`@greenarmor/ges-compliance-engine`](https://www.npmjs.com/package/@greenarmor/ges-compliance-engine) — Control evaluation
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@greenarmor/ges-report-generator",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "GESF Report Generator - Markdown/HTML/PDF compliance reports",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -12,11 +12,11 @@
|
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@greenarmor/ges-core": "0.3.
|
|
16
|
-
"@greenarmor/ges-
|
|
17
|
-
"@greenarmor/ges-
|
|
18
|
-
"@greenarmor/ges-
|
|
19
|
-
"@greenarmor/ges-
|
|
15
|
+
"@greenarmor/ges-core": "0.3.2",
|
|
16
|
+
"@greenarmor/ges-audit-engine": "0.3.2",
|
|
17
|
+
"@greenarmor/ges-policy-engine": "0.3.2",
|
|
18
|
+
"@greenarmor/ges-compliance-engine": "0.3.2",
|
|
19
|
+
"@greenarmor/ges-scoring-engine": "0.3.2"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
22
|
"typescript": "^6.0.0",
|