describejs v1.1.0

DescribeJS

yarn global add describejs

or

npm install -g describejs

describe <fileName or a whole director>

A good passing JavaScript file should look something like this

/*
describe:
A simple greeting function
*/
const name = 'Felix'
const sayName = function(yourName){
    return `${name} is greeting to you ${yourName}`;
}

It will pass the DescribeJS test, since you add the describe syntax to your code, or else DescribeJS will throw a error to you

Describe Syntax

describe syntax is a stand multi-line comment in JavaScript, it look something like this

/*
describe:
<description>
*/

You can add describe syntax any where you want inside you JS file

Expect return type

expect return type lets you told other developer what this functino or JSON should return

/*
describe:
<description>
@return <1 to 8 characters>
*/

const stuff = {
    name: 'Felx',
    /*
    describe:
    The age MUST be a number!
    @return number
    */
    age: 16
}