Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastian-software/babel-plugin-smart-webpack-import
Making webpack imports smarter by injecting additional features dynamically. Goal: Make import() more user-friendly.
https://github.com/sebastian-software/babel-plugin-smart-webpack-import
Last synced: about 2 months ago
JSON representation
Making webpack imports smarter by injecting additional features dynamically. Goal: Make import() more user-friendly.
- Host: GitHub
- URL: https://github.com/sebastian-software/babel-plugin-smart-webpack-import
- Owner: sebastian-software
- License: apache-2.0
- Created: 2018-05-14T12:15:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:34:00.000Z (over 1 year ago)
- Last Synced: 2024-07-05T08:29:46.161Z (3 months ago)
- Language: JavaScript
- Size: 3.28 MB
- Stars: 46
- Watchers: 4
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome - babel-plugin-smart-webpack-import - Making webpack imports smarter by injecting additional features dynamically. Goal: Make import() more user-friendly. (JavaScript)
README
# Smart Webpack Import
[![Sponsored by][sponsor-img]][sponsor] [![Version][npm-version-img]][npm] [![Downloads][npm-downloads-img]][npm] [![Build Status Unix][travis-img]][travis] [![Build Status Windows][appveyor-img]][appveyor]
[sponsor-img]: https://img.shields.io/badge/Sponsored%20by-Sebastian%20Software-692446.svg
[sponsor]: https://www.sebastian-software.de
[npm]: https://www.npmjs.com/package/babel-plugin-smart-webpack-import
[npm-downloads-img]: https://img.shields.io/npm/dm/babel-plugin-smart-webpack-import.svg
[npm-version-img]: https://img.shields.io/npm/v/babel-plugin-smart-webpack-import.svg
[travis-img]: https://img.shields.io/travis/sebastian-software/babel-plugin-smart-webpack-import/master.svg?branch=master&label=unix%20build
[appveyor-img]: https://img.shields.io/appveyor/ci/swernerx/babel-plugin-smart-webpack-import/master.svg?label=windows%20build
[travis]: https://travis-ci.org/sebastian-software/babel-plugin-smart-webpack-import
[appveyor]: https://ci.appveyor.com/project/swernerx/babel-plugin-smart-webpack-import/branch/master
Smart Webpack Import has the goal to improve the developer experience when working with so-called dynamic `import()` statements.
## Features
- Automatic chunk names for all imports.
- Respects existing chunk names and keeps them.
- Keeps other magic comments from Webpack in-tact while adding our ones.
- Uses hashes on requester to prevent collisions for identically named imports.
- Works together with [Loadable Components](https://www.smooth-code.com/open-source/loadable-components/) and (other code-splitting SSR solutions).
## Installation
```
npm i -D babel-plugin-smart-webpack-import
```
## Usage
```js
"plugins": [
"babel-plugin-smart-webpack-import"
]
```
Use it together with your favorite code splitting library:
```js
"plugins": [
"babel-plugin-smart-webpack-import",
"@loadable/babel-plugin"
]
```
Hash suffixes can be disabled by passing `hashes: false` option:
```js
"plugins": [
["babel-plugin-smart-webpack-import", { hashes: false } ]
]
```
In this case it is developer's responsibility to ensure that there are no
collisions between identically named imports.
## Example
### Basic
```js
import('./HelloView')
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackChunkName:'HelloView-zy9ks'*/
'./HelloView');
```
### Keeps Prefetch
```js
import(/* webpackPrefetch: true */ './HelloView')
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackPrefetch:true,webpackChunkName:'HelloView-zy9ks'*/
'./HelloView');
```
### Shortens Paths
```js
import('./views/admin/SettingsView')
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackChunkName:'SettingsView-ijYnC'*/
'./views/admin/SettingsView');
```
### Supports query-based imports
```js
import(`./views/${name}`)
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackChunkName:'views-[request]-njvjH'*/
`./views/${name}`);
```
### Shortens query-based imports
```js
import(`./app/views/${name}`)
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackChunkName:'views-[request]-xkLem'*/
`./views/${name}`);
```
### Same as Basic, but with `{ hashes: false }` option
```js
import('./HelloView')
↓ ↓ ↓ ↓ ↓ ↓
import(
/*webpackChunkName:'HelloView'*/
'./HelloView');
```
## Comments
To make this work it's important that your Babel setup keeps comments in-tact as the information
required is carryied over to Webpack via so-called magic comments.
This module exports an additional helper function called `shouldPrintComment` to make this work more easily. It keeps Webpack's Magic Comments and "Pure" markers for Uglify compression. You can pass it over to your Babel config like this:
```js
import { shouldPrintComment } from "babel-plugin-smart-webpack-imports"
export default {
presets: [...],
plugins: [...],
shouldPrintComment
}
```
Please not that this only works in a JS environment e.g. an exported Rollup or Webpack config. A plain `.babelrc` is not capable of declaring functions or even importing code. With Babel v7 your can use a `.babelrc.js` file as well.
## License
[Apache License Version 2.0, January 2004](license)
## Copyright
Copyright 2018-2020
[Sebastian Software GmbH](http://www.sebastian-software.de)