CI Intrepreter

CI, (Standing for Configuration Information) is a new type of variable storage which combines JSON and YML. It easily allows for comments, and mixed variable types whilst retaining ease of use and accessibility. As well as dynamic writing of new configuration options whilst maintaining the integrity of the other options (for plugin-type systems)

How it works

By reading your configuration file it can parse your configuration options into an easy to read Config Object. Once it's parsed, you can retrieve a specific key the loader. Using parsers, you can parse values during the read process into any object you'd like! See the Parsers section for more information.

Notes

CI files must be stored in .ci files.

Examples

    const Loader = require("CI-Intrepreter").Loader;
    Loader.Load("someIdentifier", "./fileName.ci");

    /**
     * You can choose from config files other than the default one using the overload Loader.GetOption(key, config).
     */
    console.log(Loader.GetConfig("someIdentifier").GetValue("someOptionHere"));

    /**
     * You can write new values into the config dynamically using one function call. It'll prevent you from writing duplicate values.
     */
    Load.GetConfig("someIdentifier").AppendValue("someKey","someValue", ["Some", "Comments", "Here"]);

    /**
     * You can also update values present-set values dynamically
     */
    Load.GetConfig("someIdentifier").SetValue("someKey","someOtherValue");

    #--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
    # Some arbitrary help information.
    #--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

    # This does things.
    someOptionHere: true

    # This also does things, but in INTEGER FORM!
    someOtherOptionHere: 1

    # And this is just some random string.
    someOtherOtherOptionHere: Yep...

Parsers

This software supports using what's called "Parsers". You can write a parser and use it to immediately parse any read values into anything object you'd like. To create a parser, you must create a class like so;

const Parser = require("CI-Intrepreter").Parser;

class MyParser extends Parser
{
    Parse(value)
    {
        return parseInt(value)+1; // Parse passed values into an int+1.
    }
}

And then you may use said parser when loading a file, using a JSON object passed to the load function, passing the parser to a key named after your desired key.

const MyParser = new (require("../MyParser"));
Loader.Load("someIdentifier", "./fileName.ci", {someOptionHere: MyParser});

After passing your parser, it will automatically parse and will be usable upon fetching a value.

Installation

You can install this software with npm i CI-Intrepreter! Installation into your code is easy as well, you only need a single line of code to be on your way.

    const Loader = require("CI-Intrepeter").Loader;

After inputting this, you can load configuration files with:

    Loader.Load("identifierHere", "filePathHere", {optional: parsers});

If you're not sure if a config is loaded, or would like to make a "modular" system. You can use CheckIfLoaded!

    Loader.CheckIsLoaded("someIdentifier");