Add CI / Coverage badges. Add html tests report. Document IValidation…

…Rule
howerest · Apr 3, 2023 · 294fff8 · 294fff8
1 parent df84951
commit 294fff8
Show file tree

Hide file tree

Showing 34 changed files with 1,739 additions and 199 deletions.
diff --git a/.github/workflows/node.js.yml → .github/workflows/main.yml b/.github/workflows/node.js.yml → .github/workflows/main.yml
@@ -1,4 +1,7 @@
-name: Node.js CI
+name: ci
+
+permissions:
+  contents: write
 
 on:
   push:
@@ -8,9 +11,7 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
         node-version: [16.x, 18.x]
@@ -22,4 +23,6 @@ jobs:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
     - run: yarn install
-    - run: yarn test
+    - run: TERM=xterm-color yarn build
+    - run: TERM=xterm-color yarn test
+    - run: TERM=xterm-color yarn document
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## sdkzer ##
 
-<img src="https://raw.githubusercontent.com/howerest/sdkzer/master/dist/build_pass.png"  alt="build pass" />
+[<img src="https://github.com/howerest/sdkzer/workflows/ci/badge.svg"  alt="Continuous Integration" />](https://htmlpreview.github.io/?https://github.com/howerest/sdkzer/blob/master/dist/tests_report.html) ![Coverage](./dist/coverage/badges.svg)
 
 [http://howerest.com/labs/sdkzer](http://howerest.com/labs/sdkzer)
 

diff --git a/dist/build_pass.png b/dist/build_pass.png
diff --git a/dist/doc/assets/search.js b/dist/doc/assets/search.js
diff --git a/dist/doc/classes/AllowedValueSwitchValidator.html b/dist/doc/classes/AllowedValueSwitchValidator.html
@@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AllowedValueSwitchValidator</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rules/allowed_value_switch_validator.ts#L10">validation_rules/allowed_value_switch_validator.ts:10</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rules/allowed_value_switch_validator.ts#L10">validation_rules/allowed_value_switch_validator.ts:10</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -63,33 +63,33 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> params: <span class="t
 <h4 class="tsd-returns-title">Returns <a href="AllowedValueSwitchValidator.html" class="tsd-signature-type" data-tsd-kind="Class">AllowedValueSwitchValidator</a></h4><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#constructor">constructor</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L19">validation_rule.ts:19</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L19">validation_rule.ts:19</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="conditions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>conditions</span><a href="#conditions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">conditions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <p>Overrides <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#conditions">conditions</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rules/allowed_value_switch_validator.ts#L20">validation_rules/allowed_value_switch_validator.ts:20</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rules/allowed_value_switch_validator.ts#L20">validation_rules/allowed_value_switch_validator.ts:20</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fromValue" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>from<wbr/>Value</span><a href="#fromValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">from<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#fromValue">fromValue</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L14">validation_rule.ts:14</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L14">validation_rule.ts:14</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="params" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>params</span><a href="#params" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">params<span class="tsd-signature-symbol">:</span> <a href="../interfaces/IAllowedValueSwitchValidatorParams.html" class="tsd-signature-type" data-tsd-kind="Interface">IAllowedValueSwitchValidatorParams</a></div><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#params">params</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L16">validation_rule.ts:16</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L16">validation_rule.ts:16</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="toValue" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>to<wbr/>Value</span><a href="#toValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">to<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#toValue">toValue</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L15">validation_rule.ts:15</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L15">validation_rule.ts:15</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Accessors</h2>
 <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a id="invalidMessage" class="tsd-anchor"></a>
@@ -102,7 +102,7 @@ <h3 class="tsd-anchor-link"><span>invalid<wbr/>Message</span><a href="#invalidMe
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <p>Inherited from ValidationRule.invalidMessage</p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L27">validation_rule.ts:27</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L27">validation_rule.ts:27</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addInvalidMessage" class="tsd-anchor"></a>
@@ -120,7 +120,7 @@ <h5>message: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#addInvalidMessage">addInvalidMessage</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L52">validation_rule.ts:52</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L52">validation_rule.ts:52</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isValid" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isValid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
@@ -138,7 +138,7 @@ <h5>toValue: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <p>Inherited from <a href="ValidationRule.html">ValidationRule</a>.<a href="ValidationRule.html#isValid">isValid</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/73870bd/src/validation_rule.ts#L34">validation_rule.ts:34</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/howerest/sdkzer/blob/df84951/src/validation_rule.ts#L34">validation_rule.ts:34</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">