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

@overlayed-app/contributes

v1.3.0

Published

parse JSONSchema contribution entries, and validate data against them

Downloads

11

Readme

contributes

Build Status Coverage Status

Parse JSONSchema contribution entries, and validate data against them ✔️

Why

Overlayed makes use of a common format for defining settings as an extension author. It's very similar to the vscode configuration contribution point, so if you're familiar with that you'll understand this easily. This module is specifically designed to allow one to work with this schema - to enumerate expected settings (and what they're for) and to validate settings objects.

How

npm i @overlayed-app/contributes

Then in code (if js):

const contributes = require('@overlayed-app/contributes')

// load a schema (validating it's legit too)
const contrib = contributes
  .from('path/to/package.json/with/contributes/section')

// get the title for these settings
const title = contrib.title 

// get the settings data objects (describing each setting)
const data = contrib.data

// access one particular setting
const mySetting = data[0]

// prints '{name: 'mySetting', type: 'string', default: 'hi mom', description: 'your setting' }'
console.log(mySetting)

or (if ts):

import contributes from '@overlayed-app/contributes'

// load a schema (validating it's legit too)
const contrib = contributes
  .from('path/to/package.json/with/contributes/section')

// get the title for these settings
const title = contrib.title 

// get the settings data objects (describing each setting)
const data = contrib.data

// access one particular setting
const mySetting = data[0]

// prints '{name: 'mySetting', type: 'string', default: 'hi mom', description: 'your setting' }'
console.log(mySetting)

API

Create a contributes object from your package.json file:

// will throw if there's an error
const contrib = contributes.from('path/to/file')

This will validate that the included schema is legit, and then expose some ways to use the data.

To access the title, use title:

const title = contrib.title

To access the settings description data, as an array:

const data = contrib.data

You can use map to manipulate the data without pulling it out beforehand:

const names = contrib.map(entry => entry.data)

Note that each data entry contains the following data format:

{
  "name": "settingName, from the schema properties key",
  "description": "describing the settings purpose",
  "default": "a default value",
  "type": "string"
}

Where type is a valid json schema type.

If you wish to validate some settings object against the schema:

const settings = { settingName: 'settingValue' }

// will throw if there's an error
contib.validate(settings)

Note that when you validate settings objects, types may be coerced automatically to ensure consistency with the schema. If you wish to prevent this freeze your object.

Contributing

  • To build npm run build.
  • To publish npm run publish.
  • To test npm test.

Authors

Ben Greenier - Initial work - bengreenier

License

Contributes is licensed under the MIT License - Click here for details