Implement markdown heading increment linter ( #2015 ) (#2107)

* Implement markdown heading increment linter ( #2015 )

Markdown heading increment linter implemented through remark-lint rule - "remark-lint-heading-increment"

* Downgrade "remark-lint-heading-increment" to 2.x ( #2015 )

Downgrade "remark-lint-heading-increment" to 2.x as that is compatible with the current version (7.x ) of "remark-lint" used in the repo

The latest version of "remark-lint-heading-increment" uses "unified-lint-rule" version 3.x which is not compatible with the current version of "remark-lint" used in the repo resulting in missing line numbers in the warnings thrown

"unified-lint-rule" is a unified plugin to make it easier to create linting rules. Each rule in remark-lint uses "unified-lint-rule".

* Resolved existing heading level inconsistencies ( #2015 )

Resolved existing heading level inconsistencies in the template-lifecycle-dom-and-modifiers.md file.

Author: sreeram-cv

.remarkrc.js

@@ -26,6 +26,7 @@ exports.plugins = [
   ],
   'remark-preset-lint-consistent',
   'remark-preset-lint-recommended',
+  'remark-lint-heading-increment',
   ['remark-lint-list-item-indent', 'space'],
   ['remark-lint-list-item-bullet-indent', false],
   ['remark-lint-code-block-style', false],

CONTRIBUTING.md

@@ -150,6 +150,7 @@ The guides are spellchecked and linted for markdown consistency. You can test yo
 Markdown issues that will generate errors include:
 - Lists and text must be left justified, otherwise the linter will generate indentation errors
 - Missing URL reference definitions
+- Heading levels should increment by exactly one level at a time (e.g., h1 → h2 → h3) and should not skip levels (e.g., h1 → h3 is not allowed)
 
 Most other markdown errors should be self explanatory.
 

guides/release/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v3.28.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.0.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.1.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.10.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.11.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.12.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.2.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.3.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.4.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.5.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.6.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.7.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.8.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v4.9.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.0.0/components/template-lifecycle-dom-and-modifiers.md

@@ -517,7 +517,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.1.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.10.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.11.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.12.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.2.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.3.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.4.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.5.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.6.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.7.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.8.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v5.9.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v6.0.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v6.1.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

guides/v6.2.0/components/template-lifecycle-dom-and-modifiers.md

@@ -523,7 +523,7 @@ export default class SidebarComponent extends Component {
 }
 ```
 
-#### Modifiers and `...attributes`
+### Modifiers and `...attributes`
 
 Modifiers can also be applied to components, and when they are, they are also
 passed forward and applied to an element with `...attributes`:

package.json

@@ -105,6 +105,7 @@
     "qunit-dom": "^3.3.0",
     "remark-cli": "^8.0.0",
     "remark-lint": "^7.0.0",
+    "remark-lint-heading-increment": "^2.0.0",
     "remark-preset-lint-consistent": "^3.0.0",
     "remark-preset-lint-recommended": "^4.0.0",
     "remark-retext": "^4.0.0",