commit 2eb20aa8ce7265c5348e1e234f65a09fc260ead3 · pyrox.dev/nixpkgs

+158

doc/languages-frameworks/bower.section.md

···

       1
       1
       +
       # Bower {#sec-bower}

     

       2
       2
       +
       

     

       3
       3
       +
       [Bower](https://bower.io) is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in `git` repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the `bower.json` file within each package.

     

       4
       4
       +
       

     

       5
       5
       +
       The end result of running Bower is a `bower_components` directory which can be included in the web app's build process.

     

       6
       6
       +
       

     

       7
       7
       +
       Bower can be run interactively, by installing `nodePackages.bower`. More interestingly, the Bower components can be declared in a Nix derivation, with the help of `nodePackages.bower2nix`.

     

       8
       8
       +
       

     

       9
       9
       +
       ## bower2nix usage {#ssec-bower2nix-usage}

     

       10
       10
       +
       

     

       11
       11
       +
       Suppose you have a `bower.json` with the following contents:

     

       12
       12
       +
       

     

       13
       13
       +
       ### Example bower.json {#ex-bowerJson}

     

       14
       14
       +
       

     

       15
       15
       +
       ```json

     

       16
       16
       +
         "name": "my-web-app",

     

       17
       17
       +
         "dependencies": {

     

       18
       18
       +
           "angular": "~1.5.0",

     

       19
       19
       +
           "bootstrap": "~3.3.6"

     

       20
       20
       +
         }

     

       21
       21
       +
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       Running `bower2nix` will produce something like the following output:

     

       24
       24
       +
       

     

       25
       25
       +
       ```nix

     

       26
       26
       +
       { fetchbower, buildEnv }:

     

       27
       27
       +
       buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [

     

       28
       28
       +
         (fetchbower "angular" "1.5.3" "~1.5.0" "1749xb0firxdra4rzadm4q9x90v6pzkbd7xmcyjk6qfza09ykk9y")

     

       29
       29
       +
         (fetchbower "bootstrap" "3.3.6" "~3.3.6" "1vvqlpbfcy0k5pncfjaiskj3y6scwifxygfqnw393sjfxiviwmbv")

     

       30
       30
       +
         (fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1")

     

       31
       31
       +
       ];

     

       32
       32
       +
       ```

     

       33
       33
       +
       

     

       34
       34
       +
       Using the `bower2nix` command line arguments, the output can be redirected to a file. A name like `bower-packages.nix` would be fine.

     

       35
       35
       +
       

     

       36
       36
       +
       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 `buildBowerComponents` is useful.

     

       37
       37
       +
       

     

       38
       38
       +
       ## buildBowerComponents function {#ssec-build-bower-components}

     

       39
       39
       +
       

     

       40
       40
       +
       The function is implemented in [pkgs/development/bower-modules/generic/default.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix).

     

       41
       41
       +
       

     

       42
       42
       +
       ### Example buildBowerComponents {#ex-buildBowerComponents}

     

       43
       43
       +
       

     

       44
       44
       +
       ```{=docbook}

     

       45
       45
       +
       <programlisting language="nix">

     

       46
       46
       +
       bowerComponents = buildBowerComponents {

     

       47
       47
       +
         name = "my-web-app";

     

       48
       48
       +
         generated = ./bower-packages.nix; <co xml:id="ex-buildBowerComponents-1" />

     

       49
       49
       +
         src = myWebApp; <co xml:id="ex-buildBowerComponents-2" />

     

       50
       50
       +
       };

     

       51
       51
       +
       </programlisting>

     

       52
       52
       +
       ```

     

       53
       53
       +
       

     

       54
       54
       +
       In ["buildBowerComponents" example](#ex-buildBowerComponents) the following arguments are of special significance to the function:

     

       55
       55
       +
       

     

       56
       56
       +
       ```{=docbook}

     

       57
       57
       +
       <calloutlist>

     

       58
       58
       +
         <callout arearefs="ex-buildBowerComponents-1">

     

       59
       59
       +
           <para>

     

       60
       60
       +
             <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>.

     

       61
       61
       +
           </para>

     

       62
       62
       +
           </callout>

     

       63
       63
       +
             <callout arearefs="ex-buildBowerComponents-2">

     

       64
       64
       +
           <para>

     

       65
       65
       +
             <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file.

     

       66
       66
       +
           </para>

     

       67
       67
       +
         </callout>

     

       68
       68
       +
       </calloutlist>

     

       69
       69
       +
       ```

     

       70
       70
       +
       

     

       71
       71
       +
       `buildBowerComponents` will run Bower to link together the output of `bower2nix`, resulting in a `bower_components` directory which can be used.

     

       72
       72
       +
       

     

       73
       73
       +
       Here is an example of a web frontend build process using `gulp`. You might use `grunt`, or anything else.

     

       74
       74
       +
       

     

       75
       75
       +
       ### Example build script (gulpfile.js) {#ex-bowerGulpFile}

     

       76
       76
       +
       

     

       77
       77
       +
       ```javascript

     

       78
       78
       +
       var gulp = require('gulp');

     

       79
       79
       +
       

     

       80
       80
       +
       gulp.task('default', [], function () {

     

       81
       81
       +
         gulp.start('build');

     

       82
       82
       +
       });

     

       83
       83
       +
       

     

       84
       84
       +
       gulp.task('build', [], function () {

     

       85
       85
       +
         console.log("Just a dummy gulp build");

     

       86
       86
       +
         gulp

     

       87
       87
       +
           .src(["./bower_components/**/*"])

     

       88
       88
       +
           .pipe(gulp.dest("./gulpdist/"));

     

       89
       89
       +
       });

     

       90
       90
       +
       ```

     

       91
       91
       +
       

     

       92
       92
       +
       ### Example Full example — default.nix {#ex-buildBowerComponentsDefaultNix}

     

       93
       93
       +
       

     

       94
       94
       +
       ```{=docbook}

     

       95
       95
       +
       <programlisting language="nix">

     

       96
       96
       +
       { myWebApp ? { outPath = ./.; name = "myWebApp"; }

     

       97
       97
       +
       , pkgs ? import &lt;nixpkgs&gt; {}

     

       98
       98
       +
       }:

     

       99
       99
       +
       

     

       100
       100
       +
       pkgs.stdenv.mkDerivation {

     

       101
       101
       +
         name = "my-web-app-frontend";

     

       102
       102
       +
         src = myWebApp;

     

       103
       103
       +
       

     

       104
       104
       +
         buildInputs = [ pkgs.nodePackages.gulp ];

     

       105
       105
       +
       

     

       106
       106
       +
         bowerComponents = pkgs.buildBowerComponents { <co xml:id="ex-buildBowerComponentsDefault-1" />

     

       107
       107
       +
           name = "my-web-app";

     

       108
       108
       +
           generated = ./bower-packages.nix;

     

       109
       109
       +
           src = myWebApp;

     

       110
       110
       +
         };

     

       111
       111
       +
       

     

       112
       112
       +
         buildPhase = ''

     

       113
       113
       +
           cp --reflink=auto --no-preserve=mode -R $bowerComponents/bower_components . <co xml:id="ex-buildBowerComponentsDefault-2" />

     

       114
       114
       +
           export HOME=$PWD <co xml:id="ex-buildBowerComponentsDefault-3" />

     

       115
       115
       +
           ${pkgs.nodePackages.gulp}/bin/gulp build <co xml:id="ex-buildBowerComponentsDefault-4" />

     

       116
       116
       +
         '';

     

       117
       117
       +
       

     

       118
       118
       +
         installPhase = "mv gulpdist $out";

     

       119
       119
       +
       }

     

       120
       120
       +
       </programlisting>

     

       121
       121
       +
       ```

     

       122
       122
       +
       

     

       123
       123
       +
       A few notes about [Full example — `default.nix`](#ex-buildBowerComponentsDefaultNix):

     

       124
       124
       +
       

     

       125
       125
       +
       ```{=docbook}

     

       126
       126
       +
       <calloutlist>

     

       127
       127
       +
         <callout arearefs="ex-buildBowerComponentsDefault-1">

     

       128
       128
       +
           <para>

     

       129
       129
       +
             The result of <varname>buildBowerComponents</varname> is an input to the frontend build.

     

       130
       130
       +
           </para>

     

       131
       131
       +
         </callout>

     

       132
       132
       +
         <callout arearefs="ex-buildBowerComponentsDefault-2">

     

       133
       133
       +
           <para>

     

       134
       134
       +
             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.

     

       135
       135
       +
           </para>

     

       136
       136
       +
         </callout>

     

       137
       137
       +
         <callout arearefs="ex-buildBowerComponentsDefault-3">

     

       138
       138
       +
           <para>

     

       139
       139
       +
             <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory.

     

       140
       140
       +
           </para>

     

       141
       141
       +
         </callout>

     

       142
       142
       +
         <callout arearefs="ex-buildBowerComponentsDefault-4">

     

       143
       143
       +
           <para>

     

       144
       144
       +
             The actual build command. Other tools could be used.

     

       145
       145
       +
           </para>

     

       146
       146
       +
         </callout>

     

       147
       147
       +
       </calloutlist>

     

       148
       148
       +
       ```

     

       149
       149
       +
       

     

       150
       150
       +
       ## Troubleshooting {#ssec-bower2nix-troubleshooting}

     

       151
       151
       +
       

     

       152
       152
       +
       ### ENOCACHE errors from buildBowerComponents

     

       153
       153
       +
       

     

       154
       154
       +
       This means that Bower was looking for a package version which doesn't exist in the generated `bower-packages.nix`.

     

       155
       155
       +
       

     

       156
       156
       +
       If `bower.json` has been updated, then run `bower2nix` again.

     

       157
       157
       +
       

     

       158
       158
       +
       It could also be a bug in `bower2nix` or `fetchbower`. If possible, try reformulating the version specification in `bower.json`.

-196

doc/languages-frameworks/bower.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xml:id="sec-bower">

     

       4
       4
       -
        <title>Bower</title>

     

       5
       5
       -
       

     

       6
       6
       -
        <para>

     

       7
       7
       -
         <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.

     

       8
       8
       -
        </para>

     

       9
       9
       -
       

     

       10
       10
       -
        <para>

     

       11
       11
       -
         The end result of running Bower is a <filename>bower_components</filename> directory which can be included in the web app's build process.

     

       12
       12
       -
        </para>

     

       13
       13
       -
       

     

       14
       14
       -
        <para>

     

       15
       15
       -
         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>.

     

       16
       16
       -
        </para>

     

       17
       17
       -
       

     

       18
       18
       -
        <section xml:id="ssec-bower2nix-usage">

     

       19
       19
       -
         <title><command>bower2nix</command> usage</title>

     

       20
       20
       -
       

     

       21
       21
       -
         <para>

     

       22
       22
       -
          Suppose you have a <filename>bower.json</filename> with the following contents:

     

       23
       23
       -
          <example xml:id="ex-bowerJson">

     

       24
       24
       -
           <title><filename>bower.json</filename></title>

     

       25
       25
       -
       <programlisting language="json">

     

       26
       26
       -
       <![CDATA[{

     

       27
       27
       -
         "name": "my-web-app",

     

       28
       28
       -
         "dependencies": {

     

       29
       29
       -
           "angular": "~1.5.0",

     

       30
       30
       -
           "bootstrap": "~3.3.6"

     

       31
       31
       -
         }

     

       32
       32
       -
       }]]>

     

       33
       33
       -
       </programlisting>

     

       34
       34
       -
          </example>

     

       35
       35
       -
         </para>

     

       36
       36
       -
       

     

       37
       37
       -
         <para>

     

       38
       38
       -
          Running <command>bower2nix</command> will produce something like the following output:

     

       39
       39
       -
       <programlisting language="nix">

     

       40
       40
       -
       <![CDATA[{ fetchbower, buildEnv }:

     

       41
       41
       -
       buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [

     

       42
       42
       -
         (fetchbower "angular" "1.5.3" "~1.5.0" "1749xb0firxdra4rzadm4q9x90v6pzkbd7xmcyjk6qfza09ykk9y")

     

       43
       43
       -
         (fetchbower "bootstrap" "3.3.6" "~3.3.6" "1vvqlpbfcy0k5pncfjaiskj3y6scwifxygfqnw393sjfxiviwmbv")

     

       44
       44
       -
         (fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1")

     

       45
       45
       -
       ]; }]]>

     

       46
       46
       -
       </programlisting>

     

       47
       47
       -
         </para>

     

       48
       48
       -
       

     

       49
       49
       -
         <para>

     

       50
       50
       -
          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.

     

       51
       51
       -
         </para>

     

       52
       52
       -
       

     

       53
       53
       -
         <para>

     

       54
       54
       -
          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.

     

       55
       55
       -
         </para>

     

       56
       56
       -
        </section>

     

       57
       57
       -
       

     

       58
       58
       -
        <section xml:id="ssec-build-bower-components">

     

       59
       59
       -
         <title><varname>buildBowerComponents</varname> function</title>

     

       60
       60
       -
       

     

       61
       61
       -
         <para>

     

       62
       62
       -
          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:

     

       63
       63
       -
          <example xml:id="ex-buildBowerComponents">

     

       64
       64
       -
           <title>buildBowerComponents</title>

     

       65
       65
       -
       <programlisting language="nix">

     

       66
       66
       -
       bowerComponents = buildBowerComponents {

     

       67
       67
       -
         name = "my-web-app";

     

       68
       68
       -
         generated = ./bower-packages.nix; <co xml:id="ex-buildBowerComponents-1" />

     

       69
       69
       -
         src = myWebApp; <co xml:id="ex-buildBowerComponents-2" />

     

       70
       70
       -
       };

     

       71
       71
       -
       </programlisting>

     

       72
       72
       -
          </example>

     

       73
       73
       -
         </para>

     

       74
       74
       -
       

     

       75
       75
       -
         <para>

     

       76
       76
       -
          In <xref linkend="ex-buildBowerComponents" />, the following arguments are of special significance to the function:

     

       77
       77
       -
          <calloutlist>

     

       78
       78
       -
           <callout arearefs="ex-buildBowerComponents-1">

     

       79
       79
       -
            <para>

     

       80
       80
       -
             <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>.

     

       81
       81
       -
            </para>

     

       82
       82
       -
           </callout>

     

       83
       83
       -
           <callout arearefs="ex-buildBowerComponents-2">

     

       84
       84
       -
            <para>

     

       85
       85
       -
             <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file.

     

       86
       86
       -
            </para>

     

       87
       87
       -
           </callout>

     

       88
       88
       -
          </calloutlist>

     

       89
       89
       -
         </para>

     

       90
       90
       -
       

     

       91
       91
       -
         <para>

     

       92
       92
       -
          <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.

     

       93
       93
       -
         </para>

     

       94
       94
       -
       

     

       95
       95
       -
         <para>

     

       96
       96
       -
          Here is an example of a web frontend build process using <command>gulp</command>. You might use <command>grunt</command>, or anything else.

     

       97
       97
       -
         </para>

     

       98
       98
       -
       

     

       99
       99
       -
         <example xml:id="ex-bowerGulpFile">

     

       100
       100
       -
          <title>Example build script (<filename>gulpfile.js</filename>)</title>

     

       101
       101
       -
       <programlisting language="javascript">

     

       102
       102
       -
       <![CDATA[var gulp = require('gulp');

     

       103
       103
       -
       

     

       104
       104
       -
       gulp.task('default', [], function () {

     

       105
       105
       -
         gulp.start('build');

     

       106
       106
       -
       });

     

       107
       107
       -
       

     

       108
       108
       -
       gulp.task('build', [], function () {

     

       109
       109
       -
         console.log("Just a dummy gulp build");

     

       110
       110
       -
         gulp

     

       111
       111
       -
           .src(["./bower_components/**/*"])

     

       112
       112
       -
           .pipe(gulp.dest("./gulpdist/"));

     

       113
       113
       -
       });]]>

     

       114
       114
       -
       </programlisting>

     

       115
       115
       -
         </example>

     

       116
       116
       -
       

     

       117
       117
       -
         <example xml:id="ex-buildBowerComponentsDefaultNix">

     

       118
       118
       -
          <title>Full example — <filename>default.nix</filename></title>

     

       119
       119
       -
       <programlisting language="nix">

     

       120
       120
       -
       { myWebApp ? { outPath = ./.; name = "myWebApp"; }

     

       121
       121
       -
       , pkgs ? import &lt;nixpkgs&gt; {}

     

       122
       122
       -
       }:

     

       123
       123
       -
       

     

       124
       124
       -
       pkgs.stdenv.mkDerivation {

     

       125
       125
       -
         name = "my-web-app-frontend";

     

       126
       126
       -
         src = myWebApp;

     

       127
       127
       -
       

     

       128
       128
       -
         buildInputs = [ pkgs.nodePackages.gulp ];

     

       129
       129
       -
       

     

       130
       130
       -
         bowerComponents = pkgs.buildBowerComponents { <co xml:id="ex-buildBowerComponentsDefault-1" />

     

       131
       131
       -
           name = "my-web-app";

     

       132
       132
       -
           generated = ./bower-packages.nix;

     

       133
       133
       -
           src = myWebApp;

     

       134
       134
       -
         };

     

       135
       135
       -
       

     

       136
       136
       -
         buildPhase = ''

     

       137
       137
       -
           cp --reflink=auto --no-preserve=mode -R $bowerComponents/bower_components . <co xml:id="ex-buildBowerComponentsDefault-2" />

     

       138
       138
       -
           export HOME=$PWD <co xml:id="ex-buildBowerComponentsDefault-3" />

     

       139
       139
       -
           ${pkgs.nodePackages.gulp}/bin/gulp build <co xml:id="ex-buildBowerComponentsDefault-4" />

     

       140
       140
       -
         '';

     

       141
       141
       -
       

     

       142
       142
       -
         installPhase = "mv gulpdist $out";

     

       143
       143
       -
       }

     

       144
       144
       -
       </programlisting>

     

       145
       145
       -
         </example>

     

       146
       146
       -
       

     

       147
       147
       -
         <para>

     

       148
       148
       -
          A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:

     

       149
       149
       -
          <calloutlist>

     

       150
       150
       -
           <callout arearefs="ex-buildBowerComponentsDefault-1">

     

       151
       151
       -
            <para>

     

       152
       152
       -
             The result of <varname>buildBowerComponents</varname> is an input to the frontend build.

     

       153
       153
       -
            </para>

     

       154
       154
       -
           </callout>

     

       155
       155
       -
           <callout arearefs="ex-buildBowerComponentsDefault-2">

     

       156
       156
       -
            <para>

     

       157
       157
       -
             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.

     

       158
       158
       -
            </para>

     

       159
       159
       -
           </callout>

     

       160
       160
       -
           <callout arearefs="ex-buildBowerComponentsDefault-3">

     

       161
       161
       -
            <para>

     

       162
       162
       -
             <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory.

     

       163
       163
       -
            </para>

     

       164
       164
       -
           </callout>

     

       165
       165
       -
           <callout arearefs="ex-buildBowerComponentsDefault-4">

     

       166
       166
       -
            <para>

     

       167
       167
       -
             The actual build command. Other tools could be used.

     

       168
       168
       -
            </para>

     

       169
       169
       -
           </callout>

     

       170
       170
       -
          </calloutlist>

     

       171
       171
       -
         </para>

     

       172
       172
       -
        </section>

     

       173
       173
       -
       

     

       174
       174
       -
        <section xml:id="ssec-bower2nix-troubleshooting">

     

       175
       175
       -
         <title>Troubleshooting</title>

     

       176
       176
       -
       

     

       177
       177
       -
         <variablelist>

     

       178
       178
       -
          <varlistentry>

     

       179
       179
       -
           <term>

     

       180
       180
       -
            <literal>ENOCACHE</literal> errors from <varname>buildBowerComponents</varname>

     

       181
       181
       -
           </term>

     

       182
       182
       -
           <listitem>

     

       183
       183
       -
            <para>

     

       184
       184
       -
             This means that Bower was looking for a package version which doesn't exist in the generated <filename>bower-packages.nix</filename>.

     

       185
       185
       -
            </para>

     

       186
       186
       -
            <para>

     

       187
       187
       -
             If <filename>bower.json</filename> has been updated, then run <command>bower2nix</command> again.

     

       188
       188
       -
            </para>

     

       189
       189
       -
            <para>

     

       190
       190
       -
             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>.

     

       191
       191
       -
            </para>

     

       192
       192
       -
           </listitem>

     

       193
       193
       -
          </varlistentry>

     

       194
       194
       -
         </variablelist>

     

       195
       195
       -
        </section>

     

       196
       196
       -
       </section>

+1 -1

doc/languages-frameworks/index.xml

···

       8
       8
        
        <xi:include href="agda.section.xml" />

     

       9
       9
        
        <xi:include href="android.section.xml" />

     

       10
       10
        
        <xi:include href="beam.section.xml" />

     

       11
       11
       -
        <xi:include href="bower.xml" />

     

       11
       11
       +
        <xi:include href="bower.section.xml" />

     

       12
       12
        
        <xi:include href="coq.section.xml" />

     

       13
       13
        
        <xi:include href="crystal.section.xml" />

     

       14
       14
        
        <xi:include href="emscripten.section.xml" />