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

jsonc-pragma

v1.0.8

Published

A simple, yet powerful pragma analyzer and utility library for JSON with Comments

Downloads

5

Readme

Installation

$ yarn add jsonc-pragma

or

$ npm install jsonc-pragma

Usage

scan()

@param contents

Type: string | Buffer

This is the contents of the JSON document.

@example

import { scan } from "jsonc-pragma";

const contents = `{
	// @foo bar=5
	"example": "...",

	// @baz foo=test bar=abc
	"object": {
		"example": "..."
	}
}`;

scan(contents);

/* Returns:

[
	{
		start: 2,
		end: 2,
		args: { bar: "5" },
		name: "foo"
	},
	{
		start: 5,
		end: 7,
		args: { foo: "test", bar: "abc" },
		name: "baz"
	}
] 

*/

@returns

Array<ISection>

comment()

@param contents

Type: string | Buffer

This is the contents of the JSON document.

@param selector

OPTIONAL

Type: (section: ISection) => boolean

This is a function that receives a section and determines whether that section should be commented by returning true (comment) or false (don't comment).

If omitted, all sections will be commented.

@example

import { comment } from "jsonc-pragma";

const contents = `{
	// @foo bar=5
	"example": "...",

	// @foo bar=7
	"object": {
		"example": "..."
	},

	// @baz bar=7
	"notCommented": "..."
}`;

comment(
	contents,
	section => section.name === "foo" && Number(section.args.bar) > 6
);

/* Returns:

`{
	// @foo bar=5
	"example": "...",

	// @foo bar=7
	// "object": {
	//   "example": "..."
	// },

	// @baz bar=7
	"notCommented": "..."
}`

*/

@returns string

uncomment()

@param contents

Type: string | Buffer

This is the contents of the JSON document.

@param selector

OPTIONAL

Type: (section: ISection) => boolean

This is a function that receives a section and determines whether that section should be uncommented by returning true (uncomment) or false (don't uncomment).

If omitted, all sections will be uncommented.

@example

import { uncomment } from "jsonc-pragma";

const contents = `{
	// @foo bar=5
	// "example": "...",

	// @foo bar=7
	// "object": {
	//   "example": "..."
	// }
}`;

uncomment(contents, section => Number(section.args.bar) > 6);

/* Returns:

`{
	// @foo bar=5
	// "example": "...",

	// @foo bar=7
	"object": {
		"example": "..."
	}
}`

*/

@returns string

@typedef

interface ISection {
	start: number;
	end: number;
	args: { [key: string]: string | undefined };
	name: string;
}