Cleanup Project Structure To Meet .NET Standards

[OoLunar]

Proposed changes

This PR does the following:

• Deduplicates many resource files
• Flattens the projects found within the examples and tests directories per .NET convention
• Resolves https://github.com/advisories/GHSA-hh2w-p6rv-4g7w
• Updates the .gitignore file
• Updates all dependencies to their latest version

Types of changes

What types of changes does your code introduce to the community .NET SDK? Put an x in the boxes that apply

• [x] Bugfix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• [x] I have read the CONTRIBUTING doc
• [x] I have lint'ed all of my code using repo standards
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] I have added necessary documentation (if appropriate)

Further comments

This PR is the first of many for updating this repository to meet the standard .NET project layout and practices. The next PR will be cleaning up the example and test code, then using the conventional logging from Microsoft.Extensions.Logging.Abstractions.

https://wakatime.com/@a8e4b5db-b8cc-469a-acce-099a0a2425be/projects/dammoujrda?branches=oolunar%2Fupdate-infra&start=2024-10-31

Storing this for later as Wakatime will delete statistics after 2 weeks when using their free plan: 

Summary by CodeRabbit

• New Features

  • Introduced multiple new projects for various functionalities, including Analyze, Manage, and SpeechToText, enhancing the application's capabilities.
  • Added support for real-time speech-to-text transcription via WebSocket and REST clients.

• Bug Fixes

  • Improved error handling and logging throughout various examples to enhance user experience and debugging.

• Refactor

  • Restructured existing projects and removed outdated project files, streamlining the codebase.

• Documentation

  • Updated project configurations to ensure compatibility with the latest .NET framework and dependencies.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request encompasses a comprehensive update to the project's structure, including the deletion of several Visual Studio solution and project files, specifically Deepgram.Dev.sln, Deepgram.DevBuild.sln, and various .csproj files. Additionally, it introduces a new .gitignore file with an expanded list of ignored files and directories relevant to various development tools and environments. The project files that remain have been updated to target .NET 9.0 and include new dependencies, reflecting a shift towards more modern configurations.

Changes

File/Directory Path	Change Summary
.gitignore	Expanded list of ignored files for development environments, including Visual Studio, .NET, etc.
Deepgram.Dev.sln	Deleted; was a Visual Studio solution file for the Deepgram project.
Deepgram.DevBuild.sln	Deleted; was a Visual Studio solution file for the Deepgram build.
Deepgram.Microphone/Deepgram.Microphone.csproj	Updated package references to fixed versions for .NET frameworks.
Deepgram.Tests/Deepgram.Tests.csproj	Updated package references with newer versions.
Deepgram.sln	Significant restructuring with updated project identifiers and new example projects added.
Deepgram/Deepgram.csproj	Updated package references for various dependencies.
Directory.Build.props	New file created to define project root property.
clean-up.sh	Deleted; was a shell script for cleaning project directories.
Various examples/.../*.csproj	New project files created for various examples, targeting .NET 9.0 with updated dependencies.
Various examples/.../Program.cs	New C# programs introduced with updated namespaces and accessibility for main methods.
examples/analyze/.../Analyze.csproj	Deleted; project files related to analyze functionality removed.
examples/manage/.../Manage.csproj	Deleted; project files related to manage functionality removed.
examples/speech-to-text/.../PreRecorded.csproj	Deleted; project files related to speech-to-text functionality removed.
examples/text-to-speech/.../Speak.csproj	Deleted; project files related to text-to-speech functionality removed.

Possibly related PRs

• #316: This PR reintroduces functionality related to Text-to-Speech (TTS) using WebSocket, which is relevant to the changes made in the main PR that updates the .gitignore file to include various development tools and environments, including those related to TTS.
• #338: This PR updates the WebSocket Listen example, which may relate to the overall structure and organization of projects in the Deepgram solution, similar to the organizational improvements made in the main PR's .gitignore updates.
• #340: This PR enhances error handling for WebSocket connections, which could be indirectly related to the overall improvements in project management and structure reflected in the main PR.
• #343: This PR adds functionality for closing streams without canceling, which is relevant to the WebSocket functionality that the main PR's updates may support.
• #350: This PR addresses issues with the API key handling, which is essential for the functionality of the Deepgram SDK, aligning with the overall improvements in project management and configuration reflected in the main PR.

Suggested reviewers

• jpvajda
• naomi-lgbt
• lukeocodes

---

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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[davidvonthenen]

Some comments:

1. This is likely to break the release process.
2. You need to update all the documentation to update all links to these files (ie examples, clients, etc)

[jpvajda]

@OoLunar

the PR is very large to review for the team and this approach to refactor the code base isn't what we are looking for at this time.

the unit tests are broken: https://github.com/deepgram/deepgram-dotnet-sdk/actions/runs/11692426812/job/32562168995?pr=352

the build is broken: https://github.com/deepgram/deepgram-dotnet-sdk/actions/runs/11692426812/job/32562168134?pr=352

I am guessing the upload to nuget is also broken.

The docs would need to be fixed in multiple places, which isn't something we want to do right now.

I think it be best to close this out as our main goal should be be to maintain and support the existing SDK, not focus on a large refactor at this time.

[OoLunar]

the PR is very large to review for the team and this approach to refactor the code base isn't what we are looking for at this time. [...] I think it be best to close this out as our main goal should be be to maintain and support the existing SDK, not focus on a large refactor at this time.

That's entirely okay. I still think we should update the dependencies at minimum to address the STJ vulnerability, however the rest of this work can be done again on a different day. I'll save this branch for later, nothing a bit of rebase magic can't help with.

[jpvajda]

@OoLunar if the dependency change won't introduce anything breaking to our users we can consider it.