Fix out of order embedding of files

- added double quote as attribute marker
- fixed inject order of embedded files
- added e2e test covering order of embedded files

Author: aenniw

cypress/inline/embed-order.md

@@ -0,0 +1,11 @@
+## Embedded file order
+
+Then the content of `delayed.md` `non-delayed.md` and will be displayed directly here in correct order
+
+[delayed](_media/delayed.md ':include')
+
+---
+
+[non-delayed](_media/non-delayed.md ':include')
+
+You can check the original content for [delayed.md](_media/delayed.md ':ignore'), [non-delayed.md](_media/non-delayed.md ':ignore').

cypress/integration/sidebar/config.spec.js

@@ -326,6 +326,7 @@ context('sidebar.configurations', () => {
   const embedFilesIds = [
     'embedded-file-type',
     'embedded-code-fragments',
+    'embedded-file-order',
     'tag-attribute',
     'the-code-block-highlight',
   ];
@@ -336,7 +337,7 @@ context('sidebar.configurations', () => {
       cy.get(`a.section-link[href='#/embed-files?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500);
+          cy.wait(750);
           cy.matchImageSnapshot();
         });
     });

cypress/live.server.js

@@ -7,7 +7,16 @@ console.log('[e2e tests] : args passed to live server', args)
 const params = {
   port: args[0] || 3000,
   root: args[1] || fixturePath,
-  open: false
+  open: false,
+  middleware: [
+    function(req, res, next) {
+      if (req.url === '/_media/delayed.md') {
+        setTimeout(next, 250);
+      } else {
+        next();
+      }
+    },
+  ],
   // NoBrowser: true
-}
-LiveServer.start(params)
+};
+LiveServer.start(params)

cypress/setup.js

@@ -23,6 +23,13 @@ const setup = async () => {
   // 1
   const docsPath = path.join(process.cwd(), './docs')
   const fixtureDocsPath = path.join(__dirname, './fixtures/docs')
+  const embeddedFiles = [
+    {
+      tag: '## Tag attribute',
+      srcFile: 'embed-order.md',
+      dstFile: 'embed-files.md',
+    },
+  ];
 
   // 1.1
   console.log('[cypress test docs] Copying the docs --> cypress/fixtures/docs')
@@ -38,6 +45,21 @@ const setup = async () => {
     copyDir.sync(fromPath, toPath)
   })
 
+  // 1.3
+  embeddedFiles.forEach(({ tag, srcFile, dstFile }) => {
+    const content = fs.readFileSync(`${__dirname}/inline/${srcFile}`).toString();
+    const originalFile = `${fixtureDocsPath}/${dstFile}`;
+
+    let originalContent = fs
+      .readFileSync(originalFile)
+      .toString()
+      .split('\n');
+    const tagLine = originalContent.findIndex(l => l.indexOf(tag) >= 0);
+    originalContent.splice(tagLine, 0, content);
+
+    fs.writeFileSync(originalFile, originalContent.join('\n'));
+  });
+
   // 2
   console.log(
     '[cypress test docs] Replacing content the tpl/index.html --> cypress/fixtures/docs/index.html'