feat: new hook useSpeech

[malavshah9]

Hook description

Hook for playing text using the SpeechSynthesis API.

Valid use-case for the hook

• Playing text when a component mounts.
• Playing text when a component unmounts.
• Playing text when a component receives new props.
• Playing text when a component receives new state.
• Playing text when a user clicks a button.
• Playing text when a user hovers over an element.
• Playing text when a user scrolls to a certain point on the page.
• Playing text when a user types in an input.
• Playing text when a user submits a form.
• Playing text when a user presses a key.
• Playing text when a user presses a key combination.
• Playing text when a user presses a key combination and holds it down.

Checklist

• Have you read the contribution guidelines?
• If you are porting a hook from react-use, have you checked Port remaining hooks from react-use #33 and the migration guide
  to confirm that the hook has been approved for porting?
• Does the code have comments in hard-to-understand areas?
• Is there an existing issue for this PR?
  • Port remaining hooks from react-use #33
• Have the files been linted and formatted?
• Have the docs been updated?
• Have you written tests for the new hook?
• Have you run the tests locally to confirm they pass?

[malavshah9]

@JoeDuncko @xobotyi Please review this PR

[malavshah9]

@JoeDuncko @xobotyi Please review this PR

[xobotyi]

ill review it sometime this week

[malavshah9]

@xobotyi Any update on PR review?

[malavshah9]

@xobotyi Any update on review?

[xobotyi]

On review - no, tests - failing =)

[malavshah9]

@xobotyi Fixed test cases. You can check now.

[malavshah9]

@xobotyi Any update on this?

[codecov]

Codecov Report

Attention: Patch coverage is 60.60606% with 13 lines in your changes missing coverage. Please review.

Project coverage is 98.46%. Comparing base (c898241) to head (79ab0e9).
Report is 134 commits behind head on master.

Files with missing lines	Patch %	Lines
src/useSpeech/index.ts	59.37%	10 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1378      +/-   ##
==========================================
- Coverage   99.62%   98.46%   -1.17%     
==========================================
  Files          62       63       +1     
  Lines        1072     1105      +33     
  Branches      169      174       +5     
==========================================
+ Hits         1068     1088      +20     
- Misses          2       12      +10     
- Partials        2        5       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[xobotyi]

youi also have to add the hook to radme. otherwise - looks good

[xobotyi]

also linting is failing

[malavshah9]

@xobotyi Added hook in readme.md

I checked linting but it is not failing. Let me know by which command it is failing.

[xobotyi]

You can see linting annotations within files tab of pull request.

Linter should be run with yarn lint command

[malavshah9]

@xobotyi Fixed linting. You can check now.

[xobotyi]

you should also add tests for pausing resuming, etc. you should target 100% coverage and in this case is it easily achievable.

[xobotyi]

Closing due to lack of response from author.