ProjectEvergreen/greenwood

refactor project to use JSON Modules

Aberta

#1.015 aberto em 2 de dez. de 2022

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)JavaScript (15 forks)auto 404
CLIPluginsenhancementgood first issue

Métricas do repositório

Stars
 (132 estrelas)
Métricas de merge de PR
 (Mesclagem média 25d 20h) (29 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
Procure todas as instâncias de leitura de arquivos JSON via fs.readFileSync ou fs.promises.readFile com JSON.parse e substitua as por import assertions. Além disso, atualize a configuração do ESLint para suportar a sintaxe de import assertion, possivelmente usando um plugin ESLint.
Pilha de tecnologia
javascriptnodejs
Domain
tooling
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptES ModulesESLint
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60