search

XeroAPI / xero-php-oauth2

Xero PHP SDK for oAuth 2 generated from Xero API OpenAPI Spec 3.0
MIT License
90 stars 64 forks source link

Update README.md to provide additional configuration guidance #292

Open morganarnel opened 1 year ago

morganarnel commented 1 year ago

The Readme currently contains the following guidance

Configure PHPStorm We've received feedback that PHPStorm IDE default file size is too small to load the AccountingApi class.

"PHPStorm seems unable to resolve the XeroAPI\XeroPHP\Api\AccountingApi class. It just shows Undefined class 'AccountingApi' and therefore can't autocomplete any of the methods etc."

To fix this, add the following to the idea.properties file to increase this limit to 5000 kilobytes

idea.max.intellisense.filesize=5000

Instructions here for configuring PHPStorm platform properties on Mac/Windows/Linux

Suggestion is to also add additional guidance for those using PHP Intelephense with Visual Studio Code, suggesting that they increase their maximum file size to 3000000 bytes in Settings -> Extensions -> Intelephense -> Files: Max Size.

OR

just abstract some things out :shrug:

It's more than possible that increasing these settings in larger projects (projects integrating with Xero tend to be) could cause some serious slowdown issues in the background when it comes to indexing and such. Then you shouldn't need to provide any of this guidance.

morganarnel commented 1 year ago

I mean, even GitHub stops people from viewing it as it's too large.

image