https://github.com/marinko-peso/django-apps-jest-mapper

:snake: Automatically discovery django apps and map jest names for them.
https://github.com/marinko-peso/django-apps-jest-mapper

Last synced: 27 days ago
JSON representation

:snake: Automatically discovery django apps and map jest names for them.

• Host: GitHub
• URL: https://github.com/marinko-peso/django-apps-jest-mapper
• Owner: marinko-peso
• License: mit
• Created: 2018-06-14T11:56:28.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T03:13:30.000Z (about 2 years ago)
• Last Synced: 2025-03-14T02:40:01.532Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 1000 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Apps Jest Mapper

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

[![license](https://img.shields.io/github/license/marinko-peso/django-apps-jest-mapper.svg)](https://github.com/marinko-peso/django-apps-jest-mapper/blob/master/LICENSE)

[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/Flet/semistandard)

[![package version](https://img.shields.io/npm/v/django-apps-jest-mapper.svg)](https://npm.im/django-apps-jest-mapper)

[![install size](https://packagephobia.now.sh/badge?p=django-apps-jest-mapper)](https://packagephobia.now.sh/result?p=django-apps-jest-mapper)

[![dependecies](https://david-dm.org/marinko-peso/django-apps-jest-mapper.svg)](https://david-dm.org/marinko-peso/django-apps-jest-mapper)

[![codecov](https://codecov.io/gh/marinko-peso/django-apps-jest-mapper/branch/master/graph/badge.svg)](https://codecov.io/gh/marinko-peso/django-apps-jest-mapper)

Automatically discovery django apps and map jest names for them.

## Why?

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.

This way you can generate same Webpack alias for all Django apps automatically and follow the same naming in the jest configuration.

## Install

```ssh

npm i -D django-apps-jest-mapper

```

## Running

```js

const djangoAppsMapper = require('django-apps-jest-mapper');

// in jest moduleNameMapper config just spread it (or Object.assign with other entries)

moduleNameMapper: {

    ...djangoAppsMapper({ options })

},

```

Available options:

- dir [default 'apps'] path to directory holding the apps

- prefix [default '@app:'] each app prefix, for instance for auth app it will generate ``` @app:auth ```

All mappings point to app/static/app/js directory for each app.

## License

MIT.