| 1 | # Django Apps Jest Mapper
|
| 2 | [](https://github.com/ellerbrock/open-source-badges/)
|
| 3 | [](https://github.com/marinko-peso/django-apps-jest-mapper/blob/master/LICENSE)
|
| 4 | [](https://github.com/Flet/semistandard)
|
| 5 | [](https://npm.im/django-apps-jest-mapper)
|
| 6 | [](https://packagephobia.now.sh/result?p=django-apps-jest-mapper)
|
| 7 | [](https://david-dm.org/marinko-peso/django-apps-jest-mapper)
|
| 8 | [](https://codecov.io/gh/marinko-peso/django-apps-jest-mapper)
|
| 9 |
|
| 10 | Automatically discovery django apps and map jest names for them.
|
| 11 |
|
| 12 | ## Why?
|
| 13 |
|
| 14 | If you need to start using Jest combined with Webpack on a Django organized project this package can work great together with [django-apps-webpack-alias](https://npm.im/django-apps-webpack-alias). Static files are usually organized per Django app, and communication between them using relative paths can soon become messy.
|
| 15 | This way you can generate same Webpack alias for all Django apps automatically and follow the same naming in the jest configuration.
|
| 16 |
|
| 17 |
|
| 18 | ## Install
|
| 19 |
|
| 20 | ```ssh
|
| 21 | npm i -D django-apps-jest-mapper
|
| 22 | ```
|
| 23 |
|
| 24 |
|
| 25 | ## Running
|
| 26 |
|
| 27 | ```js
|
| 28 | const djangoAppsMapper = require('django-apps-jest-mapper');
|
| 29 |
|
| 30 | // in jest moduleNameMapper config just spread it (or Object.assign with other entries)
|
| 31 | moduleNameMapper: {
|
| 32 | ...djangoAppsMapper({ options })
|
| 33 | },
|
| 34 | ```
|
| 35 |
|
| 36 | Available options:
|
| 37 | - dir [default 'apps'] path to directory holding the apps
|
| 38 | - prefix [default '@app:'] each app prefix, for instance for auth app it will generate ``` @app:auth ```
|
| 39 |
|
| 40 | All mappings point to app/static/app/js directory for each app.
|
| 41 |
|
| 42 |
|
| 43 | ## License
|
| 44 |
|
| 45 | MIT.
|
| 46 | |
| \ | No newline at end of file |