Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where are the docs for writing source analyzers outside VS (for cross-platform CLI)? #64769

Closed
ziaulhasanhamim opened this issue Oct 17, 2022 · 4 comments
Labels
Area-Analyzers untriaged Issues and PRs which have not yet been triaged by a lead

Comments

@ziaulhasanhamim
Copy link

I'm not a typical Visual Studio User(because I'm not a full-time windows user). I need to write an analyzer. But all the docs explain how to write analyzers with VS. There is no documentation on how to get started building an analyzer on CLI. How to set up the project? It's really frustrating. Most languages' documentation first explains how to do things on CLI without extra tooling. The IDE documentation is totally separated. These things still give the feeling that .Net is not fully cross-platform.
Yes, it's cross-platform, but all the documentation is about VS, which is a windows-only product. So you need to use VS on windows to get the full gist of .NET.
The docs really should be only about the .NET and doing things on every platform. Yes VS is a good product. But there are many people who like to use CLI or other IDEs. I think C# really went in the wrong direction if you compare it to other languages. In most languages, everything is CLI first. But in C# everything is VS first.
I had gone a little off-topic. But all documentation regarding Roslyn should be written as they could be followed on any platform.

I want to see this in Prerequisites

Prerequisites

Not this

Prerequisites

@dotnet-issue-labeler dotnet-issue-labeler bot added Area-Analyzers untriaged Issues and PRs which have not yet been triaged by a lead labels Oct 17, 2022
@Youssef1313
Copy link
Member

I think this is a documentation issue that should be in dotnet/docs.

For now, you could start with cloning https://github.com/jmarolf/analyzer-start

@ziaulhasanhamim
Copy link
Author

I will clone that. But can't there be a better experience? Obviously there can be if there is dome efforts on CLI

I think this is a documentation issue that should be in dotnet/docs.

So should I reopen it there?

@Youssef1313
Copy link
Member

@ziaulhasanhamim I opened dotnet/templates#721 for having easy dotnet new templates.

For now, all the docs can do is point out how you can create the project manually.

You can either close this issue and open an issue on dotnet/docs using this link, or wait for someone with write access to move this issue.

@ziaulhasanhamim
Copy link
Author

ziaulhasanhamim commented Oct 17, 2022

I opened dotnet/templates#721 for having easy dotnet new templates

I appreciate that. Thanks.

You can either close this issue and open an issue on dotnet/docs using this link or wait for someone with write access to move this issue.

Ok I will close it and open it there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Analyzers untriaged Issues and PRs which have not yet been triaged by a lead
Projects
None yet
Development

No branches or pull requests

2 participants