diff options
Diffstat (limited to 'doc/languages-frameworks/bower.xml')
| -rw-r--r-- | doc/languages-frameworks/bower.xml | 71 |
1 files changed, 19 insertions, 52 deletions
diff --git a/doc/languages-frameworks/bower.xml b/doc/languages-frameworks/bower.xml index 118f6e10473a..b0738cad293b 100644 --- a/doc/languages-frameworks/bower.xml +++ b/doc/languages-frameworks/bower.xml @@ -4,32 +4,22 @@ <title>Bower</title> <para> - <link xlink:href="http://bower.io">Bower</link> is a package manager for web - site front-end components. Bower packages (comprising of build artefacts and - sometimes sources) are stored in <command>git</command> repositories, - typically on Github. The package registry is run by the Bower team with - package metadata coming from the <filename>bower.json</filename> file within - each package. + <link xlink:href="http://bower.io">Bower</link> is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in <command>git</command> repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the <filename>bower.json</filename> file within each package. </para> <para> - The end result of running Bower is a <filename>bower_components</filename> - directory which can be included in the web app's build process. + The end result of running Bower is a <filename>bower_components</filename> directory which can be included in the web app's build process. </para> <para> - Bower can be run interactively, by installing - <varname>nodePackages.bower</varname>. More interestingly, the Bower - components can be declared in a Nix derivation, with the help of - <varname>nodePackages.bower2nix</varname>. + Bower can be run interactively, by installing <varname>nodePackages.bower</varname>. More interestingly, the Bower components can be declared in a Nix derivation, with the help of <varname>nodePackages.bower2nix</varname>. </para> <section xml:id="ssec-bower2nix-usage"> <title><command>bower2nix</command> usage</title> <para> - Suppose you have a <filename>bower.json</filename> with the following - contents: + Suppose you have a <filename>bower.json</filename> with the following contents: <example xml:id="ex-bowerJson"> <title><filename>bower.json</filename></title> <programlisting language="json"> @@ -45,8 +35,7 @@ </para> <para> - Running <command>bower2nix</command> will produce something like the - following output: + Running <command>bower2nix</command> will produce something like the following output: <programlisting language="nix"> <![CDATA[{ fetchbower, buildEnv }: buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ @@ -58,15 +47,11 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ </para> <para> - Using the <command>bower2nix</command> command line arguments, the output - can be redirected to a file. A name like - <filename>bower-packages.nix</filename> would be fine. + Using the <command>bower2nix</command> command line arguments, the output can be redirected to a file. A name like <filename>bower-packages.nix</filename> would be fine. </para> <para> - The resulting derivation is a union of all the downloaded Bower packages - (and their dependencies). To use it, they still need to be linked together - by Bower, which is where <varname>buildBowerComponents</varname> is useful. + The resulting derivation is a union of all the downloaded Bower packages (and their dependencies). To use it, they still need to be linked together by Bower, which is where <varname>buildBowerComponents</varname> is useful. </para> </section> @@ -74,10 +59,7 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ <title><varname>buildBowerComponents</varname> function</title> <para> - The function is implemented in - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> - <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>. - Example usage: + The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>. Example usage: <example xml:id="ex-buildBowerComponents"> <title>buildBowerComponents</title> <programlisting language="nix"> @@ -91,34 +73,27 @@ bowerComponents = buildBowerComponents { </para> <para> - In <xref linkend="ex-buildBowerComponents" />, the following arguments are - of special significance to the function: + In <xref linkend="ex-buildBowerComponents" />, the following arguments are of special significance to the function: <calloutlist> <callout arearefs="ex-buildBowerComponents-1"> <para> - <varname>generated</varname> specifies the file which was created by - <command>bower2nix</command>. + <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>. </para> </callout> <callout arearefs="ex-buildBowerComponents-2"> <para> - <varname>src</varname> is your project's sources. It needs to contain a - <filename>bower.json</filename> file. + <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file. </para> </callout> </calloutlist> </para> <para> - <varname>buildBowerComponents</varname> will run Bower to link together the - output of <command>bower2nix</command>, resulting in a - <filename>bower_components</filename> directory which can be used. + <varname>buildBowerComponents</varname> will run Bower to link together the output of <command>bower2nix</command>, resulting in a <filename>bower_components</filename> directory which can be used. </para> <para> - Here is an example of a web frontend build process using - <command>gulp</command>. You might use <command>grunt</command>, or anything - else. + Here is an example of a web frontend build process using <command>gulp</command>. You might use <command>grunt</command>, or anything else. </para> <example xml:id="ex-bowerGulpFile"> @@ -174,21 +149,17 @@ pkgs.stdenv.mkDerivation { <calloutlist> <callout arearefs="ex-buildBowerComponentsDefault-1"> <para> - The result of <varname>buildBowerComponents</varname> is an input to the - frontend build. + The result of <varname>buildBowerComponents</varname> is an input to the frontend build. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-2"> <para> - Whether to symlink or copy the <filename>bower_components</filename> - directory depends on the build tool in use. In this case a copy is used - to avoid <command>gulp</command> silliness with permissions. + Whether to symlink or copy the <filename>bower_components</filename> directory depends on the build tool in use. In this case a copy is used to avoid <command>gulp</command> silliness with permissions. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-3"> <para> - <command>gulp</command> requires <varname>HOME</varname> to refer to a - writeable directory. + <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-4"> @@ -210,17 +181,13 @@ pkgs.stdenv.mkDerivation { </term> <listitem> <para> - This means that Bower was looking for a package version which doesn't - exist in the generated <filename>bower-packages.nix</filename>. + This means that Bower was looking for a package version which doesn't exist in the generated <filename>bower-packages.nix</filename>. </para> <para> - If <filename>bower.json</filename> has been updated, then run - <command>bower2nix</command> again. + If <filename>bower.json</filename> has been updated, then run <command>bower2nix</command> again. </para> <para> - It could also be a bug in <command>bower2nix</command> or - <command>fetchbower</command>. If possible, try reformulating the version - specification in <filename>bower.json</filename>. + It could also be a bug in <command>bower2nix</command> or <command>fetchbower</command>. If possible, try reformulating the version specification in <filename>bower.json</filename>. </para> </listitem> </varlistentry> |