Skip to content

Conversation

@webwarrior-ws
Copy link
Contributor

@webwarrior-ws webwarrior-ws commented Nov 12, 2025

Change FSharpLint.Console project's assembly name, from dotnet-fsharplint to fsharplint. This way it will be published as fsharplint nuget package and, combined with dnx invocation (which this PR also highlights in the docs), will get UX much leaner.

Fixes #746

@knocte
Copy link
Collaborator

knocte commented Nov 12, 2025

@Numpsy can you review?

@knocte knocte changed the title Change assembly name to fsharplint Change tool name from dotnet-fsharplint to fsharplint Nov 13, 2025
<PackageType>DotNetCliTool</PackageType>
<PackAsTool>true</PackAsTool>
<AssemblyName>dotnet-fsharplint</AssemblyName>
<AssemblyName>fsharplint</AssemblyName>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@webwarrior-ws maybe we should rather use ToolCommandName here, as instructed by #746 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment that you've linked says that

It would have no impact on dnx

@Numpsy
Copy link
Contributor

Numpsy commented Nov 13, 2025

@Numpsy can you review?

I like the simpler name myself, but i'd defer to @baronfel s comments on best practices for naming these days

@knocte
Copy link
Collaborator

knocte commented Nov 13, 2025

I sent @duckmatt (previous/original maintainer) an email yesterday about the permissions to publish new versions in the old nuget package: https://www.nuget.org/packages/FSharpLint , but maybe he disagrees? Or any of you might disagree too, about breaking possible users of the old library that might upgrade and spend some time figuring out that they have to migrate to "FSharpLint.Core"?

If that's the case, another solution (which is also much shorter) would be to reserve the name "fslint" which seems available and would result in a much more neat UX due to the super short command (thanks to dnx too): dnx fslint.

@Numpsy
Copy link
Contributor

Numpsy commented Nov 13, 2025

I think Fantomas did a change like that some time ago ('fantomas' was the library and 'fantomas-tool' was the tool, and now 'fantomas' is the tool and 'fantomas.core' is the library).

The download stats at https://www.nuget.org/stats/packages/FSharpLint?groupby=Version do show several hundred downloads of 'fsharplint' in the last 6 weeks despite it not having been updated since 2016, so that might upset something so maybe 'fslint' is cleaner.

Of FSharpLint.Console from dotnet-fsharplint to fsharplint.
This way it will be published as fsharplint package and the
tool name will be just fsharplint, not dotnet-fsharplint.
To reflect changes in tool name from dotnet-fsharplint to fsharplint.
@knocte
Copy link
Collaborator

knocte commented Nov 14, 2025

Rebased to fix CI.

I like the simpler name myself,

But can you review the docs changes, to make sure they really fix bug 746? Thanks @Numpsy

@Numpsy
Copy link
Contributor

Numpsy commented Nov 14, 2025

I'll do a local build and try it (and dnx as well)


Run `dnx fsharplint --help` for full usage information.

# Installing and runnnig on .NET versions before 10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'runnnig' should be 'running' ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's more obvious when looking at the HTML view:
image

@Numpsy
Copy link
Contributor

Numpsy commented Nov 14, 2025

I tried building this branch locally and installing/running it with the 'fsharplint' name and that appeared to work following the documentation.

I did however have an instance of #687 when I tried running dnx in a directory with no global.json etc in:

image

That worked after setting roll forward to latestMajor. That's not directly related to this change, but I'm not sure if it's something that might come up with dnx if that's just a .NET 10+ thing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tool name is dotnet-fsharplint while documentation states fsharplint

3 participants