维加- stencil
目录
概览
此软件包主要用于创建自定义的网络组件 stencil.js (英语)。 。 。 .
先决条件
代码插件
vega-stencil 正在使用 eslint( 配置 : .eslintrc.js)与更美(配置: .prettierrc.js) (中文(简体) ).
请在您的 IDE 中确保两个工具都设置妥当 .
[可选 配置新设计符牌
设计令牌最初存放于 ../vega-design 软件包 它也负责生成其他客户端使用的相应 CSS/JS 文件,包括 vega-stencil。 。 。 .
因此,如果想要测试一些设计符号的更改并把它们整合到vega-stencil中,就需要重新运行 CSS/JS 文件的消耗命令 vega-design 改为 vega-stencil数字 :
> npm run consume-design-token
开始
安装节点依赖
> npm install
除错/ 开发
生成新的速率组件
> npm run generate <element_tag>
启动本地服务器以预览您的变更
> npm run start
# or
> npm run debug # no cache
测试
目前,viga-stencil有两个测试环境:
- 单位测试环境 :
- 在这个洞中,我们将运行 vega 组件/ 非组件逻辑(例如.
vega-badge.spec.tsx) (中文(简体) ). - 在这个洞穴里,运行期间不会有任何实际的 HTML 元素,它们都会以
MockHTMLElement
- 在这个洞中,我们将运行 vega 组件/ 非组件逻辑(例如.
- E2E测试管 :
- 这个env是使用精确的浏览器运行时间(Chrimium)来运行测试,这意味着所有的UI/UX应该和真实的一样.
- 我们在这个洞里进行的测试是:
- Vega组件类的E2E测试(如.
vega-badge.e2e.ts(中文(简体) ) - E2E测试,用于视觉回归检查(例如.
vaga-date-picker.visual.e2e.ts(中文(简体) ) - E2E 标准无障碍测试
'wcag2a', 'wcag2aa','wcag21a', 'wcag21aa'(例如:.vega-date-picker.ada.e2e.ts(中文(简体) )
- Vega组件类的E2E测试(如.
要运行的命令 <1> 和 <2> 实值
> npm run test:base:coverage
# or
> npm run test:base:watch-all # this command will re-run when src files are changed
只运行视觉回归测试的命令是
> npm run test:visual
如果你想运行一个测试套房, 请运行
> npm run test:single-suite <suite_file_name>
示例 npm run test:single-suite vega-modal.spec
如果你想在一个测试套间内运行特定测试箱,请运行
> npm run test:single-case <test_case_name_regex>
这只能用一个符合正则名称的测试。 示例 npm run test:single-case "should render proper css of modal when open modal"
如果您想要运行的是与其他测试套件中的大小写重复的, 您可以使用以下命令指定特定套件中的测试大小写 :
> npm run test:single-suite -- --testNamePattern <test_case_name_regex>
如果您需要更新组件图像, pls 在 master.json 中删除相关对象, 然后在命令下运行并执行更改 :
1. 联合国.< 3> (中文(简体) ) 2.节点脚本/视频测试-截图-处理.js
如果您想要看到本地和站点之间的相差, pls 将遵循以下步骤 :
1. 安装活服务器扩展名 2. 用 Live Server 打开屏幕截图/compare.html 3. 右上方的所有截图 4. 点击左下方的空白区域,如果立面不显示,则使用manuel来比较
如果您想要禁用 Featureflag 来测试旧逻辑的大小写 :
对于 e2e 测试以禁用特征旗 :
describe('vega-input', () => {
let page: E2EPage;
beforeEach(async () => {
page = await newE2EPage();
await page.evaluateOnNewDocument(() => {
window['VegaDisabledFeatureKeys'] = ['VEGA_FORM.FORM_FIELD_CONTROLLER_VALIDATION'];
});
});
要禁用特性旗的光谱测试 :
describe('vega-input', () => {
beforeAll(() => {
FeatureFlag.disable('VEGA_FORM.FORM_FIELD_CONTROLLER_VALIDATION');
});
说明数字 :
- 单位( spec) 测试与 e2e 测试在 stencil 中的主要差异 此处可见
- 接到通知后,就进行单位测试
stencil实值 完全一样 运行它与jest直接的CLI(特别是针对非组件测试套件),这是因为stencil通过使用自己的测试运行时组件来嘲弄大多数html元素,因此我们建议避免使用jest在Github输油管运行时可能会看到不同的测试结果.
- 在Vega中,我们倾向于将测试案例放在spec/unit测试中,而不是e2e测试,除非他们无法在非浏览器env中进行测试(例如模拟用户模糊/聚焦事件,窗口大小调整),主要原因是stencil不支持运行测试覆盖在e2e测试案例之上,因此我们无法轻易地告诉e2e测试恰当覆盖了内部组件.
- 假设您必须使用 e2e 测试来覆盖代码分支, 请使用 istanbul/ ignoring- 编码覆盖 财务报告和审定财务报表 就e2e测试中如何涵盖这一分支的问题提出补充意见 以跳过密码进行覆盖检查。 例如:
- 内
vega-stencil/src/components/vega-carousel/vega-carousel.tsx// ... /** * The below method is e2e-test covered in * @see{module:vega-carousel-e2e-render} */ /* istanbul ignore next */ @Watch('perPage') onPerPagePropsChange(): void { this.resizeWindowHelper(); this.applySpacingHelper(); } // ... - 和 jsdoc 模块
module:vega-carousel-e2e-render定义于vega-stencil/src/components/vega-carousel/test/vega-carousel.e2e.tsdescribe('vega-carousel', () => { /** @module vega-carousel-e2e-render */ it('renders', async () => { const page: E2EPage = await newE2EPage(); await page.setContent('<vega-carousel></vega-carousel>'); const element: E2EElement = await page.find('vega-carousel'); expect(element).toHaveClass('hydrated'); }); });
- 内
提高承诺
运行时确保您通过必要的预承诺检查
> npm run pre-release
一旦以上命令成功,运行此命令来建造用于释放的文物
> npm run release
解决问题
1. E2E 测试因未加载的 css而失败
这是因为你工作空间里现在的平板建筑是分道扬镳的,你需要通过跑来重建文物 yarn run release。 。 。 .