Skip to content

Commit e5b398a

Browse files
authored
revert: include tests (#272)
* revert: include-test revert back * revert: include-test
1 parent b4e1781 commit e5b398a

File tree

7 files changed

+317
-3
lines changed

7 files changed

+317
-3
lines changed

projects/docs/src/app/features/installation-page/installation-page.component.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h2>Installing an Icons Library (Optional)</h2>
8585
></doc-source-code>
8686
<h2>Update typescript import</h2>
8787
<p>
88-
In <doc-project-name [code]="true"></doc-project-name>, UI components use
88+
In <doc-project-name [code]="true"></doc-project-name>, Components use
8989
absolute paths for internal imports. It’s recommended that you follow the
9090
same approach to keep your imports clean and maintainable. Instead of using
9191
long and cumbersome relative imports like:

projects/docs/src/app/features/usage-page/usage-page.component.html

+33
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,39 @@ <h3>4. <code>project</code> (Optional)</h3>
5656
use by passing the project name. or it will try to use the default project
5757
</li>
5858
</ul>
59+
<h3>4. <code>includeTests</code> (Optional, default: <code>false</code>)</h3>
60+
<p>Specifies whether to include test files for the element.</p>
61+
<ul>
62+
<li>
63+
NgVerse elements come with a full suite of tests to help ensure
64+
reliability. However, including tests is optional for the following
65+
reasons:
66+
<ul>
67+
<li>
68+
<strong>Code changes may break tests:</strong><br />
69+
After modifying an element, tests may fail because the behavior has
70+
changed. In this case, you would need to debug and update the test
71+
files, which can take extra time and effort.
72+
</li>
73+
<li>
74+
<strong>Test framework compatibility:</strong><br />
75+
Our tests are written in Jasmine, so if you're using another framework
76+
like Jest, the tests will not run at all.<br />
77+
Therefore, tests are disabled by default.
78+
</li>
79+
</ul>
80+
</li>
81+
<li>
82+
If you want to include test files, use
83+
<code>includeTests=true</code>.<br />
84+
Example: <code>ng g ngverse:add button --includeTests=true</code>
85+
</li>
86+
</ul>
87+
<p>
88+
Keep in mind that we maintain and update our tests regularly. Tests are run
89+
on every commit, merge, and release to ensure high quality. We take testing
90+
seriously, so you don’t have to worry about test coverage! 🚀
91+
</p>
5992
<h2>Global Configuration</h2>
6093
<p>
6194
You can set a global configuration for the

0 commit comments

Comments
 (0)