Skip to content

docs(components): update documentation on components #10865

docs(components): update documentation on components

docs(components): update documentation on components #10865

GitHub Actions / IT Tests report-windows-latest-yarn succeeded Aug 29, 2024 in 0s

53 passed, 0 failed and 2 skipped

Tests passed successfully

Report Passed Failed Skipped Time
@ama-sdk/create/dist-test/it-report.xml 7✅ 455s
@ama-sdk/schematics/dist-test/it-report.xml 6ms
@o3r/analytics/dist-test/it-report.xml 2✅ 251s
@o3r/apis-manager/dist-test/it-report.xml 1✅ 140s
@o3r/application/dist-test/it-report.xml 1✅ 98s
@o3r/components/dist-test/it-report.xml 6✅ 534s
@o3r/configuration/dist-test/it-report.xml 2✅ 266s
@o3r/core/dist-test/it-report.xml 1✅ 1632s
@o3r/create/dist-test/it-report.xml 3✅ 583s
@o3r/design/dist-test/it-report.xml 1✅ 157s
@o3r/eslint-config-otter/dist-test/it-report.xml 2✅ 732s
@o3r/extractors/dist-test/it-report.xml 3✅ 769s
@o3r/localization/dist-test/it-report.xml 6✅ 1305s
@o3r/new-version/dist-test/it-report.xml 1✅ 101s
@o3r/rules-engine/dist-test/it-report.xml 2✅ 285s
@o3r/stylelint-plugin/dist-test/it-report.xml 2✅ 242s
@o3r/styling/dist-test/it-report.xml 6✅ 750s
@o3r/testing/dist-test/it-report.xml 2✅ 2⚪ 238s
@o3r/third-party/dist-test/it-report.xml 1✅ 131s
@o3r/workspace/dist-test/it-report.xml 4✅ 614s

✅ @ama-sdk/create/dist-test/it-report.xml

7 tests were completed in 455s with 7 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
Create new sdk command 7✅ 444s

✅ Create new sdk command

Create new sdk command should generate a light SDK when the specification is provided
  ✅ Create new sdk command should generate a light SDK when the specification is provided
Create new sdk command should generate a full SDK when the specification is provided
  ✅ Create new sdk command should generate a full SDK when the specification is provided
Create new sdk command should generate a full SDK when the specification is provided as npm dependency
  ✅ Create new sdk command should generate a full SDK when the specification is provided as npm dependency
Create new sdk command should generate an SDK with no package scope
  ✅ Create new sdk command should generate an SDK with no package scope
Create new sdk command should generate an empty SDK ready to be used
  ✅ Create new sdk command should generate an empty SDK ready to be used
Create new sdk command should fail when there is an error
  ✅ Create new sdk command should fail when there is an error
Create new sdk command should use pinned versions when --exact-o3r-version is used
  ✅ Create new sdk command should use pinned versions when --exact-o3r-version is used

✅ @ama-sdk/schematics/dist-test/it-report.xml

No tests found

✅ @o3r/analytics/dist-test/it-report.xml

2 tests were completed in 251s with 2 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
ng add analytics 2✅ 237s

✅ ng add analytics

ng add analytics should add analytics to an application
  ✅ ng add analytics should add analytics to an application
ng add analytics should add analytics to a library
  ✅ ng add analytics should add analytics to a library

✅ @o3r/apis-manager/dist-test/it-report.xml

1 tests were completed in 140s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new otter application with apis-manager 1✅ 128s

✅ new otter application with apis-manager

new otter application with apis-manager should add apis-manager to existing application
  ✅ new otter application with apis-manager should add apis-manager to existing application

✅ @o3r/application/dist-test/it-report.xml

1 tests were completed in 98s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new Angular application 1✅ 84s

✅ new Angular application

new Angular application should add Otter Application to existing Angular app
  ✅ new Angular application should add Otter Application to existing Angular app

✅ @o3r/components/dist-test/it-report.xml

6 tests were completed in 534s with 6 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
check metadata migration 4✅ 515s
ng add components 2✅ 288s

✅ check metadata migration

check metadata migration should not throw
  ✅ check metadata migration should not throw
check metadata migration should throw because no migration data
  ✅ check metadata migration should throw because no migration data
check metadata migration should throw because migration data invalid
  ✅ check metadata migration should throw because migration data invalid
check metadata migration should throw because breaking changes are not allowed
  ✅ check metadata migration should throw because breaking changes are not allowed

✅ ng add components

ng add components should add components to an application
  ✅ ng add components should add components to an application
ng add components should add components to a library
  ✅ ng add components should add components to a library

✅ @o3r/configuration/dist-test/it-report.xml

2 tests were completed in 266s with 2 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new otter application with configuration 2✅ 250s

✅ new otter application with configuration

new otter application with configuration should add configuration to an application
  ✅ new otter application with configuration should add configuration to an application
new otter application with configuration should add configuration to a library
  ✅ new otter application with configuration should add configuration to a library

✅ @o3r/core/dist-test/it-report.xml

1 tests were completed in 1632s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new otter application 1✅ 1607s

✅ new otter application

new otter application should build empty app
  ✅ new otter application should build empty app

✅ @o3r/create/dist-test/it-report.xml

3 tests were completed in 583s with 3 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
Create new otter project command 3✅ 572s

✅ Create new otter project command

Create new otter project command should generate a project with an application
  ✅ Create new otter project command should generate a project with an application
Create new otter project command should generate a project with a library
  ✅ Create new otter project command should generate a project with a library
Create new otter project command should generate a project with an application with --exact-o3r-version
  ✅ Create new otter project command should generate a project with an application with --exact-o3r-version

✅ @o3r/design/dist-test/it-report.xml

1 tests were completed in 157s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new otter application with Design 1✅ 139s

✅ new otter application with Design

new otter application with Design should add design to existing application
  ✅ new otter application with Design should add design to existing application

✅ @o3r/eslint-config-otter/dist-test/it-report.xml

2 tests were completed in 732s with 2 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
ng add eslint-config 2✅ 713s

✅ ng add eslint-config

ng add eslint-config should add eslint-config to an application
  ✅ ng add eslint-config should add eslint-config to an application
ng add eslint-config should add eslint-config to a library
  ✅ ng add eslint-config should add eslint-config to a library

✅ @o3r/extractors/dist-test/it-report.xml

3 tests were completed in 769s with 3 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
aggregate migration scripts 1✅ 616s
ng add extractors 2✅ 744s

✅ aggregate migration scripts

aggregate migration scripts should create migration scripts including lib content
  ✅ aggregate migration scripts should create migration scripts including lib content

✅ ng add extractors

ng add extractors should add extractors to an application
  ✅ ng add extractors should add extractors to an application
ng add extractors should add extractors to a library
  ✅ ng add extractors should add extractors to a library

✅ @o3r/localization/dist-test/it-report.xml

6 tests were completed in 1305s with 6 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
check metadata migration 4✅ 1277s
ng add otter localization 2✅ 818s

✅ check metadata migration

check metadata migration should not throw
  ✅ check metadata migration should not throw
check metadata migration should throw because no migration data
  ✅ check metadata migration should throw because no migration data
check metadata migration should throw because migration data invalid
  ✅ check metadata migration should throw because migration data invalid
check metadata migration should throw because breaking changes are not allowed
  ✅ check metadata migration should throw because breaking changes are not allowed

✅ ng add otter localization

ng add otter localization should add localization to an application
  ✅ ng add otter localization should add localization to an application
ng add otter localization should add localization to a library
  ✅ ng add otter localization should add localization to a library

✅ @o3r/new-version/dist-test/it-report.xml

1 tests were completed in 101s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
undefined 1✅ 89s

✅ undefined

 should add Otter Application to existing Angular app
  ✅ should add Otter Application to existing Angular app

✅ @o3r/rules-engine/dist-test/it-report.xml

2 tests were completed in 285s with 2 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
ng add rules-engine 2✅ 271s

✅ ng add rules-engine

ng add rules-engine should add rules engine to an application
  ✅ ng add rules-engine should add rules engine to an application
ng add rules-engine should add rules engine to a library
  ✅ ng add rules-engine should add rules engine to a library

✅ @o3r/stylelint-plugin/dist-test/it-report.xml

2 tests were completed in 242s with 2 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
ng add stylelint-plugin 2✅ 229s

✅ ng add stylelint-plugin

ng add stylelint-plugin should add stylelint-plugin to an application
  ✅ ng add stylelint-plugin should add stylelint-plugin to an application
ng add stylelint-plugin should add stylelint-plugin to a library
  ✅ ng add stylelint-plugin should add stylelint-plugin to a library

✅ @o3r/styling/dist-test/it-report.xml

6 tests were completed in 750s with 6 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
check metadata migration 4✅ 730s
ng add styling 2✅ 353s

✅ check metadata migration

check metadata migration should not throw
  ✅ check metadata migration should not throw
check metadata migration should throw because no migration data
  ✅ check metadata migration should throw because no migration data
check metadata migration should throw because migration data invalid
  ✅ check metadata migration should throw because migration data invalid
check metadata migration should throw because breaking changes are not allowed
  ✅ check metadata migration should throw because breaking changes are not allowed

✅ ng add styling

ng add styling should add styling to an application
  ✅ ng add styling should add styling to an application
ng add styling should add styling to a library
  ✅ ng add styling should add styling to a library

✅ @o3r/testing/dist-test/it-report.xml

4 tests were completed in 238s with 2 passed, 0 failed and 2 skipped.

Test suite Passed Failed Skipped Time
ng add testing 2✅ 2⚪ 223s

✅ ng add testing

ng add testing should add testing to an application
  ✅ ng add testing should add testing to an application
ng add testing should add testing to an application and fixture to component
  ✅ ng add testing should add testing to an application and fixture to component
ng add testing should add testing to a library
  ⚪ ng add testing should add testing to a library
ng add testing should add testing to a library and fixture to component
  ⚪ ng add testing should add testing to a library and fixture to component

✅ @o3r/third-party/dist-test/it-report.xml

1 tests were completed in 131s with 1 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new Angular application 1✅ 117s

✅ new Angular application

new Angular application should add Otter Third Party to existing Angular app
  ✅ new Angular application should add Otter Third Party to existing Angular app

✅ @o3r/workspace/dist-test/it-report.xml

4 tests were completed in 614s with 4 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
new otter workspace 4✅ 598s

✅ new otter workspace

new otter workspace should add sdk to an existing workspace
  ✅ new otter workspace should add sdk to an existing workspace
new otter workspace should add sdk to an existing workspace with spec package name
  ✅ new otter workspace should add sdk to an existing workspace with spec package name
new otter workspace should add a library to an existing workspace
  ✅ new otter workspace should add a library to an existing workspace
new otter workspace should generate a monorepo setup
  ✅ new otter workspace should generate a monorepo setup