feat(elements): make `<legend>` in `<fieldset>` optional (covered by new h71 rule instead)

f3a59b91 · David Sveningsson · 1b8ceab7 · f3a59b91 · f3a59b91 · f3a59b91
Commit f3a59b91 authored Feb 06, 2020 by David Sveningsson
3 changed files
--- a/docs/guide/metadata/restrict-content.md
+++ b/docs/guide/metadata/restrict-content.md
@@ -105,29 +105,32 @@ The most common case is to prevent nesting of the component or limit usage of ce

 Other properties to limit content also exits, check the [element metadata reference](/usage/elements.html) for details.

-### Case study: `<fieldset>`
+### Case study: `<html>`
+
+(simplified for brevity)

 ```json
 {
-  "fieldset": {
-    "flow": true,
-    "permittedContent": ["@flow", "legend?"],
-    "permittedOrder": ["legend", "@flow"],
-    "requiredContent": ["legend"]
+  "html": {
+    "permittedContent": ["head?", "body?"],
+    "permittedOrder": ["head", "body"],
+    "requiredContent": ["head", "body"]
  }
 }
 ```

-Like we seen before the `permittedContent` property is used to restrict to only accept flow content and the `<legend>` element.
-Note the usage of a trailing `?` after legend, this limits the allowed occurrences to 0 or 1 (2 or more is disallowed).
+Like we seen before the `permittedContent` property is used to restrict to only accept the `<head>` and `<body>` elements.
+Note the usage of a trailing `?`, this limits the allowed occurrences to 0 or 1 (2 or more is disallowed).
+Default is to allow any number of occurrences.

-Next it uses `permittedOrder` to declare that `<legend>` must come before any flow content.
-`permittedOrder` must not list all the possible elements from `permittedContent` but for the items listed the order must be adhered to.
-Unlisted elements can be used in any order.
+Next it uses `permittedOrder` to declare that `<head>` must come before `<body>`.
+`permittedOrder` doesnt have to list all the possible elements from `permittedContent` but for the items listed the order must be adhered to.
+Contents groups such as `@flow` is allowed and unlisted elements can be used in any anywhere (even inbetween listed elements).

-Lastly it uses `requiredContent` to declare that a `<legend>` element must be present.
+Lastly it uses `requiredContent` to declare that both `<head>` and `<body>` must be present.

-To sum up, the `<fieldset>` elements puts the following restrictions in place:
+To sum up, the `<html>` elements puts the following restrictions in place:

- It must contain a single `<legend>` element.
- The `<legend>` element must come before any other content.
+- It must contain a single `<head>` element.
+- It must contain a single `<body>` element.
+- The `<head>` element must come before the `<body>` element.
--- a/elements/__snapshots__/html5.spec.ts.snap
+++ b/elements/__snapshots__/html5.spec.ts.snap
@@ -1708,23 +1708,9 @@ exports[`HTML elements <embed> valid markup 1`] = `Array []`;
 exports[`HTML elements <fieldset> invalid markup 1`] = `
 Array [
  Object {
-    "errorCount": 3,
+    "errorCount": 2,
    "filePath": "test-files/elements/fieldset-invalid.html",
    "messages": Array [
-      Object {
-        "column": 2,
-        "context": Object {
-          "missing": "legend",
-          "node": "fieldset",
-        },
-        "line": 2,
-        "message": "<fieldset> element must have <legend> as content",
-        "offset": 29,
-        "ruleId": "element-required-content",
-        "selector": "fieldset:nth-child(1)",
-        "severity": 2,
-        "size": 8,
-      },
      Object {
        "column": 2,
        "context": undefined,

--- a/elements/html5.json
+++ b/elements/html5.json
@@ -300,8 +300,7 @@
    },
    "deprecatedAttributes": ["datafld"],
    "permittedContent": ["@flow", "legend?"],
-    "permittedOrder": ["legend", "@flow"],
-    "requiredContent": ["legend"]
+    "permittedOrder": ["legend", "@flow"]
  },

  "figcaption": {