Ignoring the JSON comment errors in your SPFx solutions

July 6, 2020

Something that bothers me for a long time is the comments in the SharePoint Framework component JSON manifest files. As you may know, JSON does not allow you to add comments to its content. Visual Studio Code will show some errors for it as well.

VSCode comment errors in JSON
VSCode comment errors in JSON

I understand that comments are needed. These comments make it easier for developers to understand what the properties/attributes/values mean.

VSCode comment errors in JSON
VSCode comment errors in JSON

Providing these comments in the JSON file itself is more natural than pointing to a website/documentation page. That is also why they created the JSONC file format, which allows you to add comments in JSON files. As SharePoint Framework projects are still using JSON files instead of JSONC, I wanted to find a quick fix.

The quick fix number one

The first way would be to remove these comments from the file. I know it is not ideal, but it works.

The quick fix number two

Did you know you could tell Visual Studio Code to treat your JSON files as JSONC? You can do this with the files.associations setting in VSCode. You can add this setting on workspace (you need to add it for each project) or user (add it once, works for all projects) level.

My default files.associations the setting looked like this:

1
2
3
"files.associations": {
  "*.master": "html"
}

To tell VSCode to treat JSON as JSONC, all you need to do is add this line:

1
2
3
4
"files.associations": {
  "*.master": "html",
  "*.json": "jsonc"
}

One downside is that now all JSON files are treated as JSONC files. It could be that some of your pipelines might fail if you have to do JSON validation. To overcome this, you can be a bit more specific and add *.manifest.json as the file association. That way, it will only ignore the errors for the component manifest files.

1
2
3
4
"files.associations": {
  "*.master": "html",
    "*.manifest.json": "jsonc"
}
VSCode ignoring the comments - this is much more relaxing
VSCode ignoring the comments - this is much more relaxing

Happy coding

Comments

comments powered by Disqus