This project is still in alpha, so use the version displayed in the installation steps.

The listz package is used for the Listz organisation on GitHub to parse and validate the lists used in the webapplication.

Listz is a collection of repositories that represent a certain type of technology or subject. Each repository contains a list where GitHub users can add items by cloning and creating pull requests. Each list can be queried using the Listz app, which is still under development as of now.

A Listz is just a javascript object, conforming to a certain format. The serialized Listz object can be parsed by the listz-app, which users can use to explore the contents.

You can take a look at the listz.json file, which is a simple json string representing a Listz object containing one item.

Install the package in your project:

npm install [email protected]

To use it in your code:

let Listz = require("listz");

let newListz = new Listz();

let rawListz;

fs.readFile("./someListz.json", "utf8", (err, data) => {
    if (!err) rawListz = data;
});

console.log(Listz.isValid(rawListz));

let newListz;

fs.readFile("./someListz.json", "utf8", (err, data) => {
    if (!err) newListz = new Listz(data);
});

let validationResult;

fs.readFile("./someListz.json", "utf8", (err, data) => {
    if (!err) validationResult = Listz.validate(data);
});

console.log(validationResult.isValid);
console.log(validationResult.result);

Listz objects are actually just simple json objects, but we need these binaries to automate the validation. For instance, when a contributor adds a new list-item to a listz.json, we want to check if the serialized Listz object is still valid before allowing the pull request to be merged.

To checkout the Listz format, check out the listz.json file in the root of this repository.

Listz grows and is maintained by you, so if you want to update a listz, check out the CONTRIBUTING.md to see how!