elastic/kibana

Cases plugin needs to export some more types publically

Open

#99,547 创建于 2021年5月6日

在 GitHub 查看
 (7 评论) (0 反应) (0 负责人)TypeScript (19,065 star) (8,021 fork)batch import
Feature:CasesTeam:Casesgood first issuetechnical debt

描述

Run node scripts/build_api_docs --stats exports --plugin cases to see the list:

 7 referenced API items not exported
┌─────────┬───────────────────────────────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ (index) │            Not exported source            │                                                    references                                                    │
├─────────┼───────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│    0    │       'cases-public-AllCasesProps'        │              'cases-def-public.CasesUiStart.getAllCases, cases-def-public.CasesUiStart.getAllCases'              │
│    1    │ 'cases-public-AllCasesSelectorModalProps' │ 'cases-def-public.CasesUiStart.getAllCasesSelectorModal, cases-def-public.CasesUiStart.getAllCasesSelectorModal' │
│    2    │       'cases-public-CaseViewProps'        │              'cases-def-public.CasesUiStart.getCaseView, cases-def-public.CasesUiStart.getCaseView'              │
│    3    │    'cases-public-ConfigureCasesProps'     │        'cases-def-public.CasesUiStart.getConfigureCases, cases-def-public.CasesUiStart.getConfigureCases'        │
│    4    │      'cases-public-CreateCaseProps'       │            'cases-def-public.CasesUiStart.getCreateCase, cases-def-public.CasesUiStart.getCreateCase'            │
│    5    │      'cases-public-RecentCasesProps'      │           'cases-def-public.CasesUiStart.getRecentCases, cases-def-public.CasesUiStart.getRecentCases'           │
│    6    │        'cases-server-CasesClient'         │                               'cases-def-server.CaseRequestContext.getCasesClient'                               │

Without exporting these types publically they won't show up in our API documentation:

贡献者指南

技术栈
typescript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic TypeScript knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
Find the source files for the listed types in the cases plugin (likely under x pack/plugins/cases/), add export keyword to each type, and ensure they are re exported from the appropriate public API files. Run the build script to verify the exports are now picked up.