intellitect / essentialcsharp.web

The web side of essentialcsharp.com

IntelliTect.Multitool:

Install Instructions

1. Add package to project from nuget.org. More instructions to get started with consuming nuget packages can be found on learn.microsoft.com
2. All tools are under the IntelliTect.Multitool namespace.
3. That's it! Please open an issue if you have any problems with any of these steps or have other questions.

ReleaseDateAttribute - Gets an UTC DateTime of compile time. Allows us to determine the build date/time

Blog Post/Additional Information: How To Display the Build Date of a .NET Application

Samples:

• Assignment of GetReleaseDate() to a local variable

  DateTime? date = IntelliTect.Multitool.ReleaseDateAttribute.GetReleaseDate(); // Returns a datetime in UTC to date

• Displaying GetReleaseDate() on a cshtml page

  // This example is in cshtml.
  @IntelliTect.Multitool.ReleaseDateAttribute.GetReleaseDate() // Returns a datetime in UTC

• Converting and displaying GetReleaseDate() on a cshtml page

  // convert this UTC DateTime object into one for my local timezone that is formatted in a “d MMM, yyyy h:mm:ss tt” (ex: 8 Feb, 2023 11:36:31 AM).
  // The following code will format the date and convert it to my local time zone of Pacific Standard Time. 
  Build: @if (IntelliTect.Multitool.ReleaseDateAttribute.GetReleaseDate() is DateTime date)
  {
    @TimeZoneInfo.ConvertTimeFromUtc(date, TimeZoneInfo.FindSystemTimeZoneById("Pacific Standard Time")).ToString("d MMM, yyyy h:mm:ss tt", CultureInfo.InvariantCulture)
  }
  // Result is "Build: 8 Feb, 2023 11:36:31 AM"

Miscellaneous Information:

• To help hot reload in visual studio work properly, the release date attribute will be automatically be generated during compilation on a CI runner, but it won’t generate locally by default. If you want it to generate locally, set the ReleaseDateAttribute to true within a property group in your project file. (<ReleaseDateAttribute>true</ReleaseDateAttribute>)

RepositoryPaths - Provides consistent environment-independent normalized pathing within a git repository

Samples:

• Get file path from the root of a repository

  // In this case, the GetDefaultRepoRoot() method can be used to get the root of a repository.
  string fullPathToTheFile = Path.Combine(IntelliTect.Multitool.RepositoryPaths.GetDefaultRepoRoot(), "TheFile.txt");

Security

• ClaimsPrincipalExtensions: Extension methods to get a user ID and roles.
  • GetUserId
  • GetRoles

Extensions

• StringExtensions: Extension methods for System.String
  • ValidateUrlString: Extension method to validate a URL string by checking to make sure the string is formatted correctly.
  • CreateUrlSlug: Extension method modify a string so that it is URL compatible
• HttpExtensions: Extension methods for System.Net.Http.HttpClient ValidateUri: Extension methods to validate a Uri by attempting to make a GET request to it.
• SystemLinqExtensions
  • WhereNotNull: Extension method to allow return of non-null value from a null object.

    • Sample:

      List<string?> listWithSomeNullValues = ["this", null, "is", null, "my", null, "favorite", null];
      List<string> listWithoutNullValues = listWithSomeNullValues.WhereNotNull().ToList();
      // returns ["this", "is", "my", "favorite"]

    • On:

      • System.Linq.Generic.IEnumerable<T>

Contributing

See the CONTRIBUTING.md file here.

If you have any problems, please feel free to check for existing issues or open a new issue.

essentialcsharp.web's Issues

Add integration test

Add Captcha to prevent/limit scraping

Have it pop up on some pages after a certain amount of time/number of pages navigated through to be completed before being able to see more content

Unsupress CA1848 from .editorconfig

CA1848: Use the LoggerMessage delegates

dotnet_diagnostic.CA1848.severity = suggestion

Check and investigate Ping Google with new sitemap not working

Discuss how to better page navigation using keys without breaking normal highlighting functionality

Discussed in #245

^{Originally posted by YousefImran October 19, 2023}
I will prefix this by saying I don't know much about the tool yet, so ignorance is present.
That being said, when I am typing notes on a highlight and trying to use the arrow keys (mainly left and right to move between letters) it seems that these keys have predefined functionality which is move between the highlights themselves or maybe move back and forth between the pages I am currently on.

Is there a way to avoid this? Maybe a setting or something where the arrow keys are just working within their context, as in, if the courser is on text, move between the text rather than move between notes or pages.

This has been very frustrating unfortunately and I appreciate any feedback.

Thank you.

Push sitemap.xml to site

Extra spacing below footer

The UI has some extra spacing at the bottom of the page below the footer:

Add links to Intellitect

Result codes not reporting correctly for error pages

A incorrect page (ex: https://essentialcsharp.com/ImplementingValueEquality ) returns back a 200 code, should return a code indicating an error.

Only load up commonly used passwords into hashtable if they could be possibly valid with other validation

With things like min pass length, etc, not all passwords in the commonly used passwords are actually valid, so we could store less in the hash table by parsing through them when loading up the hash set only if they pass our other password requirements

Draft design for NLQ interface

Draft a design for the upcoming NLQ (Natural Language Query) interface. Make it look like ChatGippty.

Add links to be able to get the book

Add Captcha to Necessary Secure Account Areas

• Login Page
• Register Page
• Resend Email Verification Page
• Reset Password Page

Support Placeholder content if a user doesn't have access to nuget feed

Code block Fonts

I may have been unwise to use the all powerful selector html * for setting the font family to san serif as the selector code-line doesn't specify a font and so is using san-serif:

Either we should take advantage of inheritance (code-lines is parent of code-line and has serif font) by moving the san-serif font-family prop to the body tag selector (which will allow for inheritance, versus the html *), or add the mono-spaced font-family to the code-line selector. Either I think is fine.

Fix pipeline

Update projects to use Centralize Package Management

Consider implementing IProtectedUserStore

Or maybe just work with the DB?

Make sure "unauthorized" developers have a way to build and develop application

Page Nav Arrows Is Not Navigating Properly

          Weird bug when I press the left arrow key a bunch.

Originally posted by @BenjaminMichaelis in #58 (comment)

Add book cover

Referrer Id's?

Be able to track how many people you've forwarded links to?

Improve search

Maybe https://github.com/typesense is an option?

Create cool homepage graphic for site

We need a cool graphic/image here:

On successful deployment to prod, cancel pending deployments

Add line numbers to listings

We should add line numbers to listing to make talking about the code in the listings easier. The line numbers should reflect the rendered lines not the source line numbers.

Provide useful "go back" or fix sidebar upon error

I get stuck on this page and either have to go home or fix url to get anywhere.

I don't think this is a valid command.

The second method uses the define command line. Output 4.27 demonstrates this with Dotnet command-line interface.

Output 4.27
>dotnet.exe -define:CSHARP2PLUS TicTacToe.cs

dotnet TicTacToe.cs cannot be used to compile the .cs source code, right?