sindresorhus/eslint-plugin-unicorn

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

Open

#2,565 opened on Feb 19, 2025

View on 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'}});

Contributor guide

Tech stack
javascriptnodejs
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ESLint plugin developmentNode.js file I/OJSON parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.
Re-enable `prefer-json-parse-buffer` · sindresorhus/eslint-plugin-unicorn#2565 | Good First Issue