Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 4.85 KB

README.md

File metadata and controls

115 lines (81 loc) · 4.85 KB
Raw

elm-symfony-bridge

Build Status contributions welcome webpack plugin vite plugin

Webpack and Vite plugin exposing Symfony's translations and routing to Elm. The translations are available through the Trans.<domain> Elm module and the routing is available through the Routing Elm module.

For more information see Webpack or Vite specific documentation.

Table of content

Quick Start

Translations are exposed using the Trans.<domain> module like following:

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:

import Http
import Routing

makeHttpCall : Cmd msg
makeHttpCall =
    Http.get
        { url = Routing.app_get_this_plugin
        , expect = Http.expectString MsgGetThisPlugin
        }

Usage

See Usage.

Versioning

elm-symfony-bridge follows semantic versioning. 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: 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: 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: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" 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.

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:

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

# 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 for details.