Skip to content

VladimirMikulic/parcel-plugin-custom-dist-structure

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

24 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

parcel-plugin-custom-dist-structure

Version Downloads License: MIT Twitter: VladoDev

๐Ÿš€ Parcel plugin that allows you to specify a custom dist structure.

๐Ÿ“ฆ Installation

# Installs the plugin and saves it as a development dependency
npm i parcel-plugin-custom-dist-structure --save-dev

โ˜๏ธ Usage

After you've installed the plugin, you'll need to specify configuration for it in package.json.

The plugin configuration is very simple, but also very flexible.

It will generate the structure you specify in the configuration object while also handle all your imports (css, images, js...) which makes it suitable for all use cases, from simple websites all the way to complex React/Angular/Vue projects.

Example configuration object in package.json:

"customDistStructure": {
  "config": {
    // Output JS files to dist/js folder
    ".js": "js",
    // Output JPG and PNG files to dist/images folder
    "images": [
      ".jpg",
      ".png"
    ],
    // General idea
    ".fileExtension": "folder/in/dist",
    "folder/in/dist": [ ".file", ".extensions" ]
  },
  "options": {
    // Enable plugin in development mode (default: false)
    "development": true
  }
}

โœจ Run tests

The plugin uses Jest for running tests.

Jest will execute all .test.js files in the test folder.

npm test

๐Ÿ‘จ Author

Vladimir Mikulic

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!

๐Ÿ“ License

This project is licensed under MIT license.

๐Ÿ‘จโ€๐Ÿš€ Show your support

Give a โญ๏ธ if this project helped you!