sindresorhus/eslint-plugin-unicorn

no-empty-file should be configurable

Open

#2,218 opened on 2023年11月8日

GitHub で見る
 (5 comments) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.