vercel / turborepo

Build system optimized for JavaScript and TypeScript, written in Rust
https://turbo.build/repo/docs
MIT License
26k stars 1.79k forks source link

Docs: formatting errors inside `code` blocks in configuring turbo.json page #8582

Closed kettei-sproutty closed 2 months ago

kettei-sproutty commented 2 months ago

What is the improvement or update you wish to see?

Hello, trying to copy a code block from Configuring turbo.json almost always require to edit the copied text, for example:

Example:

{
  "$schema": "https://turbo.build/schema.json" // missing comma
  "tasks": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**", ".next/**", "!.next/cache/**"], // trailing
    },
    "test": {
      "outputs": ["coverage/**"],
      "dependsOn": ["build"],  // trailing
    },
    "dev": {
      "cache": false,
      "persistent": true,  // trailing
    },  // trailing
  },  // trailing
}

If it is an issue and not expected and this is not duplicate (I checked but i didn't find anything specific) I would like to take care of this.

Let me know :)

Is there any context that might help us understand?

I think docs code blocks should use a more standard approach (json commas instead of jsonc).

Does the docs page already exist? Please link to it.

https://turbo.build/repo/docs/reference/configuration#tasks

tknickman commented 2 months ago

Hey @kettei-sproutty, PRs to improve this would be greatly appreciated! 🙏🏼