sindresorhus/eslint-plugin-unicorn

no-empty-file should be configurable

Open

#2,218 创建于 2023年11月8日

在 GitHub 查看
 (5 评论) (1 反应) (0 负责人)JavaScript (5,022 star) (468 fork)user submission
enhancementgood for beginnerhelp wanted

描述

no-empty-file isn't configurable

A file with comments but without code is considered empty. More finesse would be appreciated.

Example: I would like to disallow empty files in general, but I would like to allow *.test.ts(x) files to contain only comments

Use case:

// File: useScreenSizeHint.test.ts
// No need to write tests here, useScreenSizeHint.ts source code is already tested by ScreenSizeHintProvider.test.tsx

ESLint configuration:

rules: {
  'unicorn/no-empty-file': 'error'
},
overrides: [
  {
    files: ['**/*.test.ts', '**/*.test.tsx'],
    rules: {
      // Empty test files with comments are legit
      'unicorn/no-empty-file': ['error', { allow: ['comments'] }]
    },
  }
]

贡献者指南

技术栈
javascriptnodejs
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
knowledge of ESLint rule configurationfamiliarity with the plugin structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
The issue requests adding a configuration option to the `no empty file` rule to allow files that contain only comments. The implementation likely involves modifying the rule logic in `rules/no empty file.js` to accept an `allow` option (e.g., `['comments']`), updating the schema in the rule's JSON, and adding tests. The contributor should check the ESLint rule documentation and existing examples in the repository, such as `rules/no abbreviation.js` or other configurable rules, to understand the pattern. After implementing, they need to update `docs/rules/no empty file.md` and verify with the test suite.