block-js v0.2.5

Block Js

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

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

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 nicosommi@gmail.com 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