feat: set up linting and add to workflow

[naomi-lgbt]

Closes #284 Closes #285

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new ESLint and Markdown linting configurations for improved code quality.
  • Added new scripts for linting various file types in the project.

• Bug Fixes

  • Enhanced CI workflow with additional steps for dependency installation, linting, and build validation.

• Documentation

  • Updated formatting and structure in README.md, CODE_OF_CONDUCT.md, and example documentation for better clarity.

• Chores

  • Added new configuration files for YAML linting and Markdown linting.
  • Removed unused imports in ListenRestClient.ts and ReadRestClient.ts to streamline code.

[coderabbitai[bot]]

Walkthrough

The pull request introduces several configuration files for linting JavaScript, Markdown, and YAML, along with updates to existing ESLint configurations and CI workflows. It enhances code quality checks by implementing new linting scripts and dependencies in package.json. Additionally, there are formatting improvements in documentation files and minor changes to TypeScript interfaces and function parameters, streamlining the codebase without altering core functionalities.

Changes

Files	Change Summary
.eslintrc-examples.js, .eslintrc.js	New ESLint configuration file added; existing ESLint config updated with new rules and formatting changes.
.github/workflows/CI.yml	CI workflow updated with new jobs for installing dependencies, linting files, and validating builds.
.markdownlint.jsonc, .yaml-lint.json	New configuration files for Markdown and YAML linting introduced with specific rules.
CODE_OF_CONDUCT.md, README.md	Formatting adjustments made to improve clarity and organization of section headers.
examples/README.md	Minor formatting improvements and adjustments to testing instructions.
examples/node-live/index.js	Parameter names in event handlers updated for clarity, with no change in functionality.
package.json	New linting scripts and dependencies added for various file types.
src/lib/fetch.ts	Variable declaration updated from let to const for clarity.
src/packages/AbstractLiveClient.ts	Type of headers property updated for precision; unused interface commented out.
src/packages/ListenRestClient.ts	Import of Fetch type removed, indicating it's no longer needed.
src/packages/ReadRestClient.ts	Import of appendSearchParams function removed, simplifying dependencies.
src/packages/SpeakRestClient.ts	Error handling in someMethod simplified by removing try-catch block.

Assessment against linked issues

Objective	Addressed	Explanation
Markdown should adhere to known standards (#284)	✅
YAML and GitHub Actions YAML should adhere to known standards (#285)	✅

Possibly related PRs

• 306: The introduction of the new ESLint configuration file .eslintrc-examples.js may relate to the changes in the README.md and other files in PR #306, as both involve enhancements to the code quality and structure within the Deepgram JavaScript SDK, particularly in the context of implementing new features like live speech synthesis.

Suggested reviewers

• jpvajda

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

:heart: Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

:placard: Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.