Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RomainLanz/adonis-bundler
Blazing fast, zero configuration assets bundler for AdonisJS
https://github.com/RomainLanz/adonis-bundler
adonis assets bundler pipeline zero-configuration
Last synced: 11 days ago
JSON representation
Blazing fast, zero configuration assets bundler for AdonisJS
- Host: GitHub
- URL: https://github.com/RomainLanz/adonis-bundler
- Owner: RomainLanz
- License: mit
- Archived: true
- Created: 2018-02-26T10:10:01.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2018-06-17T08:35:52.000Z (over 6 years ago)
- Last Synced: 2024-10-27T16:09:48.584Z (16 days ago)
- Topics: adonis, assets, bundler, pipeline, zero-configuration
- Language: JavaScript
- Homepage:
- Size: 115 KB
- Stars: 19
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-blazingly-fast - adonis-bundler - Blazing fast, zero configuration assets bundler for AdonisJS (JavaScript)
README
# adonis-bundler
Adonis Bundler is the simpliest assets bundler you could ever found for an Adonis application.
It's based on [ParcelJS](https://parceljs.org/) which is a blazing fast, zero configuration web application bundler.
## Getting Started
This package should be installed with the Adonis CLI.
```shell
$ adonis install adonis-bundler
```
Then register the Service Provider within your `start/app.js` file.
```js
const providers = [
'adonis-bundler/providers/BundlerProvider',
]
```
You are now ready to go!
## Bundle the assets
By default `adonis-bundler` look at files stored within your `resources/assets` folder and check for file with the pattern `*/app.*`. That means, all the file within your `resource/assets/XXX` folder named `app.XXX` will be bundled.
After creating your assets in the way you want (Less, SCSS, Stylus, ES2015, ...) you simply need to run the command below and the magic will happen.
```shell
$ adonis bundle
# adonis bundle --watch -> Watch for change
# adonis bundle --production -> Minify
```
ParcelJS will automaticaly download packages you need to compiles your assets and will then run them.
## Config
The config file is save as `config/bundle.js`. Make sure to tweak it as per your needs.
The bundler also check for `.babelrc`, `postcss.config.js` or whatever file your "language"/"transpiler" used by default to be configured to help you configure your assets the way you want.
## FAQ
**I want to do X and I cannot do it with this package**
You maybe want to do something that is out of the scope of this package. Don't worry, you aren't obligated to use it. This main goal of this package is to provide an easy way to compile assets for 90% of developper. Nothing keeps you from installing Webpack and doing a custom configuration.
**Is ParcelJS's plugins working with this package**
YES!
**How can I create an hash named compiled assets for production caching?**
Unfortunately, you cannot for the moment. [Some discussions are going on in ParcelJS repository](https://github.com/parcel-bundler/parcel/issues/872) and hopefully this will be possible soon.