YAML Formatting Full Guide: Indent, Multi-document Interchange with JSON

1. What exactly does YAML care about in the project?

YAML (YAML Ain't Markup Language) is a human-oriented data sequenced language that is widely found in:

• Packagings and organization:docker-compose.yml、Kubernetes Deployment / Service
• CI/CD: GitHub Actions, GitLab CI, Part Jenkins Configuration
• Apply configuration: Spring application.yml、Ansible playbook、Helm values
• Content and metadata: Some static station Frontmatter, OpenAPI YAML form

It's selling place. Readable: Indentable, annotated, and indentable. The price is... It's extremely sensitive to the blanks., and the same paragraph does not exactly agree on the "repeated key, anchor, type guess" on the different solvers (PyyamL, js-yaml, Go yaml.v3, SnakeYAML).

This station tool is based on the browser js-yaml: The input box is pasted and verified in real time; "Beautified Yaml" dump rewrite in 2 spaces; "Concentration" goes low style; And support Yaml↔json. Processing is done locally and the key configuration should be unsensitized before it is pasted.

Indentation, scale and list: rules that must be carved into muscle memory

Use only spaces, not Tab

YAML 1.1/1.2 In practice,Indentation should use spaces。 If the editor shows Tab as "looks aligned", the solver may still be misoriented or a hierarchy confused. The team should unify 2 spaces (common K8s/ GitHub Operations) or 4 spaces and open "Spacing instead of Tab" in the editor.

Align with peer, sub-level multi-indent one

# Legal：Same级KeysLeft缘Alignment，SonKeysMore 2 spaces
server:
  host: localhost
  port: 8080
  ssl:
    enabled: true

Here we go.Intentional unlawfulExample (child keys are left-side or same-graded than parent keys):

# Intentional unlawful
server:
host: localhost
  port: 8080

List Item - Location

- (a) A space after which normally; list to align the embedded map with the content column:

containers:
  - name: web
    image: nginx:1.25
  - name: sidecar
    image: busybox

When strings must be quoted

# - Yes.险：某些Parsing器Yes.- Put it on. yes When?Done. true
feature_flag: yes

# More稳妥
feature_flag: "yes"
version: "1.10"
message: "error: not found"

Multi-document and document header

--- Split multiple documents;... Can end the document (less handwritten). A list in K8s often contains multiple resources and is composing it in a file with multiple documents.

apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
---
apiVersion: v1
kind: Secret
metadata:
  name: app-secret

Tool boundary: Page Verify Usage jsyaml.loadYeah.Multi-document stringIt may only resolve the first paragraph or direct error, depending on the type of input. Multi-document list suggests that a break check be pasted or that you first confirm how your target is loaded when running (kubectl); Do not assume "webpage once = kubectl apply all documents".

3. YAML and JSON: Differences and Detriment Points

The two often rotate, but not the purely information equivalent.

When to stay in Yaml: Configure read people, require comment and anchor reuse, organize and list CI. When did you turn it? Interface debugging, frontend JSON.parse, needs and needs JSON Format / Diff Tool Chain Interconnection. Special conversion page: If your main task is to repeat JSON↔YAML without emphasizing "YAML beautification" it is possible to use it. JSON ↔ YAML； This is the main tool forVerify + beautify + Compress + InterchangePut it on one screen, and leave the tab free when you are wrong.

Cross-check: Two ways of building the same structure

YAML：

user:
  id: 1001
  name: Ada
  roles:
    - admin
    - editor
  active: true

Equivalent

{
  "user": {
    "id": 1001,
    "name": "Ada",
    "roles": ["admin", "editor"],
    "active": true
  }
}

Put the Yaml in active: yes When converted to JSON, it could become true , not string "yes"– It's a type guess, not a formatted "bracked field name."

4. Processing in KiloCell of cells YAML: step by step

tools page:YAML Format。

1. Open the page. Enter /tools/dev/yaml-formatter, "Input YAML/JSON" on the left, and "Process results" on the right.
2. Paste content. The idea is to be able to "load examples" and get familiar with layouts. The real configuration should be removed, the password, Token, and the private key.
3. Look at the status bar. When entering oninput Trigger verification: Successfully showed "YAML format correct" Failed to display error message for js-yaml (indent by line when containing line/column thread first).
4. Beautify。 Dot "Beautification Yaml": In a position load Under the condition, use 2 spaces dump To Right (Present)lineWidth: -1、noRefs: true, avoid anchor reference to interfere with reading.
5. Minify。 Point "Cressed YamL": To keep the gap as tight as possible in a low style, allowing comparison of "deconstructed structure" rather than reading.
6. Turn on JSON. JSON after the output "YAML to JSON" output; It's more usable. JSON Format Do it again or compress.
7. JSON THROUGH YAML. If it's JSON, do "JSON turns Yamal" on the left; Illegal JSON will report in status bar JSON.parse Error。
8. Copy with empty. The input/result area can be "reproduced"; The "cleaning up" is both on both sides and in the state.

Capacity boundaries (relative to real pages)

• Support: Syntaxual validation, beautification dump, low compression, Yaml→JSON, JSON→YAML, example to theme.
• Unassured: (a) To retain the original note and original handwritten style; Multi-document one-time complete round-trip; All Yamal 1.1 Odd types are identical across languages and ecology.
• Security: Browser local resolution; Still, no Secret explicits are attached to untrustworthy environments.

5. Common errors and treatments

Suggested error order

1. Whether to mix Tab / Full Angle Space.
2. Near the wrong line. :、-, whether the quotation marks are paired.
3. Type guesses whether the string is to be fed as a boolean/number.
4. Whether the multiple documents only check a single paragraph.
5. The last thing I doubt is that business field names are misspelled.

6. Real work scene

A:kubectl apply rejected, suspected indentation

Copy relevant clips (de-sensitization) from the failed list and post them. Change the status column by line number if it is directly misreported; If this is verified, then the API version, the mandatory fields or the RBAC - Formatting tool only proves that "this is a valid YamL object tree" and that "clusters accept the resource".

The B: GitHub Actions with: I don't know why.

run: Multi-script,with: Down : Strings are the easiest to blow. (a) To post the job clip into the tool to verify; Use quotes or block marks for messages with colons (in KiloCell of years)| / >）。 Admiral and then post the clip back to the workflow file, avoiding changing the full repository key on the web page.

Scenario C: Backend to JSON, Mission YAML values

A left-end interface sample is used by JSON to copy "JSON to YAML" to a Helm Values draft. Artificial restatement and environmental differences. If JSON is big, first JSON Format Confirms the legal and compressed field cognitive burden.

Scene D: Code Review "System, Different Styles"

Each of the two parties posted a YaML, which was beautified to 2 spaces and diff (editor or special diff). The government has also been working to reduce the interference of the "space war" with the logic review. Note: The beautification will lose the comment, the report comment needs to read the original document.

scene E: Spectacular configurations due to suspicious type

The same one is configured in Node and the Python service is not the same. Turn to JSON and look at each leaf of the JSON type; Adds a single quote to the version number, country code, starting with 0, to remove guesses from the source.

Scenario F: Teaching "Why can't you copy from chat software?"

Demonstration: Strange blanks from the copy of rich text failed to verify; Pure text or "load examples" successfully. The newer is a custom of "configuring only the code library and plain text".

8. How to select the tools

Selection tips:YaML misformatted page validation; Only JSON/YAML bridge converter; Enter JSON after ecology using JSON tool chain.

FAQ

Continue reading

First, you use the "load the example" to read "paint the tape" and "see the status bar to be beautiful and turn JSON" and then you take the real de-sensitization clip against the wrong table. Open JSON formatting when pure JSON is wrong; Open JSON↔AML when bridge conversion is required.