Make `ssh2` an optional peer dependency

Ouverte
#64 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
docker, node.js, typescript
Domaine
tooling

Piste de recherche

Start by tracing DockerClient.fromDockerHost and the package dependency declarations to see how ssh2 enters consumer dependency trees. Check the bundling and installation behavior for consumers that do not use SSH, and verify that ssh:// paths fail clearly when ssh2 is absent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Currently, DockerClient can't be used without ssh2 (a very large dependency) being in the dependency tree, despite it only being used in one branch of DockerClient.fromDockerHost. If consumers don't connect over ssh, they shouldn't need that dependency.

I'd recommend:

  • Moving the static members out of DockerClient and into their own modules. That should solve the dependency tree problem (via tree-shaking) for anybody bundling their app
  • For everyone else (and just to minimise node_modules impact), it'd be good to also make ssh2 an optional peer dependency and make the ssh://-specific code paths fail if it's not present
Langage dominant
TypeScript
Étoiles
107
Forks
12
Métriques de merge des PR
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docker/node-sdk

Toutes les issues de docker/node-sdk

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.