Display the description on missing vars report

[micalevisk]

Let's say we have a .env.example with this content:

### The URL to the database instance
DATABASE_URL=

### The app secret used to sign JSON Web Tokens
APP_SECRET=

### Google Analytics ID [optional]
GA_ID=

and the .env one has this:

DATABASE_URL=
APP_SECRET=
GA_ID=

I think would be cool if the check command displays the description of missing ones like

Checking environment...
The process is missing required environment variables:
❌ Missing variable: DATABASE_URL
ℹ️ The URL to the database instance
❌ Missing variable: GA_ID
ℹ️ The app secret used to sign JSON Web Tokens

[arvindell]

This is actually a feature I'm working on! I still need to upload the branch from my local machine + create the draft PR. Thanks for the suggestion, I will track this functionality in this issue 👍

[micalevisk]

quick question: the ### mark are just identified if it's right above the env name, right?

because I have an env like this:

### bar ...

FOO=

and I don't expect that the first line to be treated as a description of FOO

[arvindell]

quick question: the ### mark are just identified if it's right above the env name, right?

because I have an env like this:

### bar ...

FOO=

and I don't expect that the first line to be treated as a description of FOO

Currently any triple # comment will be interpreted as the description of the next variable in the file, regardless of whether there are whitespace characters. If you'd prefer to only allow triple # comments right above the variable, I'll be glad to continue this in another issue 👐🏼

[micalevisk]

I guess this is fine, actually. I could change the ### to ## to circumvent this behavior.

I just miss this documented on https://github.com/arvindell/envful#how-to-declare-variables section

[arvindell]

I guess this is fine, actually. I could change the ### to ## to circumvent this behavior.

I just miss this documented on https://github.com/arvindell/envful#how-to-declare-variables section

You're right, just added it, thanks!