Abhishek-Mallick / Abhishek-Mallick/universal-box

Reduce npm Package Size by Excluding `templates/` Directory from Distribution

Ouverte
#7 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement help wanted
Langage dominant
JavaScript
Étoiles
47
Forks
41
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

The `templates/` directory in our npm package contains various templates used for scaffolding code. As we continue to add more templates, the size of the npm package will increase unnecessarily, leading to version inflation and potential issues for users with limited bandwidth.

## Proposed Solution:

Exclude the `templates/` directory from the npm package by adding it to `.npmignore`.
Modify the `bin/universal-box.js` script to dynamically display available template options by iterating through the `templates/` directory.
Since the `templates/` directory will not be present in the npm package, we can create empty directories representing each template just to display the options. These empty directories won't be ignored by `.npmignore`.
When a user selects a template, the corresponding directory should be cloned from the repository, pulling in the necessary files only when needed.

## Expected Outcome:

Reduced package size, making it more efficient to install and update.
Users will still be able to see all available templates and select them for scaffolding without downloading unnecessary files.

Open to further discussions

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Examine the .npmignore file and the bin/universal-box.js script. Understand how templates are currently included and used. The change involves updating .npmignore to exclude the templates/ directory, then modifying the CLI script to list templates by reading the repository (likely via Git) instead of the local directory, and cloning the selected template on demand. Test the package build and installation locally to ensure the CLI still works without the templates directory present.

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

Évaluation

Stack technique
javascript, nodejs
Domaine
build-system, cli, tooling
Type d'issue
Refactorisation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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