Updated Encore object to class for proxy typehinting

[florentdestremau]

Hello, I'm trying to address #151 with this PR.

I have an error in my tests:

Public API
    setOutputPath
  Error: Encore.configureRuntimeEnvironment is not a recognized property or method.
  
  - index.js:942 Object.get
    /home/florent/dev/opensource/webpack-encore/index.js:942:27
  - index.js:17 Context.beforeEach
    /home/florent/dev/opensource/webpack-encore/test/index.js:17:13
  - runnable.js:348 callFn
    [webpack-encore]/[mocha]/lib/runnable.js:348:21
  - runnable.js:340 Hook.Runnable.run
    [webpack-encore]/[mocha]/lib/runnable.js:340:7
  - runner.js:309 next
    [webpack-encore]/[mocha]/lib/runner.js:309:10
  - runner.js:339 Immediate.<anonymous>
    [webpack-encore]/[mocha]/lib/runner.js:339:5
  - timers.js:789 runCallback

I'm looking into it but any advice would be welcome so that we all get a proper proxy and autocomplete on ❤️ PHPSTORM ❤️

[Lyrkan]

The Encore class should be instanciated there:

const EncoreProxy = new Proxy(new Encore(), { /* ... */ });

[Lyrkan]

Hey @florentdestremau,

Thanks for working on that, only a small thing to fix and all the tests will probably pass :)

[Lyrkan]

You also forgot to replace some @return {exports} by @return {Encore} for the following methods:

• autoProvidejQuery
• enablePostCssLoader
• enableSassLoader
• enableLessLoader
• enableStylusLoader
• configureBabel
• enableTypeScriptLoader
• enableCoffeeScriptLoader
• enableForkedTypeScriptTypesChecking

[florentdestremau]

@Lyrkan not sure what to do for the @returns {*} here :
https://github.com/symfony/webpack-encore/pull/263/files#diff-168726dbe96b3ce427e7fedce31bb0bcR809

[Lyrkan]

@florentdestremau You can leave that one, it represents the config generated by Encore, not the API.

I can't really test if the autocompletion works right now (no PHPStorm) but based on the code it looks good to me :)

[florentdestremau]

This doesn't solve the problem for me actually, when I copy / paste my new index.js file into my node_modules. I'm going to try by installing from my fork

Edit:

Confirmed, by using my fork I still get Can't analyse webpack.config.js: coding assistance will ignore module resolution rules in this file

[Lyrkan]

Did you try closing/reopening PHPStorm and your webpack.config.js file? Maybe there is some sort of JSDoc cache?

[florentdestremau]

Yes, tried reinstalling node modules after removing them and no results.
For those wanting to try out, here's the new package.json line to use :

"@symfony/webpack-encore": "https://github.com/florentdestremau/webpack-encore/tarball/fix-phpstorm-unresolved-methods",

[Lyrkan]

@florentdestremau I'm back on a computer with PHPStorm and it seems to work, maybe that's related to your PhpStorm configuration?

[florentdestremau]

Damn, so this is a new problem on my side now 😅
Well at least this PR seems valid.

[weaverryan]

Woohoo! Thanks @florentdestremau! Actually, this also didn't work for me at first. Well, it auto-completed only the first 4 methods. The problem was my JavaScript version setting. In PhpStorm, make sure you're using ECMAScript 6 (it defaults to ECMAScript 5.1). This made all the difference for me :)

[florentdestremau]

@weaverryan nice catch ! Indeed it works fine with ES6. Love it ! Should #151 be closed then ?

[Lyrkan]

Btw it also fixes the issue in VSCode :)