Improve ora.promise()

[SrBrahma]

Implemented #169 (comment)

Improves ora.promise:

1. The action can now be a function. It will automatically be executed. The corresponding spinner will be used as argument to that function.
2. It will now return a promise, that resolves when ora.promise given promise/function is resolved, so the user can await ora.promise(..).
3. Added successText and failText, that will be used in the spinner.succeed()/spinner.fail(). They can be either a string or a function. Being a function, successText will receive as argument the return of the action resolve, and failText will receive the action reject content.

Fixes #169

[sindresorhus]

The pull request needs a proper descriptive title.

[sindresorhus]

Please always run npm test locally before pushing changes.

[SrBrahma]

Please always run npm test locally before pushing changes.

I did and fixed my own errors, but there were other errors not related to my changes

[SrBrahma]

I have no idea on how to fix this npm test issue:

[SrBrahma]

I found out why the test error was happening. The new promise() was calling the promise that always rejects. I thought the promise was being rejected before entering the promise() call. Also, the PromiseOptions type definition was missing, looks like I only had added it to the README.

[sindresorhus]

The readme docs should use the same formatting as used here: https://github.com/sindresorhus/boxen#options (Not just a copy paste of the TS types).

[SrBrahma]

For the functions, I used this as pattern: https://github.com/sindresorhus/got/blob/main/documentation/5-https.md#checkserveridentity. Please, change it further if wanted to fit your README styling.

[sindresorhus]

Still messy formatting. Please look over the whole diff.

[SrBrahma]

I don't know why this is happening at all. In my VSCode the indentation is right

[SrBrahma]

I didn't have EditorConfig extension installed here, I was using 2 spaces instead of tab (size 2). The code was looking the same in VSCode, but looks like the diff in GitHub renders tabs as 8 spaces, that's why it was visually strange.

I activated the whitespace rendering, and that's what was happening:

I found out that you are the XO dev. Maybe would be a good idea to have a pre-commit/GitHub action to lint this. Or even, to throw a warn/error on test if spaces were found instead of tabs. In eslint, this is doable.

I hope everything is fixed now.

[SrBrahma]

Just for your information, there is a cool eslint plugin for JSDoc: https://github.com/gajus/eslint-plugin-jsdoc

I will soon add it to my personal eslint-config, as I also have my personal taste for JSDoc comments. Maybe you could implement a similar thing for XO to avoid those issues among all your repos, in PRs like mine.

[sindresorhus]

Or even, to throw a warn/error on test if spaces were found instead of tabs. In eslint, this is doable.

That's already a thing. Ora just didn't have the latest XO version.

However, you are still expected to look over your own PR diff.

[sindresorhus]

Just for your information, there is a cool eslint plugin for JSDoc: gajus/eslint-plugin-jsdoc

I plan to add it at some point, but it's some work to evaluate all the rules, and I haven't had the time to do that yet: xojs/xo#378

[sindresorhus]

Thanks :)