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

modjulie

v1.0.3

Published

api for dynamic library generation

Downloads

15

Readme

Ali G and mejulie

Modjulie

Build Status npm version

Modjulie is a server for building a library dynamically where required parts are added in the path and query string params of a http request.

It is heavily inspired by the work done by the financial times polyfill io service

Install

npm i modjulie --save

Usage

Quickstart

In order to get something serving you can use the example folder structure that has been set up and familiarise yourself with where everything goes before customising.

First create a symlink in your project directory to the example server folders

ln -s node_modules/modjulie/example/ ./example

create your server file

//index.js

const Modjulie = require( 'modjulie' );
const server = new Modjulie();
server.serve();

then run node index.js and you can access http://localhost:3000/v1/default?modules=moduleC to see the generated output

you can also take a look at example.index.html for how it is called from a script url in a page

Customisation

Modjulie defines a folderstructure as follows

Structure

versionsDirectory
├── v1
│   ├── headers (defaultHeaderSources)
│   │   ├── loader.json
│   │   └── namespace.js
│   ├── modules (moduleSourcesDirectory)
│   │   ├── moduleA
│   │   │   └── module.js
│   │   ├── moduleB
│   │   │   └── module.js
│   │   └── moduleC
│   │       └── module.js
│   └── presets (presetConfigurationDirectory)
│       └── default.json
Headers

This directory contains files that are added to the library regardless of other config at all times, use this to set up namespaces or do other base configuration

Modules

The modules directory contains folders with a module name and a module.js file within that contains the module code

Presets

presets define sets of modules that can be aliased to a name

these folders relate to the url structure as follows

/:version/:preset?modules=moduleA

where version is mandatory but the preset is optional

for example

/v1/default?modules=moduleA

Configs

The preset (presetConfigurationDirectory) json files each define a json array of module names that should be included as part of the package when the preset is used, for example;

[ "moduleA", "moduleB" ]

The headers (defaultHeaderSources) loader.json file works in a similar way but allows you to define the load order of your headers

[ "namespace.js", "init.js" ]