do not show errors for trailing commas in web JSON editors (#4100)

fix #4008 All JSON documents we use (for settings, site config, external services, and extension manifests) support trailing commas on the frontend and backend. However, an upgrade to monaco-editor unexpectedly caused the Monaco JSON editors in our UI to show red squiggly errors for trailing commas. The (undocumented) way to do this is to add `allowComments` to the root of the JSON Schema. It is not sufficient to set `allowComments: true` in a `monaco.languages.json.jsonDefaults.setDiagnosticsOptions` call. I found this secret fix by finding microsoft/vscode#19992 (comment) and then inferring what changes that might entail, to discover `allowComments` in the JSON Schema is responsible for ignoring trailing comma errors.
sourcegraph · May 17, 2019 · 82776ae · 82776ae
1 parent c1a143b
commit 82776ae
Show file tree

Hide file tree

Showing 20 changed files with 20 additions and 0 deletions.
diff --git a/schema/aws_codecommit.schema.json b/schema/aws_codecommit.schema.json
@@ -3,6 +3,7 @@
   "$id": "aws_codecommit.schema.json#",
   "title": "AWSCodeCommitConnection",
   "description": "Configuration for a connection to AWS CodeCommit.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["region", "accessKeyID", "secretAccessKey", "gitCredentials"],

diff --git a/schema/aws_codecommit_stringdata.go b/schema/aws_codecommit_stringdata.go
diff --git a/schema/bitbucket_server.schema.json b/schema/bitbucket_server.schema.json
@@ -3,6 +3,7 @@
   "$id": "bitbucket_server.schema.json#",
   "title": "BitbucketServerConnection",
   "description": "Configuration for a connection to Bitbucket Server.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["username", "url", "repositoryQuery"],

diff --git a/schema/bitbucket_server_stringdata.go b/schema/bitbucket_server_stringdata.go
diff --git a/schema/critical.schema.json b/schema/critical.schema.json
@@ -3,6 +3,7 @@
   "$id": "critical.schema.json#",
   "title": "Critical configuration",
   "description": "Critical configuration for a Sourcegraph site.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "properties": {

diff --git a/schema/critical_stringdata.go b/schema/critical_stringdata.go
diff --git a/schema/github.schema.json b/schema/github.schema.json
@@ -3,6 +3,7 @@
   "$id": "github.schema.json#",
   "title": "GitHubConnection",
   "description": "Configuration for a connection to GitHub or GitHub Enterprise.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["url", "token", "repositoryQuery"],

diff --git a/schema/github_stringdata.go b/schema/github_stringdata.go
diff --git a/schema/gitlab.schema.json b/schema/gitlab.schema.json
@@ -3,6 +3,7 @@
   "$id": "gitlab.schema.json#",
   "title": "GitLabConnection",
   "description": "Configuration for a connection to GitLab (GitLab.com or GitLab self-managed).",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["url", "token", "projectQuery"],

diff --git a/schema/gitlab_stringdata.go b/schema/gitlab_stringdata.go
diff --git a/schema/gitolite.schema.json b/schema/gitolite.schema.json
@@ -3,6 +3,7 @@
   "$id": "gitolite.schema.json#",
   "title": "GitoliteConnection",
   "description": "Configuration for a connection to Gitolite.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["prefix", "host"],

diff --git a/schema/gitolite_stringdata.go b/schema/gitolite_stringdata.go
diff --git a/schema/other_external_service.schema.json b/schema/other_external_service.schema.json
@@ -3,6 +3,7 @@
   "$id": "other_external_service.schema.json#",
   "title": "OtherExternalServiceConnection",
   "description": "Configuration for a Connection to Git repositories for which an external service integration isn't yet available.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "required": ["repos"],

diff --git a/schema/other_external_service_stringdata.go b/schema/other_external_service_stringdata.go
diff --git a/schema/phabricator.schema.json b/schema/phabricator.schema.json
@@ -3,6 +3,7 @@
   "$id": "phabricator.schema.json#",
   "title": "PhabricatorConnection",
   "description": "Configuration for a connection to Phabricator.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "anyOf": [{ "required": ["token"] }, { "required": ["repos"] }],

diff --git a/schema/phabricator_stringdata.go b/schema/phabricator_stringdata.go
diff --git a/schema/settings.schema.json b/schema/settings.schema.json
@@ -3,6 +3,7 @@
   "$id": "settings.schema.json#",
   "title": "Settings",
   "description": "Configuration settings for users and organizations on Sourcegraph.",
+  "allowComments": true,
   "type": "object",
   "properties": {
     "search.savedQueries": {

diff --git a/schema/settings_stringdata.go b/schema/settings_stringdata.go
diff --git a/schema/site.schema.json b/schema/site.schema.json
@@ -3,6 +3,7 @@
   "$id": "site.schema.json#",
   "title": "Site configuration",
   "description": "Configuration for a Sourcegraph site.",
+  "allowComments": true,
   "type": "object",
   "additionalProperties": false,
   "properties": {

diff --git a/schema/site_stringdata.go b/schema/site_stringdata.go