Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
kettei-sproutty opened this issue Jun 24, 2024 · 1 comment · Fixed by #8596
Closed

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

kettei-sproutty opened this issue Jun 24, 2024 · 1 comment · Fixed by #8596

Comments

@kettei-sproutty
Copy link
Contributor

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:

  • Almost all code blocks contains trailing commas on last values
  • Some commas are missing

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants