Gathering detailed insights and metrics for @heartlandone/vega-sandbox-pr-1795-460ba34fec64c94a9a50bc724bfcc8328b4e5fb5
Gathering detailed insights and metrics for @heartlandone/vega-sandbox-pr-1795-460ba34fec64c94a9a50bc724bfcc8328b4e5fb5
Installations
npm install @heartlandone/vega-sandbox-pr-1795-460ba34fec64c94a9a50bc724bfcc8328b4e5fb5Developer Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.11.0
NPM Version
10.2.4
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
6
Package Meta Information
Latest Version
2.36.0
Package Id
@heartlandone/vega-sandbox-pr-1795-460ba34fec64c94a9a50bc724bfcc8328b4e5fb5@2.36.0
Unpacked Size
28.08 MB
Size
5.76 MB
File Count
3,276
NPM Version
10.2.4
Node Version
20.11.0
Published on
Mar 10, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
8
Dev Dependencies
51
@babel/core@babel/plugin-proposal-decorators@babel/preset-env@babel/preset-typescript@fortawesome/fontawesome-free@heartlandone/eslint-plugin-vega-eslint@stencil/angular-output-target@stencil/core@stencil/eslint-plugin@stencil/react-output-target@stencil/sass@stencil/vue-output-target@storybook/addon-a11y@storybook/addon-actions@storybook/addon-docs@storybook/addon-essentials@storybook/addon-links@storybook/html@storybook/react@types/jest@types/puppeteer@typescript-eslint/eslint-plugin@typescript-eslint/parserautoprefixeraxe-corebabel-jesteslinteslint-config-prettiereslint-plugin-jsdoceslint-plugin-jsx-a11yeslint-plugin-reacteslint-plugin-spellcheckeslint-plugin-unicornjestjest-clijest-junitjest-transform-stubpostcsspostcss-clipostcss-importpostcss-minifypostcss-selector-replacepostcss-urlprettierpuppeteerreact-syntax-highlighterstorybook-code-paneltailwindcssts-nodetypescriptworkbox-build
vega-stencil
Table of Contents
- Overview
- Prerequisite
- Getting started
- Debug/Development
- Testing
- If you want to run a single test suite, please run
- If you want to run the specific test case within a single test suite, please run
- If you would like to run is duplicate with the cases in other test suite, you can use the below command to specify the test case in a specific suite:
- If you want to disable Featureflag to test cases with old logic
- Raising a commit
- Troubleshooting
Overview
This package is mainly for creating custom web components built with stencil.js.
Prerequisite
Code linter
vega-stencil is using eslint (config: .eslintrc.js) along with prettier (config: .prettierrc.js).
Make sure both tools have been set up properly in your IDE.
[Optional] Consume new design token
design token was originally stored at ../vega-design package which is also responsible for generating corresponding CSS/JS file used by other clients including vega-stencil.
Hence, if you want to test some change of design token and want to integrate them into vega-stencil, you need to re-run the consume command to fetch the CSS/JS files from vega-design to vega-stencil:
1> npm run consume-design-token
Getting started
Install node dependencies
1> npm install
Debug/Development
To generate a new stencil component
1> npm run generate <element_tag>
Start local server to host preview your change for stencil components
1> npm run start 2# or 3> npm run debug # no cache
To view the change in storybook
1> npm run storybook
Testing
Currently, vega-stencil has two testing environments:
- Unit test env:
- In this env, we will run unit test for vega components / non-component logic (e.g.
vega-badge.spec.tsx). - In this env, there won't be any actual HTML element during runtime and all of them will show up as
MockHTMLElement
- In this env, we will run unit test for vega components / non-component logic (e.g.
- E2E test env:
- This env is using the exact browser runtime (Chromium) to run the test, which means all the UI/UX should be the same as the real one.
- The tests we are running in this env are:
- E2E test for vega component classes (e.g.
vega-badge.e2e.ts) - E2E test for visual regression checking (e.g.
vaga-date-picker.visual.e2e.ts) - E2E test for accessibility checking with standard
'wcag2a', 'wcag2aa','wcag21a', 'wcag21aa'(e.g.vega-date-picker.ada.e2e.ts)
- E2E test for vega component classes (e.g.
The command to run both <1> and <2> is
1> npm run test:base:coverage 2# or 3> npm run test:base:watch-all # this command will re-run when src files are changed
The command to run visual regression test only is
1> npm run test:visual
If you want to run a single test suite, please run
1> npm run test:single-suite <suite_file_name>
Example: npm run test:single-suite vega-modal.spec
If you want to run the specific test case within a single test suite, please run
1> npm run test:single-case <test_case_name_regex>
Which will run only tests with a name that matches the regex. Example: npm run test:single-case "should render proper css of modal when open modal"
If you would like to run is duplicate with the cases in other test suite, you can use the below command to specify the test case in a specific suite:
1> npm run test:single-suite -- --testNamePattern <test_case_name_regex>
If you need to update component images,pls delete the related object in master.json,then run below command and commit the changes:
1.<3> 2.node scripts/visual-test-screenshot-handle.js
If you want to see the difference pic between local and stand,pls follow below step:
1.install Live Server extension 2.open screenshot/compare.html by open with Live Server 3.choose All Screenshots on right top 4.click blank area under left side if the stand pic not show ,and manuel compare it
If you want to disable Featureflag to test cases with old logic:
For e2e test to disable a featureflag:
describe('vega-input', () => {
let page: E2EPage;
beforeEach(async () => {
page = await newE2EPage();
await page.evaluateOnNewDocument(() => {
window['VegaDisabledFeatureKeys'] = ['VEGA_FORM.FORM_FIELD_CONTROLLER_VALIDATION'];
});
});
For spec test to disable a featureflag:
describe('vega-input', () => {
beforeAll(() => {
FeatureFlag.disable('VEGA_FORM.FORM_FIELD_CONTROLLER_VALIDATION');
});
Note:
- The main difference between unit(spec) test vs e2e test in stencil can be found here
- Once notice here is, unit test running in
stencilis not behave the exact same as running it withjestCLI directly (especially for non-component test suite), this is because stencil is mocking most of the html element by using its own test runtime component, hence we would suggest avoiding usingjestCLI directly to run unit tests as you might see different testing result when run it in Github pipeline.
- In vega, we prefer to put test case into spec/unit test over e2e test unless they are not able to test in non-browser env (e.g. simulate user blur/focus event, window resize), the main reason is stencil doesn't support to run test coverage over e2e test case, hence we cannot easily tell the branch inside component is covered properly by e2e test.
- In the scenario that you have to use e2e test to cover code branch, please use istanbul/ignoring-code-for-coverage and put additional comment regarding how this branch is covered in e2e test to skip the code for coverage checking. For example:
- in
vega-stencil/src/components/vega-carousel/vega-carousel.tsx1// ... 2 3/** 4* The below method is e2e-test covered in 5* @see{module:vega-carousel-e2e-render} 6*/ 7/* istanbul ignore next */ 8@Watch('perPage') 9onPerPagePropsChange(): void { 10 this.resizeWindowHelper(); 11 this.applySpacingHelper(); 12} 13 14// ... - and the jsdoc module
module:vega-carousel-e2e-renderis defined invega-stencil/src/components/vega-carousel/test/vega-carousel.e2e.ts1describe('vega-carousel', () => { 2 /** @module vega-carousel-e2e-render */ 3 it('renders', async () => { 4 const page: E2EPage = await newE2EPage(); 5 await page.setContent('<vega-carousel></vega-carousel>'); 6 const element: E2EElement = await page.find('vega-carousel'); 7 expect(element).toHaveClass('hydrated'); 8 }); 9});
- in
Raising a commit
Make sure you have passed the necessary pre commit check by running
1> npm run pre-release
Once the above command succeeded, run this command to build the artifacts for releasing
1> npm run release
Troubleshooting
1. E2E Testing Failure due to the css not loaded
This is because the current stencil build in your workspace is staled and you need to re-build the artifacts by running yarn run release.
No vulnerabilities found.
No security vulnerabilities found.