search

deepgram / deepgram-js-sdk

Official JavaScript SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
159 stars 54 forks source link

Implement markdown and yaml linting, prepare eslint infrastructure #322

Closed davidvonthenen closed 2 months ago

davidvonthenen commented 4 months ago

This enables some linting/checks for Markdown, GH Action, YAML, and Shell Linting.

This introduces GitHub actions to check those things and allows users to check locally before submitting a PR. Running locally requires docker, but the user doesn't necessarily need to install or check manually before submitting a PR. To download all dependencies (ie make check = run all lints, checks), they can run make ensure-deps to download all dependencies, tools, and etc.

Addresses the following issues: https://github.com/deepgram/deepgram-js-sdk/issues/286 https://github.com/deepgram/deepgram-js-sdk/issues/285 https://github.com/deepgram/deepgram-js-sdk/issues/284

The updates to the Markdown are from the issues raised by the mdlint check.

If you don't feel this adds value to the project, feel free to close this PR and the issues as well.

davidvonthenen commented 4 months ago

Yup, I get it. It was the easiest lift without investing too much time (as in like 5mins). This isn't required for someone to open a PR as it will check in the GH action but uses the same mechanism for both. If this is too much for the project to add, you can close this PR.

davidvonthenen commented 4 months ago

And we should be linting the JS/TS with the eslint package (and prettier if we want to be extra robust). There's also a markdownlint-cli npm package we can use if we want to lint markdown.

This doesn't tackle any JS linting.

davidvonthenen commented 4 months ago

Doesn't matter. It's your work and code.