Symlink Webpack Plugin
A webpack plugin to make symbolic links for emitted file.
Installation
npm i -D symlink-webpack-plugin
Usage
In your webpack config:
const SymlinkWebpackPlugin = require('symlink-webpack-plugin');
module.exports = {
plugins: [
new SymlinkWebpackPlugin({ origin: 'index.html', symlink: '200.html' })
]
};
This setting makes symbolic link file [ouput_path]/200.html
to [ouput_path]/index.html
.
By the way, this setting works well for client-side routing on surge.sh.
You can give configurations as Array
const SymlinkWebpackPlugin = require('symlink-webpack-plugin');
module.exports = {
plugins: [
new SymlinkWebpackPlugin([
{ origin: 'index.html', symlink: '200.html' },
{ origin: 'index.html', symlink: '404.html' },
])
]
};
force
option (default: false
)
const SymlinkWebpackPlugin = require('symlink-webpack-plugin');
module.exports = {
plugins: [
new SymlinkWebpackPlugin([
{ origin: 'index.html', symlink: '200.html', force: true },
{ origin: 'index.html', symlink: '404.html' },
])
]
};
The plugin doesn't make the symlink if the destination doesn't exist as default.
Passing the option force: true
, will create it regardless.
Development
yarn
yarn test
License
MIT License / Copyright (c) hmsk k.hamasaki@gmail.com