sindresorhus/eslint-plugin-unicorn

no-empty-file should be configurable

Open

#2 218 ouverte le 8 nov. 2023

Voir sur GitHub
 (5 commentaires) (1 réaction) (0 assignés)JavaScript (5 022 stars) (468 forks)user submission
enhancementgood for beginnerhelp wanted

Description

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'] }]
    },
  }
]

Guide contributeur

Stack technique
javascriptnodejs
Domaine
toolingdeveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
knowledge of ESLint rule configurationfamiliarity with the plugin structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.