Registru NPM privat în 30 de secunde cu Bit

ian. 5, 2022

admin

Inițial publicat de Jonathan Saring la 17 septembrie 2018 24,750 lecturi

@ysaringJonathan Saring

Eu scriu cod și cuvinte. Lucrez pe github.com/teambit/bit

Cum să configurați rapid un depozit privat de pachete Node.js cu Bit și NPM și să vă partajați componentele.

Configurarea unui registru de pachete Node.js este adesea primul pas pentru a scala partajarea codului și pentru a face viața echipei dvs. puțin mai ușoară.

Părtășirea mai multor module înseamnă duplicarea mai puțin cod. De asemenea, ajută la construirea unui software mai modular și mai ușor de întreținut. Cu toate acestea, costurile generale legate de configurarea și întreținerea unui registru NPM privat pot fi masive.

Utilizând Bit, puteți elimina cea mai mare parte a costurilor generale legate de un registru privat, reducând în același timp costurile generale legate de procesul de împachetare și publicare.

În acest scurt tutorial, vă voi arăta cum, folosind Bit, puteți configura un registru privat Node.js și publica zeci de componente și module în doar câteva minute, în 3 pași.

Configurați un registru Node.js în 30 de secunde
Publicați module/componente
Instalați pachetele cu clientul NPM/Yarn

Să începem.

Puteți consulta și acest scurt tutorial video.

Configurați un registru de pachete Node.js package registry pentru componentele tale

Să setăm un registru privat de pachete pentru echipa ta.

Vom folosi platforma web a lui Bit pentru a găzdui modulele pe care le împărtășim și clientul nativ NPM/Yarn pentru a le instala.

Primul lucru este să setăm un registru.

a. Mergeți la bit.dev Faceți clic pe get started.

b. Înscrieți-vă. Este gratuit.

c. Creați o colecție:

Pentru a seta o colecție privată, selectați doar „private”. Asta este!

Acum aveți o colecție în platforma web Bit, care funcționează, de asemenea, ca un registru de pachete. Să vedem cum să publicăm pachete în acest registru.

Publicați componente sau module

Acum să publicăm module și componente în registrul nostru nou creat. Din moment ce am configurat registrul pe platforma Bit, putem folosi Bit și pentru acest flux de lucru, pentru a economisi timp și efort prețios.

https://docs.bit.dev/

În primul rând, instalați Bit. Apoi, mergeți la proiectul în care aveți pachetele pe care doriți să le publicați. Rețineți că, din moment ce folosim Bit, puteți publica pachete direct din orice proiect existent, fără refactorizare.

#1 Install Bit
npm install bit-bin -g

#2 Create a local workspace for your project
$ cd project-directory
$ bit init

În loc să trebuiască să creăm un nou depozit, să configurăm pachetul etc., să folosim Bit pentru a izola componentele și modulele din proiectele existente și să le publicăm ca pachete.

Să direcționăm Bit către pachetele corecte din proiect folosind comanda bit add.

Exemplu

Să urmărim componentele button, login și logo în următoarea structură de directoare a proiectului.

$ tree
.
├── App.js
├── App.test.js
├── favicon.ico
├── index.js
└── src
└── components
├── button
│ ├── Button.js
│ ├── Button.spec.js
│ └── index.js
├── login
│ ├── Login.js
│ ├── Login.spec.js
│ └── index.js
└── logo
├── Logo.js
├── Logo.spec.js
└── index.js

5 directories, 13 files

Pentru a urmări aceste fișiere ca și componente putem folosi bit add cu un model glob, indicând Bit către calea în care se găsesc modulele pe care dorim să le publicăm.

$ bit add src/components/*
tracking 3 new components

Rețineți că Bit va parcurge în mod automat dependențele pachetului de fișiere & ale modulului și va crea un mediu izolat pentru codul care conține tot ceea ce are nevoie pentru a putea rula în alte proiecte.

Acum, să adăugăm mediile de construcție și testare, astfel încât Bit să poată construi și testa pachetele (în cloud) și să prezinte rezultatele pentru fiecare pachet. Puteți găsi o listă de medii prefabricate aici.

Iată un exemplu recomandat pentru componentele React.

$ bit import bit.envs/compilers/babel --compiler

$ bit import bit.envs/testers/mocha --tester

De asemenea, vă puteți implementa propriile medii folosind sistemul de extensii al lui Bit. Pentru asistență, vizitați canalul Gitter sau forumul Discourse al Bit.

Acum, haideți să etichetăm o versiune pentru pachetele pe care urmează să le publicăm (urmând exemplul anterior).

$ bit tag --all 1.0.0
3 components tagged | 3 added, 0 changed, 0 auto-tagged
added components: components/[email protected], components/[email protected], components/[email protected]

În continuare, folosiți bit login pentru a vă autentifica mașina la platforma Bit.

$ bit login
Your browser has been opened to visit: http://bit.dev/bit-login?redirect_uri=http://localhost:8085...

În cele din urmă, exportați (publicați) pachetele.

$ bit export user-name.collection-name
exported 3 components to scope user-name.collection-name

Așa este!

Toate pachetele dvs. vor fi acum disponibile în colecția dvs., gata de a fi instalate folosind NPM/Yarn în orice proiect. Floare la ureche și putem folosi acest flux de lucru pentru a publica rapid un număr mare de pachete în foarte puțin timp.

Instalați pachetele folosind clientul NPM/Yarn

Acum că pachetele noastre sunt gata, să învățăm cum să le instalăm.

În primul rând, configurați bit.dev ca un registru cu domeniu de cuprindere pentru clientul NPM.

npm config set '@bit:registry' https://node.bit.dev

Asta este 🙂

Acum orice pachet poate fi instalat folosind clientul nativ NPM/Yarn.

Direcționați-vă spre pagina de componente/module (Exemplu).

Verificați panoul din partea dreaptă sus. Alegeți fila „NPM” și copiați comanda:

npm i @bit/user-name.collection-name.namespace.packagename

Să vedem un exemplu.

Iată o componentă React Hero partajată ca pachet. Să folosim următoarea comandă pentru a o instala (user = bit, collection = movie-app, name space = components, package name = hero):

npm i @bit/bit.movie-app.components.hero

Asta este. Acum puteți partaja și instala liber aceste pachete ca și cum le-ați fi publicat în orice alt registru NPM. Cele mai bune

JFrog Artifactory: Puteți folosi, de asemenea, Artifactory de la JFrog ca registru Bit. Aflați mai multe pe blogul JFrog pentru a vedea cum se face.

Flux de lucru pentru dezvoltare distribuită

Un alt avantaj al instalării pachetelor prin intermediul registrului Bit este că puteți folosi Bit pentru a importa și a face modificări la o versiune a codului sursă real al pachetelor direct din orice proiect la care lucrați.

Dincolo de alte registre, care necesită un proces greoi pentru clonarea și publicarea modificărilor la un pachet, Bit permite diferiților membri ai echipei să importe și să modifice pachete din proiecte diferite.

De asemenea, ajută la sincronizarea modificărilor între ele folosind actualizări inteligente și un utilitar de fuziune între repo-uri (extensie Git).

De exemplu, să ne uităm la această structură repo.

$ tree .
.
├── bit.json
├── package.json
└── src
├── hello-world
│ ├── hello-world.js
│ └── index.js
└── utils
├── noop.js
└── left-pad.js

Vom folosi Bit pentru a importa componenta left-pad în proiectul local.

$ bit init
$ bit import bit.utils/string/left-pad --path src/left-pad

Acum putem face modificările necesare, tag și export le putem face înapoi în colecție (creând o nouă versiune) sau într-o nouă colecție pentru a le partaja.

Concluzie

În acest scurt tutorial am învățat cum să:

Configurați un registru NPM în 30 de secunde
Publicați pachete fără refactorizare sau boilerplating
Instalați-le cu clientul NPM/Yarn
Faceți modificări oriunde și colaborați

Părtășiți mai mult cod într-un mod administrat, reducând în același timp cheltuielile și timpul implicat în acest proces, înseamnă că echipa dvs. poate accelera dezvoltarea și simplifica întreținerea bazei de cod.

Simțiți-vă liber să începeți, să vă configurați propriul registru și să partajați niște cod. Puteți verifica proiectul pe GitHub sau puteți discuta cu echipa pe Gitter. Vă mulțumim!