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

block-js

v0.2.5

Published

a gdd utility

Downloads

4

Readme

Block Js npm version license type npm downloads ECMAScript 6 & 5 js-standard-style

This is a work in progress in a early stage.

Block-js is an utility to get an array of blocks within a file with their contents, their name, the start and the end line.

A block is a set of lines that starts with a line with the format /* blockassignedname blockspecificname */ and ends with a line with the format /* endblockassignedname */

Let's see an es6 javascript example with a block that is called region:

const descriptionAsked = Symbol("descriptionAsked");
class Character {
	/* region constructor */
	constructor() {
		this.name = "Patoruzito";
		this.descriptionAsked = 0;
	}
	/* endregion */

	/* region privateMethods */
	[descriptionAsked]() {
		this.descriptionAsked++;
	}
	/* endregion */

	/* region publicProperties */
	get statistic() {
		return this.descriptionAsked;
	}

	get description() {
		this[descriptionAsked]();
		return `${this.name}: an Argentinian classic comic book character. Usa poncho.`;
	}
	/* endregion */

	/* region publicMethods */
	toJSON() {
		const name = this.name;
		const statistics = this.statistics;
		return {
			name,
			statistic
		};
	}
	/* endregion */
}

This is one example use case in which it can be used to create an IDE plugin to expand/collapse regions within a file so it can be easily read and organized. Also it can be used, for example, to interpolate blocks between files.

To parse that file we will do something like this:

import Blocks from "block-js";

const blocks = new Blocks("script.js", "region");
blocks.extractBlocks();
/*
this will output an array like this
[
	{
		from: 3,
		to: 8,
		name: "constructor",
		content: "...source code including special chars like \t or \n..."
	}, {
		...
	}, {
		...
	}
]
*/

Block-js will automatically detect comment delimiters for some file extensions, but it can be also specified as the third argument like this:

const blocks = new Blocks("script.js", "region", { start: "/*", end: "*/" });

Quality and Compatibility

Build Status Coverage Status bitHound Score Dependency Status Dev Dependency Status

Every build and release is automatically tested on the following platforms:

node 5.x node 6.x

Installation

Copy and paste the following command into your terminal to install Block-js:

npm install block-js --save

How to Contribute

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

For GDD-related service go here Or contact me to [email protected] for any business related thing or anything else.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using block-js on a platform we aren't automatically testing for.

npm test