sindresorhus/update-notifier

Default `pkg` to the current package

Open

#172 aberto em 30 de nov. de 2019

Ver no GitHub
 (5 comments) (2 reactions) (0 assignees)JavaScript (1.800 stars) (164 forks)user submission
enhancementhelp wanted

Description

The pkg option must be set with the package's package.json.

However this does not work well with ES imports. At the moment, importing JSON files with ES imports is still experimental in Node.js.

Also, hardcoding the path to package.json can be tricky when transpiling is involved. For example, my binary file is at src/bin.js, but it is transpiled to build/src/bin.js. If I want to run both files, I need to dynamically find the path to package.json with a library like read-pkg-up.

Adding an option to automatically find the package (with read-pkg-up for example) would solve this problem. This option would probably need user to pass __dirname to be able to find the right package.json.

What do you think?

I can submit a PR if needed.

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
clideveloper experience
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-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Node.js basicsUnderstanding of update notifier's pkg option
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
Examine the `update notifier` source code to understand how the `pkg` option is currently read and used. Look at the main entry point (likely `index.js`) for the configuration logic. Then research the `read pkg up` library and consider how to integrate it to automatically locate the nearest `package.json`. The issue suggests passing ` dirname` as a parameter; evaluate this approach. Check the comments for any maintainer feedback to confirm the desired direction.