代码覆盖率不适用于 WebStorm 中的某些文件

Question

我想为下面的目标代码编写一个UT：

// dev code
import React, { useState } from 'react'
import { Dropdown } from 'antd'

import './style.scss'
import classnames from 'classnames'
import Menu from '@lib/Menu'

const DEFAULT_TRIGGER_MODE = 'contextMenu'

interface ContextMenuProps {
  wrapClass?: string
  menu?: { key: string; title: string }[]
  children?: object
  updateMenu?: (event) => { key: string; title: string }[]
  visible?: boolean
  triggerMode?: ('click' | 'hover' | 'contextMenu')[]
}

const updateMenuData =(eventObj, updateMenu, setMenu) => {
  if (updateMenu) {
    const newMenu = updateMenu(eventObj)
    setMenu(newMenu)
  }
}

const populateMenuNodes = (menuData) => {
  if (menuData.length === 0) return <></>

  return (
    <Menu>
      {menuData.map(({ key, title, onClick, disabled }, index) => (
        key === 'menu.divider' ? <Menu.Divider key={key} /> : <Menu.Item key={key} onClick={onClick} disabled={disabled}>{title}</Menu.Item>
      ))}
    </Menu>
  )
}

const ContextMenu: React.FC<ContextMenuProps> = (props) => {
  const [menu, setMenu] = useState(props.menu || [])
  const { children, updateMenu, wrapClass, triggerMode = [DEFAULT_TRIGGER_MODE], ...rest } = props
  return (
    <div
      className={classnames('mstr-as-context-menu', wrapClass)}
      onContextMenu={(e) => {
        updateMenuData(e, updateMenu, setMenu)
      }}
    >
      <Dropdown overlay={populateMenuNodes(menu)} trigger={triggerMode} {...rest}>
        {children}
      </Dropdown>
    </div>
  )
}

export default ContextMenu

我为上面的目标代码写了一个UT：

import React from 'react'
import {  shallow } from 'enzyme'
import ContextMenu from '../index'

jest.mock('react', () => ({
    ...jest.requireActual('react'),
    useState: jest.fn((menu) => [menu || []]),
}))

describe('ContextMenu/index.js', () => {
    let component
    let props
    beforeEach(() => {
        props = {
            children: <div>Children</div>,
        }
    })

    describe('Check rendered component: ', () => {
        it('should render a component successfully', () => {
            component = shallow(<ContextMenu {...props}/>)
        })
        it('should show Menu.Item', () => {
            props = {
                ...props,
                 menu: [{key: '', title: 'title1'}]
            }
            component = shallow(<ContextMenu {...props}/>)
        });
        it('should show Menu.Divider', () => {
            props = {
                ...props,
                menu: [{key: 'menu.divider', title: 'title1'}]
            }
            component = shallow(<ContextMenu {...props}/>)
        });
        afterEach(() => {
            expect(component).toMatchSnapshot()
        })
    })
})

我成功运行了测试。

但是，我无法使用下面的 WebStorm 代码覆盖率功能获取目标代码的覆盖率数据。

从下面的截图来看，WebStorm 似乎没有计算目标代码的代码覆盖率，而它计算其他文件的代码覆盖率。

Answer 1

我是提出问题的人。

调查

我在终端中运行下面的命令，发现代码覆盖率不是为相同的文件计算的。

jest --coverage

所以这不是关于 WebStorm 的特定问题。 这只是一个关于 Jest 配置的问题。

解决方案

找到 Jest 配置文件：jest.config.js

module.exports = {
  verbose: true,
  testMatch: ['<rootDir>src/**/*\\.test\\.(ts|tsx|js|jsx)'],
  globals: { __DEV__: true },
  modulePaths: ['./src'],
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'md'],
  moduleNameMapper: {
    '\\.(css|less|scss|gif)$': 'identity-obj-proxy',
    '^.+\\.(css|scss)$': '<rootDir>/node_modules/jest-css-modules',
    '\\.(css|less|scss|sass|gif)$': 'identity-obj-proxy',
    '^antd/es': 'identity-obj-proxy',
    '^@mstr/': 'identity-obj-proxy',
    '^dnd-core$': 'dnd-core/dist/cjs',
    '^react-dnd$': 'react-dnd/dist/cjs',
    '^react-dnd-html5-backend$': 'react-dnd-html5-backend/dist/cjs',
    '^react-dnd-touch-backend$': 'react-dnd-touch-backend/dist/cjs',
    '^react-dnd-test-backend$': 'react-dnd-test-backend/dist/cjs',
    '^react-dnd-test-utils$': 'react-dnd-test-utils/dist/cjs',
    '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': 'identity-obj-proxy',
  },
  testResultsProcessor: './scripts/jest-results-processor.js',
  coverageReporters: ['lcov', 'text', 'json-summary', 'cobertura'],
  setupFiles: ["jest-canvas-mock"],
  setupFilesAfterEnv: ['./jest.setup.js'],
  collectCoverageFrom: [
    'src/**/*.{js,jsx,ts,tsx}',
    '!src/assets/**/*.{js,jsx,json,ts,tsx}',
    '!src/lib/!(Canvas)/**/*.{js,jsx,json,ts,tsx}',
    '!**/node_modules/**',
    '!**/vendor/**',
    '!**/env/**',
  ],
  testPathIgnorePatterns: ['<rootDir>/src/components/xx/__tests__/data'],
  snapshotSerializers: ['enzyme-to-json/serializer'],
}

关键是下面的代码

'!src/lib/!(Canvas)/**/*.{js,jsx,json,ts,tsx}',

将此行更改为：

    'src/lib/**/*.{js,jsx,json,ts,tsx}',

所以会计算lib目录下所有文件的代码覆盖率，包括我正在处理的文件。