Skip to content

Commit 640d6f0

Browse files
giftkugeleirslett
authored andcommitted
Bun added to documentation
1 parent 4a501a1 commit 640d6f0

File tree

1 file changed

+84
-20
lines changed

1 file changed

+84
-20
lines changed

README.md

Lines changed: 84 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -54,26 +54,40 @@ Include the plugin as a dependency in your Maven project. Change `LATEST_VERSION
5454
Have a look at the [example project](frontend-maven-plugin/src/it/example%20project),
5555
to see how it should be set up: https://github.com/eirslett/frontend-maven-plugin/blob/master/frontend-maven-plugin/src/it/example%20project/pom.xml
5656

57-
- [Installing node and npm](#installing-node-and-npm)
58-
- [Installing node and yarn](#installing-node-and-yarn)
59-
- [Installing node and corepack](#installing-node-and-corepack)
60-
- Running
61-
- [npm](#running-npm)
62-
- [yarn](#running-yarn)
63-
- [corepack](#running-corepack)
64-
- [bower](#running-bower)
65-
- [grunt](#running-grunt)
66-
- [gulp](#running-gulp)
67-
- [jspm](#running-jspm)
68-
- [karma](#running-karma)
69-
- [webpack](#running-webpack)
70-
- Configuration
71-
- [Working Directory](#working-directory)
72-
- [Installation Directory](#installation-directory)
73-
- [Proxy Settings](#proxy-settings)
74-
- [Environment variables](#environment-variables)
75-
- [Ignoring Failure](#ignoring-failure)
76-
- [Skipping Execution](#skipping-execution)
57+
- [frontend-maven-plugin](#frontend-maven-plugin)
58+
- [What is this plugin meant to do?](#what-is-this-plugin-meant-to-do)
59+
- [What is this plugin not meant to do?](#what-is-this-plugin-not-meant-to-do)
60+
- [Requirements](#requirements)
61+
- [Installation](#installation)
62+
- [Usage](#usage)
63+
- [Installing node and npm](#installing-node-and-npm)
64+
- [Installing node and yarn](#installing-node-and-yarn)
65+
- [Installing node and corepack](#installing-node-and-corepack)
66+
- [Installing bun](#installing-bun)
67+
- [Running npm](#running-npm)
68+
- [npx](#npx)
69+
- [Running yarn](#running-yarn)
70+
- [Yarn with Private Registry](#yarn-with-private-registry)
71+
- [Running corepack](#running-corepack)
72+
- [Running bower](#running-bower)
73+
- [Running Grunt](#running-grunt)
74+
- [Running gulp](#running-gulp)
75+
- [Running jspm](#running-jspm)
76+
- [Running Karma](#running-karma)
77+
- [Running Webpack](#running-webpack)
78+
- [Running bun](#running-bun)
79+
- [Optional Configuration](#optional-configuration)
80+
- [Working directory](#working-directory)
81+
- [Installation Directory](#installation-directory)
82+
- [Proxy settings](#proxy-settings)
83+
- [Environment variables](#environment-variables)
84+
- [Ignoring Failure](#ignoring-failure)
85+
- [Skipping Execution](#skipping-execution)
86+
- [Eclipse M2E support](#eclipse-m2e-support)
87+
- [Helper scripts](#helper-scripts)
88+
- [To build this project:](#to-build-this-project)
89+
- [Issues, Contributing](#issues-contributing)
90+
- [License](#license)
7791

7892
**Recommendation:** _Try to run all your tasks via npm scripts instead of running bower, grunt, gulp etc. directly._
7993

@@ -218,6 +232,34 @@ if you need to override the version of corepack in use.
218232
</plugin>
219233
```
220234

235+
### Installing bun
236+
237+
The version Bun is downloaded from https://github.com/oven-sh/bun/releases/download/, extracted and put into a `bun` folder created
238+
in your [installation directory](#installation-directory) . Bun will only be "installed" locally to your project.
239+
It will not be installed globally on the whole system (and it will not interfere with any Bun installations already
240+
present).
241+
242+
```xml
243+
<plugin>
244+
...
245+
<executions>
246+
<execution>
247+
<!-- optional: you don't really need execution ids, but it looks nice in your build log. -->
248+
<id>install bun</id>
249+
<goals>
250+
<goal>install-bun</goal>
251+
</goals>
252+
<!-- optional: default phase is "generate-resources" -->
253+
<phase>generate-resources</phase>
254+
</execution>
255+
</executions>
256+
<configuration>
257+
<!-- The version of Bun to install. IMPORTANT! Most Bun version names start with 'v', for example -->
258+
<bunVersion>v1.1.34</bunVersion>
259+
</configuration>
260+
</plugin>
261+
```
262+
221263
### Running npm
222264

223265
All node packaged modules will be installed in the `node_modules` folder in your [working directory](#working-directory).
@@ -518,6 +560,28 @@ will help to separate your frontend and backend builds even more.
518560
</execution>
519561
```
520562

563+
### Running bun
564+
565+
```xml
566+
<execution>
567+
<id>bun install</id>
568+
<goals>
569+
<goal>bun</goal>
570+
</goals>
571+
572+
<!-- optional: default phase is "generate-resources" -->
573+
<phase>generate-resources</phase>
574+
575+
<configuration>
576+
<!-- optional: The default argument is actually
577+
"install", so unless you need to run some other bun command,
578+
you can remove this whole <configuration> section.
579+
-->
580+
<arguments>install</arguments>
581+
</configuration>
582+
</execution>
583+
```
584+
521585
### Optional Configuration
522586

523587
#### Working directory

0 commit comments

Comments
 (0)