Easy dotnet conventions to verify #141

Mersho · 2023-08-31T11:18:21Z

Working on #122

Supersedes #139

knocte · 2023-08-31T12:28:45Z

CI is still red, please fix it.
When opening a PR that replaces an old one, please put the link of the old PR in the description, e.g. saying "Supersedes #XY", and then go to the old PR and close it (adding a comment that links to the new PR).

knocte · 2023-08-31T12:30:33Z

@Mersho I can see you have pushed something different from the previous PR, what did you change? (I can tell by seeing that the commit hashes are not the same)

Mersho · 2023-08-31T13:37:00Z

@Mersho I can see you have pushed something different from the previous PR, what did you change? (I can tell by seeing that the commit hashes are not the same)

@knocte I'm just re-pushing and amending, nothing has changed

git commit --amend --no-edit

knocte · 2023-08-31T13:43:50Z

please put the link of the old PR in the description, e.g. saying "Supersedes #XY"

You didn't do this yet.

Mersho · 2023-08-31T13:51:31Z

please put the link of the old PR in the description, e.g. saying "Supersedes #XY"

You didn't do this yet.

Done, I've edited the first comment.

knocte · 2023-08-31T13:56:21Z

Done, I've edited the first comment.

That's not the first comment, it's the PR description :)

src/FileConventions/Library.fs

knocte · 2023-09-04T12:26:03Z

FileConventions: improvements to Library.fs

Ideally, the changes that this commit brings should be moved to the corresponding commits that introduced those functions, to avoid git-blame pollution.

Mersho · 2023-09-04T13:10:53Z

FileConventions: improvements to Library.fs

Ideally, the changes that this commit brings should be moved to the corresponding commits that introduced those functions, to avoid git-blame pollution.

That's true, I'd like to squash the commits if it's okay with you

There are also some old commits that need to be squashed
FileConventions(.Test): fix proj file indent
FileConvention: properly naming variables

knocte · 2023-09-04T15:47:25Z

I'd like to squash the commits if it's okay with you

That's very ambiguous, what commits do you intend to squash? FYI I don't want you to squash everything into 1 commit.

Mersho · 2023-09-04T17:54:41Z

I'd like to squash the commits if it's okay with you

That's very ambiguous, what commits do you intend to squash? FYI I don't want you to squash everything into 1 commit.

nvm, it's fine.

knocte · 2023-09-06T08:22:14Z

FileConventions: dotnetFileConvention

This commit msg title is very rough, why doesn't it have a verb? It must summarize well what is happening, and this does not.

The new dotnetFileConvention.fsx script detects empty strings,
wrong namespace usage, and incorrect printf methods on
non-console applications.

dotnetFileConvention? You're clearly saying that this script is taking care of various conventions, not just one, so then the name of the script should be in plural, not singular.

Mersho · 2023-09-07T09:06:57Z

FileConventions: dotnetFileConvention

This commit msg title is very rough, why doesn't it have a verb? It must summarize well what is happening, and this does not.

The new dotnetFileConvention.fsx script detects empty strings,
wrong namespace usage, and incorrect printf methods on
non-console applications.

dotnetFileConvention? You're clearly saying that this script is taking care of various conventions, not just one, so then the name of the script should be in plural, not singular.

I've changed the commit message. Thank you for informing me.

Add tests for DefiningEmptyStringsWithDoubleQuotes function.

Implement DefiningEmptyStringsWithDoubleQuotes function.

Add tests for ProjFilesNamingConvention function.

Implement ProjFilesNamingConvention function.

Add tests for NotFollowingNamespaceConvention function.

Implement NotFollowingNamespaceConvention function.

Add more tests for NotFollowingNamespaceConvention fn.

Fix NotFollowingNamespaceConvention function.

Add one more test for NotFollowingNamespaceConvention function.

Function DoesNamespaceInclude doesn't working on *.cs namespace.

We updated fsdk to the latest version becuase the old version of fsdk does not have `Misc.BetterAssert` and we use `Misc.BetterAssert()` becuase assert is for debug mode.

Using RemoveEmptyEntries for split & removing extra parans & Regex does not require a new keyword & string formatting has been corrected.

Add tests for NotFollowingConsoleAppConvention() function.

Ensure that projects that aren't console applications don't have source files with console methods. Co-authored-by: Parham <parhaamsaremi@gmail.com>

Add tests for NotFollowingConsoleAppConvention function and we fix ConsoleAppConvention2 test so that project name does not contradict new tests.

Fix NotFollowingConsoleAppConvention() function.

Add tests for async project, Async.RunSynchronously only allowed in console applications.

Fix NotFollowingConsoleAppConvention() function.

Add test for NotFollowingNamespaceConvention fn.

A .fs/fsx file might not have a namespace sometimes.

`Contains()` method catches a lot of false-positives and not suitable for this situation so we used regex. Co-authored-by: Parham <parhaamsaremi@gmail.com>

Fix `DefiningEmptyStringsWithDoubleQuotes()` function by using regex insted of `Contains()`. Co-authored-by: Parham <parhaamsaremi@gmail.com>

Finding printf and console methods in files & removed printf methods used for debugging purposes & added file filter to ReturnAllProjectSourceFile.

The newly developed script can detect wrong empty strings, wrong project directories, incorrect namespace usage, and incorrect methods in non-console applications.

An assert error message has been added for *.fsx files & renaming the func.

Mersho changed the title ~~Easy dotnet conventions to verify #122~~ Easy dotnet conventions to verify Aug 31, 2023

Mersho force-pushed the verifyDotnetConventions-squashed branch from 199f076 to 50fe215 Compare August 31, 2023 11:33

Mersho mentioned this pull request Aug 31, 2023

Easy dotnet conventions to verify #139

Closed

Mersho closed this Aug 31, 2023

Mersho reopened this Aug 31, 2023

knocte reviewed Aug 31, 2023

View reviewed changes

src/FileConventions/Library.fs Outdated Show resolved Hide resolved

knocte reviewed Aug 31, 2023

View reviewed changes

src/FileConventions/Library.fs Outdated Show resolved Hide resolved

Mersho force-pushed the verifyDotnetConventions-squashed branch 2 times, most recently from 758ee35 to 69aad0c Compare September 7, 2023 09:00

Mersho force-pushed the verifyDotnetConventions-squashed branch from 217858e to 541a03b Compare September 7, 2023 13:55

tehraninasab added 8 commits September 14, 2023 15:46

FileConventions: add failing test

5071790

Add tests for DefiningEmptyStringsWithDoubleQuotes function.

FileConventions: implement the function

854bb84

Implement DefiningEmptyStringsWithDoubleQuotes function.

FileConventions: add failing test

64aa0ef

Add tests for ProjFilesNamingConvention function.

FileConventions: implement the function

ac8e438

Implement ProjFilesNamingConvention function.

FileConventions: add failing test

be96888

Add tests for NotFollowingNamespaceConvention function.

FileConventions: implement the function

2ad886c

Implement NotFollowingNamespaceConvention function.

FileConventions.Test: add failing test

4cb987e

Add more tests for NotFollowingNamespaceConvention fn.

FileConventions: fix the function

bf64190

Fix NotFollowingNamespaceConvention function.

Mersho and others added 22 commits September 14, 2023 15:46

FileConventions: add failing test

f95737a

Add one more test for NotFollowingNamespaceConvention function.

FileConventions: fix csharp namespace

fe91fed

Function DoesNamespaceInclude doesn't working on *.cs namespace.

FileConventions: add failing test

2e5b0cc

FileConventions: Contains() is not suitable here

842e3c1

FileConventions: use BetterAssert() & update Fsdk

040d85d

We updated fsdk to the latest version becuase the old version of fsdk does not have `Misc.BetterAssert` and we use `Misc.BetterAssert()` becuase assert is for debug mode.

FileConventions(.Test): applying f# standard style

b85986b

Using RemoveEmptyEntries for split & removing extra parans & Regex does not require a new keyword & string formatting has been corrected.

FileConventions: add failing test

4cbf1bc

Add tests for NotFollowingConsoleAppConvention() function.

FileConventions: fix the function

c15b542

Ensure that projects that aren't console applications don't have source files with console methods. Co-authored-by: Parham <parhaamsaremi@gmail.com>

FileConventions: add failing test

e532e35

Add tests for NotFollowingConsoleAppConvention function and we fix ConsoleAppConvention2 test so that project name does not contradict new tests.

FileConvention: fix the function

cc7b70e

Fix NotFollowingConsoleAppConvention() function.

FileConventions: add failing test

86db3b3

Add tests for async project, Async.RunSynchronously only allowed in console applications.

FileConvention: fix the function

4ee7a19

Fix NotFollowingConsoleAppConvention() function.

FileConventions(.Test): fix proj file indent

18e91ea

FileConvention: properly naming variables

2f8f770

FileConventions: add failing test

f937c57

Add test for NotFollowingNamespaceConvention fn.

FileConvention: fix the function

edd540f

A .fs/fsx file might not have a namespace sometimes.

FileConventions.Test: add failing test

e71117f

`Contains()` method catches a lot of false-positives and not suitable for this situation so we used regex. Co-authored-by: Parham <parhaamsaremi@gmail.com>

FileConventions: fix empty string false-positives

071e30a

Fix `DefiningEmptyStringsWithDoubleQuotes()` function by using regex insted of `Contains()`. Co-authored-by: Parham <parhaamsaremi@gmail.com>

FileConventions: load Helpers.fs first

1731514

FileConventions: improvements to Library.fs

f1bfbb0

Finding printf and console methods in files & removed printf methods used for debugging purposes & added file filter to ReturnAllProjectSourceFile.

scripts: add dotNetFileConventions.fsx

e6dd18d

The newly developed script can detect wrong empty strings, wrong project directories, incorrect namespace usage, and incorrect methods in non-console applications.

FileConventions: improvements to Library.fs

280d634

An assert error message has been added for *.fsx files & renaming the func.

Mersho force-pushed the verifyDotnetConventions-squashed branch from 59590da to 280d634 Compare September 14, 2023 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Easy dotnet conventions to verify #141

Easy dotnet conventions to verify #141

Mersho commented Aug 31, 2023 •

edited

knocte commented Aug 31, 2023

knocte commented Aug 31, 2023

Mersho commented Aug 31, 2023

knocte commented Aug 31, 2023

Mersho commented Aug 31, 2023

knocte commented Aug 31, 2023

knocte commented Sep 4, 2023

Mersho commented Sep 4, 2023

knocte commented Sep 4, 2023

Mersho commented Sep 4, 2023

knocte commented Sep 6, 2023

Mersho commented Sep 7, 2023

Easy dotnet conventions to verify #141

Are you sure you want to change the base?

Easy dotnet conventions to verify #141

Conversation

Mersho commented Aug 31, 2023 • edited

knocte commented Aug 31, 2023

knocte commented Aug 31, 2023

Mersho commented Aug 31, 2023

knocte commented Aug 31, 2023

Mersho commented Aug 31, 2023

knocte commented Aug 31, 2023

knocte commented Sep 4, 2023

Mersho commented Sep 4, 2023

knocte commented Sep 4, 2023

Mersho commented Sep 4, 2023

knocte commented Sep 6, 2023

Mersho commented Sep 7, 2023

Mersho commented Aug 31, 2023 •

edited