codesandbox / codesandbox/codesandbox-client

settings.json: Quotes are being removed from nested JSON object keys

Open
#5,921 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
13.6k
Forks
2.4k
Avg merge
6d 19h
Merged PRs (30d)
2

Description

🐛 bug report

Preflight Checklist

  • I have read the Contributing Guidelines for this project.
  • I agree to follow the Code of Conduct that this project
    adheres to.
  • I have searched the issue tracker for an issue that matches the one I want
    to file, without success.

Description of the problem

When adding nested properties to settings.json, reloading the page after some amount of time or work removes double quotes from all property keys (see example).

I encountered this problem on my first day of usage. My only changes were to add a vim keybinding to settings.json, and nothing else, so hopefully the steps I've provided are reproducible.

Immediate reloads don't produce this error, so I'm not sure exactly what the trigger is, but after every period I've actually coded for a bit, the error has occurred.

To Reproduce
  1. Open a sandbox and enable vim
  2. Add the following to settings.json:
  "vim.insertModeKeyBindings": [
    {
      "before": [
        "j",
        "k",
      ],
      "after": [
        "<esc>",
      ],
    },
    {
      "before": [
        "j",
        "j",
      ],
      "after": [
        "<esc>",
      ],
    },
  ],
  1. Do some work (?).
  2. Reload the page.
  3. Error popup: Configuration: undefined missing 'after' key or 'command'.
  4. Settings.json now looks like this:
"vim.insertModeKeyBindings": [
    {
      before: [
        "j",
        "k",
      ],
      after: [
        "<esc>",
      ],
    },
    {
      before: [
        "j",
        "j",
      ],
      after: [
        "<esc>",
      ],
    },
  ],
Your Environment

| Software | Name/Version | MacOS Big Sur 11.3
| ---------------- | ------------ |
| Сodesandbox | |
| Browser | Firefox |
| Operating System | MacBook Pro 2019 16-inch |

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the nested settings.json vim.insertModeKeyBindings example and the reload sequence described. Trace how settings.json is saved and reloaded, then verify that nested property keys retain their double quotes and the configuration error no longer appears.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.