inveniosoftware / flask-webpackext Goto Github PK

View Code? Open in Web Editor NEW

11.0 91.0 10.0 71 KB

Webpack integration for Flask.

Home Page: https://flask-webpackext.readthedocs.io

License: Other

Python 97.79% Shell 1.04% JavaScript 1.16%

flask-webpackext's Introduction

Flask-WebpackExt

Webpack integration for Flask.

Flask-WebpackExt makes it easy to interface with your existing Webpack project from Flask and does not try to manage Webpack for you. Flask-WebpackExt does this via:

Manifests: You tell Webpack to write a manifest.json using plugins such as webpack-manifest-plugin, webpack-yam-plugin or webpack-bundle-tracker. Flask-WebpackExt reads the manifest and makes your compiled assets available in your Jinja templates.
CLI for NPM: Flask-WebpackExt provides a Flask CLI so that e.g. flask webpack install will run npm install in your Webpack project. Similarly, flask webpack build will run npm run build.

Optionally you can use Flask-WebpackExt to also:

Inject configuration: Flask-WebpackExt will write a config.json into your Webpack project, which you can import in your Webpack configuration. You define what goes in the config e.g. Let Webpack know about output paths or dynamic entry points.
Collect bundles: If your Webpack project is spread over multiple Python packages, Flask-WebpackExt can help you dynamically assemble the files into a Webpack project. This is useful if you don't know until runtime which packages are installed.

Further documentation is available on https://flask-webpackext.readthedocs.io/

flask-webpackext's People

Contributors

Stargazers

Watchers

Forkers

lnielsen pferreir ntarocco chiarabi diegodelemos okraskaj topless bassofbass utnapischtim psaiz

flask-webpackext's Issues

docs: add usage docs

Currently, usage docs are missing.

manifest: warn/error not shown when missing key in the loaded manifest

Due to some misconfigurations on Webpack, CSS bundles were not being generated and Flask-WebpackExt loaded the asset-manifest (which didn't include CSS) and it didn't fail or warned about these missing keys in the loaded manifest.

test: fix build errors

See https://travis-ci.org/github/inveniosoftware/flask-webpackext

Add tests

global: new release

CLI chaining support for install and build

You can already chain e.g. flask webpack create install like this, but you cannot chain other commands after install or build, e.g. you can't flask webpack create install build.

This is because we accept arbitrary options after install which is passed to NPM.

Would be nice if there was a way to allow flask webpack create install build

Add documentation

Add flask-flavour of WebpackBundle

Similar to WebpackProject has a flask flavour we should also add a WebpackBundle with a flask flavour.

"Usage" page of documentation is outdated

Describe the bug

When i tried to follow the steps described in the documentation (usage page) i was facing following error while building the assets:

> webpack --config webpack.config.js

[webpack-cli] TypeError: Cannot read property 'length' of undefined
    at /home/fwoerister/PycharmProjects/webpack/instance/assets/node_modules/webpack-manifest-plugin/lib/plugin.js:129:39
    at Array.reduce (<anonymous>)
    at ManifestPlugin.<anonymous> (/home/fwoerister/PycharmProjects/webpack/instance/assets/node_modules/webpack-manifest-plugin/lib/plugin.js:116:26)
    at Hook.eval [as callAsync] (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:9:1)
    at Hook.CALL_ASYNC_DELEGATE [as _callAsync] (/usr/lib/node_modules/webpack/node_modules/tapable/lib/Hook.js:18:14)
    at Compiler.emitAssets (/usr/lib/node_modules/webpack/lib/Compiler.js:862:19)
    at /usr/lib/node_modules/webpack/lib/Compiler.js:450:10
    at processTicksAndRejections (internal/process/task_queues.js:77:11)

Steps to Reproduce

Following the steps described on the "usage" page of the documentation.

Expected behavior

The assets should be built without error

Additional context

After some investigation I realized that this error was a known issue, that was fixed in a more recent version of the plugin. I also found out that in the more recent versions the plugin class was renamed from "ManifestPlugin" to "WebpackManifestPlugin" which has to be fixed in the webpack config as well.

global: fix release missing PyPI key

Flask-WebpackExt new release failed since PyPI key was missing in .travis.yml.

pypi: v1.0.1 not released on PyPI

https://pypi.org/project/flask-webpackext/#history