search

deepgram / deepgram-dotnet-sdk

.NET SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
33 stars 30 forks source link

Linter Updates From .NET Analyzers #228

Closed davidvonthenen closed 9 months ago

davidvonthenen commented 9 months ago

These are updates based on the MS .NET Analyzers (linterrs, checks, etc) after enabling them in the project settings. These aren't bad until I look at more automated linters for code formatting.

Screenshot 2024-02-12 at 10 36 40

Summary by CodeRabbit

coderabbitai[bot] commented 9 months ago

Walkthrough

The updates primarily involve cleaning up and organizing code across the Deepgram project. This includes reordering import statements, removing global usings and adding them locally, correcting minor syntax errors (like missing semicolons), and simplifying method implementations. Additionally, the project's dependencies have been updated, and code analysis tools have been integrated to ensure code quality. These changes contribute to better readability, maintainability, and adherence to best practices within the codebase.

Changes

File(s) Change Summary
Deepgram.Tests/GlobalUsings.cs Removed global usings for networking and serialization, added them locally.
Deepgram.Tests/.../ClientTests/*.cs Reordered import statements, adjusted import order for Deepgram.Models.*.
Deepgram.Tests/.../ExtensionsTests/HttpClientExtensionTests.cs Swapped import order of Deepgram.Models.Manage.v1 and Deepgram.Models.Authenticate.v1.
Deepgram/Abstractions/AbstractRestClient.cs Corrected spacing around cancellationToken in SendAsync.
Deepgram/Constants/Defaults.cs Removed DEEPGRAM_CONTENT_TYPE constant.
Deepgram/Deepgram.csproj Updated dependencies, added Microsoft.CodeAnalysis.NetAnalyzers.
Deepgram/Encapsulations/HttpClientFactory.cs, Deepgram/Enums/LiveType.cs Added missing semicolon after namespace declaration.
Deepgram/LiveClient.cs, Deepgram/ManageClient.cs, Deepgram/OnPremClient.cs, Deepgram/PrerecordedClient.cs Reordered import statements, adjusted import order for Deepgram.Models.*.
Deepgram/Logger/LogProvider.cs Removed unnecessary empty lines in GetLogger.
Deepgram/Utilities/RequestContentUtil.cs Simplified CreatePayload, adjusted StringContent constructor call, removed Content-Type setting in CreateStreamPayload.

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?

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)
Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.