ProjectEvergreen/greenwood

refactor project to use JSON Modules

Open

#1,015 opened on Dec 2, 2022

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)JavaScript (15 forks)auto 404
CLIPluginsenhancementgood first issue

Repository metrics

Stars
 (132 stars)
PR merge metrics
 (PR metrics pending)

Description

After the upgrade to #1014 for Node v18 support, we can now refactor all instances of reading a JSON file to use native JSON modules, using import assertions

// before
const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
const greenwoodPackageJson = JSON.parse(await fs.promises.readFile(new URL('../package.json', import.meta.url), 'utf-8'))

// after
import packageConfig from './package.json' assert { type: 'json' };

So goal would be to go and replace all those instances to the new version.

This will also require us updating our ESLint version to include support for import assertions, which we might still need to wait for? https://github.com/eslint/eslint/discussions/15305

Or maybe we can get around it with a plugin?

Contributor guide

Research direction
Search for all instances of reading JSON files via fs.readFileSync or fs.promises.readFile with JSON.parse, and replace them with import assertions. Additionally, update the ESLint configuration to support import assertion syntax, possibly by using an ESLint plugin.
Tech stack
javascriptnodejs
Domain
tooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptES ModulesESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60