Plugin can ONLY find .env file if dotenvOptions.path is set with an absolute path

[PsiRadish]

Describe the bug
If dotenvOptions.path is not set then dotenv will proceed with its default path of

path.resolve(process.cwd(), '.env')

and since process.cwd() is the VS Code installation directory, it will not find anything. Setting dotenvOptions.path to a relative path also fails, for likely the same reason.

To Reproduce
Steps to reproduce the behavior:

1. In some React project
   Add a .env file at the project root containing

   HELLO=WORLD
   

2. In typescript-plugin-css-modules
   Add the following after the dotenv.config call in index.ts and rebuild:

   logger.log(`process.env.HELLO after dotenv.config = ${process.env.HELLO}`);

3. Put the above modified version of typescript-plugin-css-modules in the React project's node_modules
4. Add typescript-plugin-css-modules to compilerOptions.plugins in the React project's tsconfig.json with no additional options
5. Reload Window in VS Code for the React project, then view a ts/tsx file and open the TS Server log
6. tsserver.log contains:

   [typescript-plugin-css-modules] process.env.HELLO after dotenv.config = undefined
   

   Loading from default location with dotenvOptions.path unset = FAILURE
7. Add the following options for typescript-plugin-css-modules to tsconfig.json:

   "options": {
     "dotenvOptions": {
       "path": "./.env"
     }
   }

8. Reload Window in VS Code, view the ts/tsx file again, and open the TS Server log
9. tsserver.log contains:

   [typescript-plugin-css-modules] process.env.HELLO after dotenv.config = undefined
   

   Loading from relative path in dotenvOptions.path = FAILURE
10. Set the following options for typescript-plugin-css-modules in tsconfig.json:

    "options": {
      "dotenvOptions": {
        "path": "C:/Full/Absolute/Path/to/Project/.env"
      }
    }

11. Reload Window in VS Code, view the ts/tsx file again, and open the TS Server log
12. tsserver.log shows:

    [typescript-plugin-css-modules] process.env.HELLO after dotenv.config = WORLD
    

    Loading from absolute path in dotenvOptions.path = ONLY SUCCESS

Expected behavior

1. Plugin can direct dotenv to load a .env file located at the root of the project without dotenvOptions.path having to be set
2. Plugin can direct dotenv to load a file from a relative path in dotenvOptions.path

[mrmckeb]

Hi @PsiRadish, I think we can fix this by adding a default config (path = project path). Does that make sense to you?

[PsiRadish]

Absolutely.

Though, just to be clear, do you mean doing something like this in create?

if (!dotenvPath) { // no custom path; fall back on <project root>/.env
  dotenvPath = path.resolve(info.project.getCurrentDirectory(), '.env');
}
else if (!path.isAbsolute(dotenvPath)) { // relative custom path; manually resolve relative to project root
  dotenvPath = path.resolve(info.project.getCurrentDirectory(), dotenvPath);
}

Or is there some other way of doing it?

[mrmckeb]

I'd suggest instead, just creating a default object

https://github.com/mrmckeb/typescript-plugin-css-modules/blob/develop/src/index.ts#L36

dotenv.config({
  path: path.resolve(info.project.getCurrentDirectory(), '.env'),
  ...options.dotenvOptions,
});

And in other cases, the user can replace it with their options... sound OK?

[mrmckeb]

If so, I can do today/tomorrow ;)

[PsiRadish]

That'll work for my use case (.env file in default location), but a relative path in dotenvOptions.path still won't work, and I imagine most people who need dotenvOptions.path will want to put a relative path in it.

[mrmckeb]

How does this look @PsiRadish? If you think it looks OK, I'll merge and release today!

[mrmckeb]

Sorry @PsiRadish - #58

[PsiRadish]

That looks spiffy.

[mrmckeb]

Hi @PsiRadish, v2.0.1 is out now. Let me know how it goes - and thanks again.

[PsiRadish]

😬 😅
So the dotenvOptions object the plugin constructs here looks great.
Unfortunately it never gets used, as dotenv.config is still called with the original options.dotenvOptions afterward.

If that one line is fixed, though, it does seem to work.