@@ -22,33 +22,36 @@ for information on the latest release.
2222>
2323> This @softdist/extensions module is generic and opensource
2424
25- This is a library for reporting and scoring tools. These tools can be used for
26- virtually any purpose as a standard reporting & notifications library. The
27- project goal is to provide a variety of reporting options which can be extended
28- easily for scoring, notifications, or to generate complex reports based on the
29- inspection of Github Scopes, Azure Scopes, and other objects.
25+ This is a general library for comparison, github scopes, and reporting. These
26+ tools can be used for virtually any purpose as a standard reporting &
27+ notifications library. The project goal is to provide a variety of reporting
28+ options which can be extended easily for scoring, notifications, or to generate
29+ complex reports based on the inspection of Github Scopes, Azure Scopes, and
30+ other objects.
3031
3132## Exported Modules
3233
33- | Feature Name | Purpose |
34- | :----------- | :---------------------------------------------------------------------------------------- |
35- | ` $colors ` | Automatic error logging and warn/notice stream logging with colors |
36- | ` $const ` | Declared generic constants for local system paths and GITHUB API |
37- | ` $compare ` | Comparison functions for deep YML objects. |
38- | ` $error ` | Generic error functions for including messages with specific colors |
39- | ` $ruleset ` | Github Rulesets and Rule scopes for detecting branch protections |
40- | ` $report ` | Reporting function for scoring tabulation in streams, and notification functions in teams |
41- | ` $reporting ` | v2 of the report functionality implements a Reporting object and the concept of hooks |
42- | ` $streams ` | Optic FileStream object for logging colored error messages to evaluated streams |
43- | ` $token ` | Token acquisition for GitHub CLI default, or .envcrypt files, or environment vars |
44- | ` $webhook ` | Webhook secret acquisition IFFE functions |
34+ | Feature Name | Purpose |
35+ | :----------- | :------------------------------------------------------------------------------------- |
36+ | ` $colors ` | Automatic error logging and warn/notice stream logging with colors |
37+ | ` $const ` | Declared generic constants for local system paths and GITHUB API |
38+ | ` $compare ` | Comparison functions for deep YML objects. |
39+ | ` $error ` | Generic error functions for including messages with specific colors |
40+ | ` $file ` | File regex and comparison functions. |
41+ | ` $perms ` | Permissions scanning functions |
42+ | ` $ruleset ` | Github Rulesets and Rule scopes for detecting branch protections |
43+ | ` $report ` | Async reporting stream for tabulation of callback data into a simplified report stream |
44+ | ` $reporting ` | Reporting object and the concept of hooks and custom entry types/ exceptions. |
45+ | ` $streams ` | Optic FileStream object for logging colored error messages to evaluated streams |
46+ | ` $token ` | Token acquisition for GitHub CLI default, or .envcrypt files, or environment vars |
47+ | ` $webhook ` | Webhook secret acquisition IFFE functions |
4548
4649## Exported Variables
4750
48- | Variable | Description |
49- | :----------------- | :---------------------------------- |
50- | ` generatedVersion ` | Software Version Information |
51- | ` Type ` | Types used throughout this software |
51+ | Variable | Description |
52+ | :----------------- | :------------------------------------------------- |
53+ | ` generatedVersion ` | Software Version Information |
54+ | ` Type ` | Types and Interfaces used throughout this software |
5255
5356## Github Scopes
5457
@@ -90,7 +93,7 @@ The purpose is to abstract the reporting methods into a JSR package which can be
9093called using ` deno run ` by passing the ` --import-map ` flag and referencing a
9194JSON import map file containing this package.
9295
93- ### Reporting Custom Objects in 0.2.6
96+ ### Reporting Custom Objects in 0.2.6+
9497
9598Passing custom objects to the ` createReport ` function is now trivial.
9699
@@ -149,7 +152,7 @@ Here is an example import map for testing
149152 "@onjara/optic" : " jsr:@onjara/optic@^2.0.3" ,
150153 "@alikia/random-key" : " jsr:@alikia/random-key@^1.0.1" ,
151154 "@deno/dnt" : " jsr:@deno/dnt@^0.41.2" ,
152- "@softdist/extensions" : " jsr:@softdist/extensions@0.2.4 " ,
155+ "@softdist/extensions" : " jsr:@softdist/extensions@0.3.0 " ,
153156 "@std/assert" : " jsr:@std/assert@1.0.13" ,
154157 "@std/fmt" : " jsr:@std/fmt@^1.0.7" ,
155158 "@std/fs" : " jsr:@std/fs@^1.0.17" ,
@@ -169,15 +172,21 @@ Here is an example import map for testing
169172The following diagram explains the current logical flow of how to call and
170173utilize this package.
171174
175+ ## Logical Diagram
176+
177+ The following logical diagram is written in Mermaid and does not display on
178+ jsr.io.
179+ [ View Diagram on Github] ( https://github.com/pkgdist/extensions?tab=readme-ov-file#logical-diagram ) .
180+
172181``` mermaid
173182---
174- title: Rule Engine Binary
183+ title: Extensions
175184---
176185 graph TD;
177- external_program-->dynamic_code_execution-->import_statement-->softdist_extensions
178- softdist_extensions -->reporting-->scopes-->github
179- scopes -->azure
180- softdist_extensions -->notifications -->webhooks
186+ external_program-->dynamic_code_execution-->import_statement-->extensions
187+ extensions -->reporting-->scopes-->github
188+ extensions -->notifications-->webhooks
189+ extensions -->aggregate -->custom_types-->custom_entries-->custom_exceptions
181190```
182191
183192## About FileStream
0 commit comments