BREAKING-CHANGE: Deprecate ordering by file-prefix ##- (#1252)

* Remove pattern ordering by file prefix ##-
* #1252: Remove unused code
* #1252 Update pattern doc locations
* #1252 add possibility to disable deprecation warning
* #1252 Fix dev engine twig

Author: JosefBredereck

packages/cli/test/fixtures/patternlab-config.json

@@ -46,8 +46,8 @@
 					"node_modules/@pattern-lab/uikit-workshop/views/partials/general-footer.mustache",
 				"patternSection":
 					"node_modules/@pattern-lab/uikit-workshop/views/partials/patternSection.mustache",
-				"patternSectionSubtype":
-					"node_modules/@pattern-lab/uikit-workshop/views/partials/patternSectionSubtype.mustache",
+				"patternSectionSubgroup":
+					"node_modules/@pattern-lab/uikit-workshop/views/partials/patternSectionSubgroup.mustache",
 				"viewall":
 					"node_modules/@pattern-lab/uikit-workshop/views/viewall.mustache"
 			},

packages/core/docs/events.md

@@ -61,7 +61,7 @@ Emitted after patterns are iterated over to gather data about them. Right before
 
 #### `EVENTS~PATTERNLAB_BUILD_GLOBAL_DATA_END`
 
-Emitted after global `data.json` and `listitems.json` are read, and the supporting Pattern Lab templates are loaded into memory (header, footer, patternSection, patternSectionSubType, viewall). Right before patterns are iterated over to gather data about them.
+Emitted after global `data.json` and `listitems.json` are read, and the supporting Pattern Lab templates are loaded into memory (header, footer, patternSection, patternSectionSubgroup, viewall). Right before patterns are iterated over to gather data about them.
 
 **Kind**: inner property of [<code>EVENTS</code>](#exp_module_Events--EVENTS)  
 **Properties**

packages/core/patternlab-config.json

@@ -46,8 +46,8 @@
           "views/partials/general-footer.mustache",
         "patternSection":
           "views/partials/patternSection.mustache",
-        "patternSectionSubtype":
-          "views/partials/patternSectionSubtype.mustache",
+        "patternSectionSubgroup":
+          "views/partials/patternSectionSubgroup.mustache",
         "viewall":
           "views/viewall.mustache"
       },

packages/core/src/index.js

@@ -10,8 +10,6 @@
 
 'use strict';
 
-const path = require('path');
-
 const updateNotifier = require('update-notifier');
 
 const packageInfo = require('../package.json');

packages/core/src/lib/buildFooter.js

@@ -10,7 +10,7 @@ let render = require('./render'); //eslint-disable-line prefer-const
 /**
  * Builds footer HTML from the general footer and user-defined footer
  * @param patternlab - global data store
- * @param patternPartial - the partial key to build this for, either viewall-patternPartial or a viewall-patternType-all
+ * @param patternPartial - the partial key to build this for, either viewall-patternPartial or a viewall-patternGroup-all
  * @returns A promise which resolves with the HTML
  */
 module.exports = function(patternlab, patternPartial, uikit) {

packages/core/src/lib/buildPatterns.js

@@ -15,7 +15,7 @@ const processMetaPattern = require('./processMetaPattern');
 const pe = require('./pattern_exporter');
 const lh = require('./lineage_hunter');
 const pm = require('./plugin_manager');
-const pluginMananger = new pm();
+const pluginManager = new pm();
 const markModifiedPatterns = require('./markModifiedPatterns');
 const parseAllLinks = require('./parseAllLinks');
 const render = require('./render');
@@ -27,7 +27,7 @@ let pattern_exporter = new pe(); // eslint-disable-line
 const lineage_hunter = new lh();
 
 module.exports = async (deletePatternDir, patternlab, additionalData) => {
-  await pluginMananger.raiseEvent(
+  await pluginManager.raiseEvent(
     patternlab,
     events.PATTERNLAB_BUILD_START,
     patternlab
@@ -72,7 +72,7 @@ module.exports = async (deletePatternDir, patternlab, additionalData) => {
     return patternlab
       .processAllPatternsIterative(paths.source.patterns)
       .then(async () => {
-        await pluginMananger.raiseEvent(
+        await pluginManager.raiseEvent(
           patternlab,
           events.PATTERNLAB_PATTERN_ITERATION_END,
           patternlab
@@ -94,12 +94,12 @@ module.exports = async (deletePatternDir, patternlab, additionalData) => {
             //perhaps we can check for a convention like [uikitname]_00-head.mustache, and if found, add them to patternlab.uikits[uikitname].userFoot
             //then, if present, use those during compose()
             const headPatternPromise = processMetaPattern(
-              `_00-head.${patternlab.config.patternExtension}`,
+              `_head.${patternlab.config.patternExtension}`,
               'userHead',
               patternlab
             );
             const footPatternPromise = processMetaPattern(
-              `_01-foot.${patternlab.config.patternExtension}`,
+              `_foot.${patternlab.config.patternExtension}`,
               'userFoot',
               patternlab
             );

packages/core/src/lib/compose.js

@@ -9,7 +9,7 @@ const parseLink = require('./parseLink');
 const render = require('./render');
 const uikitExcludePattern = require('./uikitExcludePattern');
 const pm = require('./plugin_manager');
-const pluginMananger = new pm();
+const pluginManager = new pm();
 
 const Pattern = require('./object_factory').Pattern;
 const CompileState = require('./object_factory').CompileState;
@@ -32,7 +32,7 @@ module.exports = async function(pattern, patternlab) {
   pattern.patternLineageEExists =
     pattern.patternLineageExists || pattern.patternLineageRExists;
 
-  await pluginMananger.raiseEvent(
+  await pluginManager.raiseEvent(
     patternlab,
     events.PATTERNLAB_PATTERN_BEFORE_DATA_MERGE,
     patternlab,
@@ -116,13 +116,13 @@ module.exports = async function(pattern, patternlab) {
           pattern.patternLineageExists || pattern.patternLineageRExists,
         patternDesc: pattern.patternDescExists ? pattern.patternDesc : '',
         patternBreadcrumb:
-          pattern.patternGroup === pattern.patternSubGroup
+          pattern.patternGroup === pattern.patternSubgroup
             ? {
-                patternType: pattern.patternGroup,
+                patternGroup: pattern.patternGroup,
               }
             : {
-                patternType: pattern.patternGroup,
-                patternSubtype: pattern.patternSubGroup,
+                patternGroup: pattern.patternGroup,
+                patternSubgroup: pattern.patternSubgroup,
               },
         patternExtension: pattern.fileExtension.substr(1), //remove the dot because styleguide asset default adds it for us
         patternName: pattern.patternName,
@@ -175,7 +175,7 @@ module.exports = async function(pattern, patternlab) {
               ///////////////
               // WRITE FILES
               ///////////////
-              await pluginMananger.raiseEvent(
+              await pluginManager.raiseEvent(
                 patternlab,
                 events.PATTERNLAB_PATTERN_WRITE_BEGIN,
                 patternlab,
@@ -190,7 +190,7 @@ module.exports = async function(pattern, patternlab) {
                 uikit.outputDir
               );
 
-              await pluginMananger.raiseEvent(
+              await pluginManager.raiseEvent(
                 patternlab,
                 events.PATTERNLAB_PATTERN_WRITE_END,
                 patternlab,

packages/core/src/lib/events.js

@@ -30,7 +30,7 @@ const EVENTS = Object.freeze({
   PATTERNLAB_PATTERN_ITERATION_END: 'patternlab-pattern-iteration-end',
 
   /**
-   * @desc Emitted after global `data.json` and `listitems.json` are read, and the supporting Pattern Lab templates are loaded into memory (header, footer, patternSection, patternSectionSubType, viewall). Right before patterns are iterated over to gather data about them.
+   * @desc Emitted after global `data.json` and `listitems.json` are read, and the supporting Pattern Lab templates are loaded into memory (header, footer, patternSection, patternSectionSubgroup, viewall). Right before patterns are iterated over to gather data about them.
    * @property {object} patternlab - global data store
    */
   PATTERNLAB_BUILD_GLOBAL_DATA_END: 'patternlab-build-global-data-end',

packages/core/src/lib/exportData.js

@@ -31,8 +31,8 @@ module.exports = function(patternlab, uikit) {
 
   //navItems
   output +=
-    'var navItems = {"patternTypes": ' +
-    JSON.stringify(patternlab.patternTypes) +
+    'var navItems = {"patternGroups": ' +
+    JSON.stringify(patternlab.patternGroups) +
     ', "ishControlsHide": ' +
     JSON.stringify(patternlab.config.ishControlsHide) +
     '};' +

packages/core/src/lib/loadPattern.js

@@ -3,7 +3,6 @@
 const path = require('path');
 
 const Pattern = require('./object_factory').Pattern;
-const mp = require('./markdown_parser');
 const logger = require('./log');
 const patternEngines = require('./pattern_engines');
 const ch = require('./changes_hunter');
@@ -12,7 +11,6 @@ const addPattern = require('./addPattern');
 const buildListItems = require('./buildListItems');
 const readDocumentation = require('./readDocumentation');
 
-const markdown_parser = new mp();
 const changes_hunter = new ch();
 const dataLoader = new da();
 
@@ -37,11 +35,11 @@ module.exports = function(relPath, patternlab) {
       "It's strongly suggested to not deviate from the following structure under _patterns/"
     );
     logger.warning(
-      '[patternType]/[patternSubtype]/[patternName].[patternExtension]'
+      '[patternGroup]/[patternSubgroup]/[patternName].[patternExtension]'
     );
     logger.warning('or');
     logger.warning(
-      '[patternType]/[patternSubtype]/[patternName]/[patternName].[patternExtension]'
+      '[patternGroup]/[patternSubgroup]/[patternName]/[patternName].[patternExtension]'
     );
     logger.warning('');
     logger.warning(
@@ -53,46 +51,7 @@ module.exports = function(relPath, patternlab) {
     logger.warning('');
   }
 
-  //check if the found file is a top-level markdown file
   const fileObject = path.parse(relPath);
-  if (fileObject.ext === '.md') {
-    try {
-      const proposedDirectory = path.resolve(
-        patternlab.config.paths.source.patterns,
-        fileObject.dir,
-        fileObject.name
-      );
-      const proposedDirectoryStats = fs.statSync(proposedDirectory);
-      if (proposedDirectoryStats.isDirectory()) {
-        const subTypeMarkdownFileContents = fs.readFileSync(
-          proposedDirectory + '.md',
-          'utf8'
-        );
-        const subTypeMarkdown = markdown_parser.parse(
-          subTypeMarkdownFileContents
-        );
-        const subTypePattern = new Pattern(relPath, null, patternlab);
-        subTypePattern.patternSectionSubtype = true;
-        subTypePattern.patternDesc = subTypeMarkdown
-          ? subTypeMarkdown.markdown
-          : '';
-        subTypePattern.flatPatternPath =
-          subTypePattern.flatPatternPath + '-' + subTypePattern.fileName;
-        subTypePattern.isPattern = false;
-        subTypePattern.engine = null;
-        patternlab.subtypePatterns[
-          subTypePattern.patternPartial
-        ] = subTypePattern;
-
-        return subTypePattern;
-      }
-    } catch (err) {
-      // no file exists, meaning it's a pattern markdown file
-      if (err.code !== 'ENOENT') {
-        logger.warning(err);
-      }
-    }
-  }
 
   //extract some information
   const filename = fileObject.base;