#1143 update deeper nesting

See https://patternlab.io/docs/overview-of-patterns/#heading-deeper-nesting

Author: JosefBredereck

packages/core/src/lib/object_factory.js

@@ -258,7 +258,7 @@ Pattern.prototype = {
    *
    * @param {Patternlab} patternlab Current patternlab instance
    */
-  promoteFromDirectoryToFlatPattern: function(patternlab) {
+  promoteFromFlatPatternToDirectory: function(patternlab) {
     const p = new Pattern(this.relPath, this.jsonFileData, patternlab, true);
     // Only reset the specific fields, not everything
     Object.assign(this, {

packages/core/src/lib/readDocumentation.js

@@ -56,11 +56,12 @@ module.exports = function(pattern, patternlab) {
       }
 
       if (
-        markdownObject.hasOwnProperty('subfolder') &&
-        !markdownObject.subfolder
+        !markdownObject.hasOwnProperty('deeplyNested') ||
+        (markdownObject.hasOwnProperty('deeplyNested') &&
+          !markdownObject.deeplyNested)
       ) {
         // Reset to pattern without own pattern-directory
-        pattern.promoteFromDirectoryToFlatPattern(patternlab);
+        pattern.promoteFromFlatPatternToDirectory(patternlab);
       }
     } else {
       logger.warning(`error processing markdown for ${pattern.patternPartial}`);

packages/docs/src/docs/pattern-organization.md

@@ -50,3 +50,12 @@ Node versions support nesting of folders under `patternSubtype`. For example, yo
 In this example the `media-block/` directory is ignored for the purposes of generating breadcrumbs and navigation in the Pattern Lab front-end but the documentation, pattern and pseudo-patterns are still rendered.
 
 Folders can be nested under `media-block/` if desired but this is discouraged because of possible collisions when using the [shorthand partial syntax](/docs/including-patterns/).
+
+### Deeper Nesting Settings
+
+As documented in [Documenting Patterns](/docs/documenting-patterns/) there are several options to handle the patterns state or add additional information.
+
+The `deeplyNested` attribute is used to toggle the pattern building behavior and toggles the deeper nesting.
+
+- **deeplyNested not set or false**  - Pattern won't be handled as a deeply nested pattern
+- **deeplyNested: true**  - Pattern will be handled like mentioned under [Deeper Nesting](#heading-deeper-nesting)