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

wirecloud-config-parser

v0.2.6

Published

Parser for WireCloud's components config file

Downloads

22

Readme

Node Wirecloud Config Parser

Parser for a Wirecloud Mashable Application Component's config file.

Getting started

This parser can be installed via npm with this command:

npm install wirecloud-config-parser --save

Examples

This parser takes an xml Wirecloud config file and returns a javascript object containing all data in it.

Initialization

Before trying to get any data, the library must be imported and the parser object created. There are two ways of creating a parser object. One is to pass a path as parameter to the constructor and the parser will read and parse the file indicated by the path:

var Parser = require('wirecloud-config-parser');
var configParser = new Parser('path/to/file');

And the other is to give it an options object where you can specify either a path or directly the contents of a config file, as well as an option to validate the xml while building the object:

var Parser = require('wirecloud-config-parser');
var content = fs.readFileSync('path/to/file').toString();
var configParser = new Parser({content: content, validate: true});

NOTE: If you give both the path and the content options in the object the parser will read from the file given in the path

Validate

Whether you have validated the XML content while building the object or not, you can use the validate function later to test if the XML complies with Wirecloud's schema:

configParser.validate();
// it should return true or false

NOTE: You can see all validation error that occurred in configParser.data.validationErrors.

Retrieve data

The data can be retrieved using the getData function:

configParser.getData();

This function returns an object containing the config file data:

{
    name: 'some-name',
    vendor: 'some-vendor',
    version: '0.0.1',
    type: 'widget'
}

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)