Have ideas to improve npm?Join in the discussion! »

    plutt
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.10 • Public • Published

    Plutt logo

    Plutt: Safe micro frontends without the hassle

    Version Downloads/week License

    🗒 Description

    Plutt is a build tool that enables developers to generate micro frontends from framework-native components and to serve them version safely. The micro frontends are automatically safe to use in production if they work during development.

    ✨ Features

    • Access Transparency: Consuming applications use the micro frontends as regular components, without having to know that it is a micro frontend.
    • Automatic Version Safety: At run-time Plutt will always upgrade to the latest version of a micro frontend, as long as it is non-breaking. This is done by supporting lock-step deployments.
    • Framework Agnostic: Plutt applications can be consumed by any framework. Currently Plutt supports React and Vue, but it is easy to extend Plutt to support more frameworks.
    • Type Safety: Micro frontends can be consumed with type safety. Any props that are used incorrectly can be found at compile-time.

    🏗 Usage

    $ npm install -g plutt
    $ plutt COMMAND
    running command...
    $ plutt (-v|--version|version)
    plutt/2.0.10 linux-x64 node-v12.16.3
    $ plutt --help [COMMAND]
    USAGE
      $ plutt COMMAND
    ...

    📚 Examples

    All examples are located at Plutt Examples Collection.

    🔍 How Plutt Works

    Plutt is a build tool that enables developers to generate micro frontends from framework-native components and to serve them version safely. Plutt takes a framework-native component as input and outputs two types of artifacts: a Plutt Application (composed of the original Component and a Wrapper) and a Proxy. To serve Plutt applications, Plutt provides a Plutt Server.

    You can use only a Plutt Application, but to get most benefits you should use the provided Proxy and Plutt Server.

    Plutt Architecture

    Plutt Application

    A Plutt application is a self-contained micro frontend application that exposes functions for mounting with properties, updating the properties, and unmounting. Plutt applications are stored on a Plutt server and accessed in run-time, to ensure that the latest version is consumed.

    Proxy

    A proxy is a framework-native component that knows how to fetch and mount a corresponding Plutt application. Plutt generates one proxy per supported framework, which currently is React and Vue. Proxies integrate into a parent application during compile-time. Proxies do not include any business logic, but they do include everything required to safely consume a Plutt application. Proxies fetch a specific version of a Plutt application which can be verified at compile-time to be non-breaking. If the Plutt application is typed, the proxy is also typed, and static analysis can be used to indicate if a Plutt application is integrated correctly.

    Plutt Server

    Plutt applications are stored on a Plutt server, which is where dependents fetch Plutt applications from. Plutt server upgrade requests to Plutt applications so that dependents receive the latest non-breaking version. Semantic versioning is used to ensure that the upgraded version is non-breaking. This way, the team that provides a micro frontend is responsible for deciding when to update to production, while ensuring that updates do not break dependent applications. Dependent teams own the decision of when to upgrade breaking versions. Plutt server provides every team with the correct responsibilities that facilitate independent deployments.

    🔨 Commands

    plutt build

    Build a plutt app.

    USAGE
      $ plutt build
    
    OPTIONS
      -s, --sourceDirectory=sourceDirectory  [default: src] Source directory for the plutt app.
      -v, --verbose                          Prints extra information. Useful for debuging.
    
    DESCRIPTION
      Build a plutt app.
    
      Make sure that there exists a src/ directory with an index.js.
    

    See code: lib/commands/build.js

    plutt help [COMMAND]

    display help for plutt

    USAGE
      $ plutt help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    plutt serve [DIRECTORY]

    Serve a plutt app.

    USAGE
      $ plutt serve [DIRECTORY]
    
    ARGUMENTS
      DIRECTORY  [default: .] Directory to serve plutt apps from
    
    OPTIONS
      -p, --port=port  [default: 5000] Port used to serve plutt app
    

    See code: lib/commands/serve.js

    🐢 Learn More

    This project is developed together with a thesis, that will finish this summer. A link to the thesis will be published here when the thesis is finished.

    Install

    npm i plutt

    DownloadsWeekly Downloads

    1

    Version

    2.0.10

    License

    Apache-2.0

    Unpacked Size

    74.4 kB

    Total Files

    38

    Last publish

    Collaborators

    • avatar