npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-elm-symfony-bridge

v2.0.0

Published

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

Downloads

7

Readme

elm-symfony-bridge

Build Status contributions welcome vite plugin

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

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
        }

Installation

You can install the webpack plugin with npm or with yarn:

# NPM
npm install vite-plugin-elm-symfony-bridge --save-dev

# Yarn
yarn add vite-plugin-elm-symfony-bridge --dev

And you're all done!

Configuration

Setup example with symfony's webpack encore:

import { defineConfig } from "vite";
import symfonyPlugin from "vite-plugin-symfony";
import elmPlugin from 'vite-plugin-elm';
import elmSymfonyBridgePlugin from 'vite-plugin-elm-symfony-bridge';

export default defineConfig({
    plugins: [
        elmPlugin(),
        symfonyPlugin(),
        elmSymfonyBridgePlugin({
            outputFolder: './elm-stuff/generated-code/elm-symfony-bridge'
                                            // Optional: set the folder where to put intermediate build artifacts, defaults to './elm-stuff/generated-code/elm-symfony-bridge'
            projectRoot: './',              // Optional: root folder of your symfony project, defaults to './'
            elmRoot: './assets/elm',        // Optional: root folder of your elm code, defaults to './assets/elm'
            elmVersion: '0.19',             // Optional: elm version the generated code should be compatible with, defaults to '0.19', available '0.19' and '0.18'

            enableRouting: true,            // Optional: enable generating routes, defaults to true
            urlPrefix: '/index.php',        // Optional: when dev is true, which prefix to use when generating urls, defaults to '/index.php' (symfony >= 4 uses '/index.php', symfony < 4 '/app_dev.php')

            enableTranslations: true,       // Optional: enable generating translations, defaults to true
            lang: 'en',                     // Optional: lang to use when exporting translations, defaults to 'en'

            watchFolders: ['src', 'config', 'translations'],
                                            // Optional: which folders to watch for changes that might trigger changes in generated elm code, defaults to ['src', 'config', 'translations']
            watchExtensions: ['php', 'yaml', 'yml', 'xml'],
                                            // Optional: which file extensions to watch for changes that might trigger changes in generated elm code, defaults to ['php', 'yaml', 'yml', 'xml']

            envVariables: {                 // Optional: variables to replace during compile time, will also read env vars
                '%variable%': 'ENV_VAR'
            },
        }),
    ],
    build: {
        rollupOptions: {
            input: {
                app: "./assets/app.js"
            },
        }
    },
});

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

See the README at the root of the project for usefull information when hacking on this project.

License

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

See LICENSE for details.