sindresorhus/eslint-plugin-unicorn

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

Open

#2.565 aberto em 19 de fev. de 2025

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)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'}});

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
tooling
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
ESLint plugin developmentNode.js file I/OJSON parsing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.