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

plantuml-file-loader

v2.0.0

Published

A webpack loader to convert PlantUML source files into image files (for web pages, web-slideshows).

Downloads

22

Readme

Converts PlantUML files into images during the webpack processing.

The image conversion is inspired by the Yury Korolev's plantuml-loader which uses a dockerized version of PlantUML, which includes GraphViz for the image generation. However this loader:

  • uses ES6 syntax
  • involves non-blocking methods and abstractions (streams and buffers) to perform the generation
  • produces image files instead of returning the generated file content (that may come later as an option if needed)

Installation

Install the plantuml-file-loader:

# via yarn
yarn add -D webpack plantuml-file-loader

# via npm
npm i -D webpack plantuml-file-loader

In your webpack.config.js file:

module.exports = {
  // ...
  module: {
    rules: [
      // ...
      {
        test: /\.p?uml$/,
        use: 'plantuml-file-loader?format=svg&outputPath=img/'
      },
      // ...
    ]
  },
  // ...
}

The format can be any of those supported by PlantUML: see the -t formats in the command-line Help section.

Use cases

Requirements

The loader spawns a docker container to which it delegates the image conversion. Therefore:

Web-based slideshows

Combine this loader with the markdown-image-loader to build slideshows based on markdown documents. In your markdown file, simply refer to PlantUML source files and they will be converted into images (in SVG format by default, which can be zoomed-in without aliasing).

  • the my-class-diagram.puml PlantUML file:
@startuml
class Car

Driver - Car : drives >
Car *- Wheel : have 4 >
Car -- Person : < owns

@enduml
  • your slideshow.md markdown document:
# Class-diagram slide

The class diagram is as follows:

![](img/my-class-diagram.puml)

And the diagram will be displayed as a real image in your slideshow:

Unit tests

Unit tests can be run with the npm test command.

Despite these efforts, should you find an issue or spot a vital feature, you are welcome to report bugs and submit code requests!

Changelog

  • 2.0.0: updated for webpack 4.x (see modifications done on the loader's option and context)
  • 1.0.3: screenshot fix
  • 1.0.2: added: screenshot of class-diagram slide demo, docker requirements
  • 1.0.1: link fix in README.md
  • 1.0.0: initial version for webpack 3.x

License

May be freely distributed under the MIT license.

Copyright (c) 2017-2018 Luc Sorel