sindresorhus/eslint-plugin-unicorn

Re-enable `prefer-json-parse-buffer`

Open

#2 565 ouverte le 19 févr. 2025

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)JavaScript (5 022 stars) (468 forks)user submission
change requesthelp wanted

Description

Description

This rule actually makes sense to JavaScript users, but it's disabled due to compatibility with TypeScript, how about rename to consistent-json-file-read, and default to read as string, but add option to allow read it as buffer?

Examples

// ❌
JOSN.parse(await fs.readFile('/path/to/file.json'));

// ✅
JOSN.parse(await fs.readFile('/path/to/file.json', 'utf8'));

// ❌
// eslint unicorn/consistent-json-file-read: ["error", "buffer"]
JOSN.parse(await fs.readFile('/path/to/file.json', 'utf8'));

// ✅
// eslint unicorn/consistent-json-file-read: ["error", "buffer"]
JOSN.parse(await fs.readFile('/path/to/file.json'));

Additional Info

We may want check other cases in the future, since there are more way to read a JSON file now.

createRequire(import.meta.url)('/path/to/file.json');

await import('./path/to/file.json', {with:{type:'json'}});

Guide contributeur

Stack technique
javascriptnodejs
Domaine
tooling
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-2 days
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
ESLint plugin developmentNode.js file I/OJSON parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
Implement a new ESLint rule 'consistent json file read' that enforces reading JSON files with explicit encoding. The rule should default to 'string' but allow 'buffer' option. Consider checking for dynamic imports and require() calls as shown in the issue. Refer to existing rule 'prefer json parse buffer' for guidance. The implementation should be in the rules directory and include tests.