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

id-presets-builder

v2.0.1

Published

Build iD presets

Downloads

45

Readme

id-presets-builder

npm version js-standard-style

Build preset files for iDEditor

Will take a collection of iD preset, field and category definition files, verify that the schema is correct and definitions are valid, and builds a preset file, translations, and a YAML file for translation. Useful for deploying iD Editor with custom preset files.

Table of Contents

Install

$ npm install --global id-presets-builder

Usage

$ id-presets build

Looks for iD preset files in ./presets/, field files in ./fields/, categories in ./categories/ and defaults in ./defaults.json. Please see the iD Presets README.md for details about iD presets. Outputs presets.json, translations.json and translate.yaml in ./build/.

$ id-presets lint

Lints the presets files without writing anything.

API

var presetsBuilder = require('id-presets-builder')

presetsBuilder.generatePresets([dir], callback)

Looks for preset, field and category files in dirs ${dir}/presets/, ${dir}/fields/, ${dir}/categories/ and ${dir}/defaults.json. dir defaults to process.cwd(). Callback is called with a presets object:

{
  presets: {...},
  categories: {...},
  fields: {...},
  defaults: {...}
}

presetsBuilder.generateTranslations(categories, fields, presets)

Generates an object of localized names for presets that can be used in iD editor for localized names of presets in the UI.

presetsBuilder.generateTranslate(fields, presets, translations)

Generates a translate object that defines preset terms that need translation, for use in transifex or similar localization platform.

Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Gregor MacLennan / Digital Democracy