Nightmarish Pawnshop Mystic
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    cimentpublic

    ciment

    ciment is a library for generating comment-String rapidly. Include javascript, CSS and HTML commnets manipulation.

    var comment = require('ciment');
     
    // Comment module methods
    comment.single('hello world'); // result: "// hello world"
    comment.block('hello world'); // result: "/* hello world */"
     
    // Prototype module methods
    'hello world'.single(); // result: "// hello world"
    'hello world'.block(); // result: "/* hello world */"
     
    'hello world'.block().decomment(); // result: "hello world"

    Install

    For node with npm:

    npm install ciment

    And use with var comment = require("ciment")

    API

    Base function

    comment.decomment(content);

    Remove the first wrapper comment form this string

    Module function

    comment.single("comment text");
    //  comment text

    Return a single line comment string

    comment.block("comment text");
    /*  comment text  */

    Return a normal block comment string

    comment.title("comment text");
    /*****  comment text  *****/

    Return a block comment string like comment title

    comment.banner("comment text\nhello world");
    /**
    *    comment text
    *    hello world
    **/

    Return a banner block comment string

    comment.tag("<div>comment text</div>");
    <!-- <div>comment text</div> -->

    Return a html tag comment string

    Prototype function

    "comment text".single();
    //  comment text
    "comment text".block();
    /*  comment text  */
    "comment text".title();
    /*****  comment text  *****/
    "comment text".banner();
    /**
    *    comment text
    *    hello world
    **/
    "<div>comment text</div>".tag();
    <!-- <div>comment text</div> -->

    Keywords

    none

    install

    npm i ciment

    Downloadsweekly downloads

    1

    version

    1.0.0

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar