web.php5.sk

Ako vytvoriť Bower balíček

10. február 2016 / Čamo

Tento článok je voľným prekladom dokumentácie. Registrovanie balíčka umožní úplne cudzím a neznámym ľuďom, aby si váš balíček stiahli spustením príkazu bower install <my-package-name>. Buďte na to preto pripravení.

Balíček je vlastne adresár, ktorý obsahuje validný bower.json súbor. Balíček musí byť verejne dostupný na niektorom Git úložisku (napr. GitHub). Nezabudnite verzie otagovať. Verzovanie balíčkou sa robí podľa semver špecifikácie. Prefix v (v1.0.0) je povolený. Privátne balíčky (napr. na GitHub Enterprise),  musia spĺňať určité špeciálne požiadavky viď. Bower registry

Súbor bower.json môže vyzerať napríklad takto

{
    "name": "my-package-name",
    "description": "Something about your package.",
    "main": [
        "js/motion.js",
        "sass/motion.scss"
    ],
"repository": {
"type": "git",
"url": "git://github.com/foo/bar.git"
}, "dependencies": { "jquery": "~1.7" }, "devDependencies": { "qunit": "~1.16.0" }, "moduleType": [ "amd", "globals", "node" ], "keywords": [ "motion", "physics", "particles" ], "authors": [ "Betty Beta <bbeta@example.com>" ], "license": "MIT", "ignore": [ "**/.*", "node_modules", "bower_components", "test", "tests" ] }

A terza si to trochu rozoberieme viď. dokumentácia.

Meno balíčka

Musí byť jedinečné. Kôli jednoduchosti použite slug style napr. jquery-awesome-plugin. Môže obsahovať malé písmená , čísla, pomlčky a bodky, ale nesmie začínať ani končiť pomlčkou, alebo bodkou. Viac po sebe nasledujúcich pomlčie, alebo bodiek nieje povolené. Musí byť kratší ako 50 znakov.

Description

Popis balíčka. Maximálne 140 znakov. Zobrazí sa vo výsledkoch vyhľadávania v konzole a na webe určenom na vyhľadávanie balíčkov.

Main

Odporúča sa. Typ: string alebo pole stringov. Súbory, ktoré slúžia ako vstupné body nevyhnutné pre použitie balíčka. Povolený je jeden súbor pre jeden typ súborov. Bower na tieto súbory neprihliada. 

ModuleType

Vsťahuje sa ku main súborom, ale viac som nepochopil.

License

String, alebo pole stringov. Vo formáte SPDX license identifier, alebo cesta/url k licencii.

Ignore

Zoznam podľa ktorého Bower zistí, ktoré súbory má ignorovať pri inštalovaní balíčka. Povolené pravidlá zápisu sú také isté ako v gitignore pattern spec.

Keywords

Pre kezwords platia tie isté pravidlá ako pre name. Uľahčí vyhľadávanie.

Authors

Pole stingov, alebo objektov.

Homepage

Homepage je homepage url.

Repository

Typ objekt. Repozitár kde sa balíček nachádza.

Dependecies

Objekt. Dvojice meno - verzia. Meno je meno balíčka na ktorom váš balíček závisí a verzia je buď validný semver range Git url , alebo url. Git url môže byť obmedzená na revíziu SHA, vetvu alebo tag pripojením za # napr. https://github.com/owner/package.git#branch.

DevDependencies

Platí to isté ako pri dependencies. DevDependencies sa používajú pri vývoji balíčka. Teda nie pri jeho používaní.

Plus ešte zopár volieb, ktoré už nebudem rozoberať. 

Samotnú registáciu uskutočníte príkazom

$ bower register my-package-name git://github.com/username/my-package-name.git

 Teraz si každý môže vás balíček stiahnuť príkazom

bower install my-package-name

Prípadné odregistrovanie balíčka sa robí nasledovne

bower login
# enter username and password
? Username:
? Password:
# unregister packages after successful login
bower unregister <package-name>

Username a password sú od Github účtu na ktorom je balíček umiestnený.

Koniec.

Ak chcete pridávať komentáre musíte sa prihlásiť