.NET Core 3.1 CreateHostBuilder Cannot parse JSON file

Question

I am experiencing an error when trying to run my ASP.Net Core 3.1 project. The error is at CreateHostBuilder within Program.cs

   public class Program {
        public static void Main(string[] args) {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
    }

which has not been edited from the default ASP.NET Core Web application template from Visual Studio 2019. It gives the exception

System.FormatException: 'Could not parse the JSON file.'

It does not however refer exactly to what JSON file it's failing to parse. Here is a pastebin with all 3 existing JSON files it could be parsing.

Here is the full error stack:

  HResult=0x80131537
  Message=Could not parse the JSON file.
  Source=Microsoft.Extensions.Configuration.Json
  StackTrace:
   at Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(Stream stream)
   at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at Microsoft.Extensions.Configuration.FileConfigurationProvider.HandleException(ExceptionDispatchInfo info)
   at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
   at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load()
   at Microsoft.Extensions.Configuration.ConfigurationRoot..ctor(IList`1 providers)
   at Microsoft.Extensions.Configuration.ConfigurationBuilder.Build()
   at Microsoft.Extensions.Hosting.HostBuilder.BuildAppConfiguration()
   at Microsoft.Extensions.Hosting.HostBuilder.Build()
   at <filename>.Main(String[] args) in <filename>:line 13

  This exception was originally thrown at this call stack:
    System.Text.Json.ThrowHelper.ThrowJsonReaderException(ref System.Text.Json.Utf8JsonReader, System.Text.Json.ExceptionResource, byte, System.ReadOnlySpan<byte>)
    System.Text.Json.Utf8JsonReader.ReadSingleSegment()
    System.Text.Json.Utf8JsonReader.Read()
    System.Text.Json.JsonDocument.Parse(System.ReadOnlySpan<byte>, System.Text.Json.Utf8JsonReader, ref System.Text.Json.JsonDocument.MetadataDb, ref System.Text.Json.JsonDocument.StackRowStack)
    System.Text.Json.JsonDocument.Parse(System.ReadOnlyMemory<byte>, System.Text.Json.JsonReaderOptions, byte[])
    System.Text.Json.JsonDocument.Parse(System.ReadOnlyMemory<char>, System.Text.Json.JsonDocumentOptions)
    System.Text.Json.JsonDocument.Parse(string, System.Text.Json.JsonDocumentOptions)
    Microsoft.Extensions.Configuration.Json.JsonConfigurationFileParser.ParseStream(System.IO.Stream)
    Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(System.IO.Stream)

Inner Exception 1:
JsonReaderException: '{' is an invalid start of a property name. Expected a '"'. LineNumber: 2 | BytePositionInLine: 4

It began when I started to use VS Code instead of Visual Studio which I normally use. The project however can run successfully on another Windows machine that's only ever run Visual Studio. I've tried a few things and I'm out of ideas. Here are the steps I have tried:

1. Confirmed with 2 other colleagues that appsettings.json, appsettings.Development.json and launchSettings.json do not have syntax errors as resolved in this thread
2. Confirmed they are all encoded with UTF-8 without BOM as suggested in this thread
3. Closing Visual Studio 2019, deleting the .vs folder, opening and then running again
4. Closing Visual Studio Code, deleting the .vscode folder, opening and then running again
5. Switched branches and previous commits.
6. Confirmed there is no user secrets configuration within .csproj
7. Deleting the repo files locally and cloning it again
8. Restarting the PC entirely
9. Creating a new templated ASP.NET Core Web Application within Visual Studio. It ran successfully.
10. Confirmed that args value is a string array of size [1]. The [0] position is used and contains the string %LAUNCHER_ARGS%. The environment variable does not appear in app.config or within Windows. I confirmed args is still the same and functions with the test pure template project.

Solution 1

Not to sound like a broken record, but anyone facing this issue, please ensure that your appsettings.json is properly formatted.

I found that in my case, escape characters were not properly set in my connection string. Instead of having .\\MSSQLSERVER, I had .\MSSQLSERVER.

If you have a test instance on your local machine, kindly take out the connection string for the cloud and replace it with that of the local machine (which should be simpler) and that should lead you in the right direction.

Solution 2

I had the same problem in starting a webApi on the same version of Asp.net Core. The problem was missing a curlybrace in appsettings.json

Solution 3

I had a similar issue with the same exception i.e. JsonReaderException: '}' is invalid after a single JSON value. Expected end of data. LineNumber: 13 | BytePositionInLine: 0.

When I examined appsettings.json file, I noticed a squiggly on the "}". This is where the problem was. Turned out that I had an extra "}" in my appsettings.json file. Some might have a missing curly brace. Rest assured, the problem lies here.

Solution 4

I got this error recently and the top comments weren't that helpful at solving it. So first of all this error 100% related to a JSON file not being formatted correctly. However the top comments don't really tell you which files you should examine to find the error.

A list of files you need to check to make sure it works:

• appsettings.[environment-build] (This is likely the source in 99% of cases)
• serviceDependencies.[area].json
• Secrets.json
• launchSettings.json

Appsettings is found in your project directory.

LaunchSettings and service Dependencies is found in your Properties folder.

Secrets file is best found by going to Connected Services (Note this applies to Visual Studio).

For my case my Secrets file was causing the issue. Note this isn't a complete list for every project ever made, but it should at least point you in the right direction instead of spending a few hours quadruple-checking your app settings files.

Solution 5

Yes it is working once appsettings.json file properly updated as:

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*"
}

View more solutions

Comments

[Chidi-Nwaneto]

Your answer was very helpful, thanks so much

[NobleGuy]

Same for me. Thanks a lot!

[misterbee180]

For some reason it all of a sudden started erroring and this was the cause. But I checked my change logs and the specific change was checked in a while ago so it was strange it started suddenly. Thanks for this!