https://github.com/mdevlamynck/elm-symfony-bridge

Webpack and Vite plugin exposing symfony's translations and routing to elm.
https://github.com/mdevlamynck/elm-symfony-bridge

bridge elm plugin routing symfony tools translation vite vite-plugin webpack webpack-plugin

Last synced: about 1 month ago
JSON representation

Webpack and Vite plugin exposing symfony's translations and routing to elm.

• Host: GitHub
• URL: https://github.com/mdevlamynck/elm-symfony-bridge
• Owner: mdevlamynck
• License: mit
• Created: 2018-03-18T20:27:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T15:15:23.000Z (2 months ago)
• Last Synced: 2024-09-28T22:20:58.672Z (about 2 months ago)
• Topics: bridge, elm, plugin, routing, symfony, tools, translation, vite, vite-plugin, webpack, webpack-plugin
• Language: Elm
• Homepage:
• Size: 1.5 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# elm-symfony-bridge

[![Build Status](https://github.com/mdevlamynck/elm-symfony-bridge/actions/workflows/ci.yml/badge.svg)](https://github.com/mdevlamynck/elm-symfony-bridge/actions)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/mdevlamynck/elm-symfony-bridge/issues)

[![webpack plugin](https://img.shields.io/npm/v/elm-symfony-bridge?label=webpack%20plugin&logo=webpack%20plugin)](https://www.npmjs.com/package/elm-symfony-bridge)

[![vite plugin](https://img.shields.io/npm/v/vite-plugin-elm-symfony-bridge?label=vite%20plugin&logo=vite%20plugin)](https://www.npmjs.com/package/vite-plugin-elm-symfony-bridge)

Webpack and Vite plugin exposing Symfony's translations and routing to Elm.

The translations are available through the `Trans.` Elm module and the routing is available through the `Routing` Elm module.

For more information see [Webpack](webpack/README.md) or [Vite](vite/README.md) specific documentation.

## Table of content

* [Quick start](#quick-start)

* [Webpack](webpack/README.md)

    - [Installation](webpack/README.md#Installation)

    - [Configuration](webpack/README.md#Configuration)

* [Vite](vite/README.md)

    - [Installation](vite/README.md#Installation)

    - [Configuration](vite/README.md#Configuration)

* [Usage](doc/Usage.md)

* [Versioning](#versioning)

* [Contributing](#contributing)

* [Hacking](#Hacking)

* [License](#License)

## Quick Start

Translations are exposed using the `Trans.` module like following:

```elm

import Trans.Messages as Messages

import Trans.Security as Security

displayStuff : Html msg

displayStuff =

    div [] [ text Messages.alert_awesome_plugin ]

    div [] [ text Security.global_must_have ]

```

The routing is exposed using the `Routing` module like following:

```elm

import Http

import Routing

makeHttpCall : Cmd msg

makeHttpCall =

    Http.get

        { url = Routing.app_get_this_plugin

        , expect = Http.expectString MsgGetThisPlugin

        }

```

## Usage

See [Usage](doc/Usage.md).

## Versioning

elm-symfony-bridge follows [semantic versioning](https://semver.org/). In short the scheme is MAJOR.MINOR.PATCH where

1. MAJOR is bumped when there is a breaking change,

2. MINOR is bumped when a new feature is added in a backward-compatible way,

3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

## Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

* [Bug Reports](https://github.com/mdevlamynck/elm-symfony-bridge/issues): While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!

* [Feature Request](https://github.com/mdevlamynck/elm-symfony-bridge/issues): You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.

* [Pull Request](https://github.com/mdevlamynck/elm-symfony-bridge/pulls): Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as [documentation](https://help.github.com/articles/about-pull-requests/) on pull requests. We use the ["fork and pull model"](https://help.github.com/articles/about-collaborative-development-models/) were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch.

As a reminder, all contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Hacking

The sources are organized in 3 main folders:

* `/lib` contains the common js and elm code: `src` for the sources and `tests` for the elm tests.

* `/webpack` contains all the specifics for the webpack plugin.

* `/vite` contains all the specifics for the vite plugin.

This project uses the following tools for development:

* [yarn](https://yarnpkg.com/)

* [elm](https://elm-lang.org/)

* [elm-test](https://github.com/rtfeldman/node-test-runner)

* [elm-verify-examples](https://github.com/stoeffel/elm-verify-examples)

You'll find the following commands useful when hacking on this project:

```bash

# install dependencies for the whole workspace

yarn install

# build the common lib and all plugins

yarn build-all

# build the common lib and a specific plugin

yarn build-vite    # for vite plugin

yarn build-webpack # for webpack plugin

# you can now use the yarn link feature or

# yarn install the .tgz generated in the plugin folder

```

## License

elm-symfony-bridge is distributed under the terms of the MIT license.

See [LICENSE](LICENSE.md) for details.