Merge branch 'develop' into snyk-fix-868c33890c75695951e54378ffde6e05

docsifyjs · Sep 24, 2022 · c8013ce · c8013ce
2 parents 842fffc + 79a6619
commit c8013ce
Show file tree

Hide file tree

Showing 9 changed files with 129 additions and 28 deletions.
diff --git a/docs/deploy.md b/docs/deploy.md
@@ -7,14 +7,14 @@ Similar to [GitBook](https://www.gitbook.com), you can deploy files to GitHub Pa
 There are three places to populate your docs for your GitHub repository:
 
 - `docs/` folder
-- master branch
+- main branch
 - gh-pages branch
 
-It is recommended that you save your files to the `./docs` subfolder of the `master` branch of your repository. Then select `master branch /docs folder` as your GitHub Pages source in your repository's settings page.
+It is recommended that you save your files to the `./docs` subfolder of the `main` branch of your repository. Then select `main branch /docs folder` as your GitHub Pages source in your repository's settings page.
 
 ![GitHub Pages](_images/deploy-github-pages.png)
 
-!> You can also save files in the root directory and select `master branch`.
+!> You can also save files in the root directory and select `main branch`.
 You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
 
 ## GitLab Pages

diff --git a/docs/write-a-plugin.md b/docs/write-a-plugin.md
@@ -22,14 +22,16 @@ window.$docsify = {
 Alternatively, a plugin can be stored in a separate file and "installed" using a standard `<script>` tag:
 
 ```js
+// docsify-plugin-myplugin.js
+
 (function () {
   var myPlugin = function (hook, vm) {
     // ...
   };
 
   // Add plugin to docsify's plugin array
   $docsify = $docsify || {};
-  $docsify.plugins = [].concat(myPlugin, $docsify.plugins || []);
+  $docsify.plugins = [].concat($docsify.plugins || [], myPlugin);
 })();
 ```
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/core/render/emojify.js b/src/core/render/emojify.js
@@ -35,6 +35,10 @@ export function emojify(text, useNativeEmoji) {
       )
       // Mark colons in comments
       .replace(/<!--[\s\S]+?-->/g, m => m.replace(/:/g, '__colon__'))
+      // Mark colons in URIs
+      .replace(/([a-z]{2,}:)?\/\/[^\s'">)]+/gi, m =>
+        m.replace(/:/g, '__colon__')
+      )
       // Replace emoji shorthand codes
       .replace(/:([a-z0-9_\-+]+?):/g, (m, $1) =>
         replaceEmojiShorthand(m, $1, useNativeEmoji)

diff --git a/src/core/util/str.js b/src/core/util/str.js
@@ -5,3 +5,12 @@ export function startsWith(str, prefix) {
 export function endsWith(str, suffix) {
   return str.indexOf(suffix, str.length - suffix.length) !== -1;
 }
+
+export function removeDocsifyIgnoreTag(str) {
+  return str
+    .replace(/<!-- {docsify-ignore} -->/, '')
+    .replace(/{docsify-ignore}/, '')
+    .replace(/<!-- {docsify-ignore-all} -->/, '')
+    .replace(/{docsify-ignore-all}/, '')
+    .trim();
+}
diff --git a/src/plugins/search/search.js b/src/plugins/search/search.js
@@ -1,5 +1,6 @@
 /* eslint-disable no-unused-vars */
 import { getAndRemoveConfig } from '../../core/render/utils';
+import { removeDocsifyIgnoreTag } from '../../core/util/str';
 
 let INDEXS = {};
 
@@ -89,19 +90,16 @@ export function genIndex(path, content = '', router, depth) {
     if (token.type === 'heading' && token.depth <= depth) {
       const { str, config } = getAndRemoveConfig(token.text);
 
+      const text = removeDocsifyIgnoreTag(token.text);
+
       if (config.id) {
         slug = router.toURL(path, { id: slugify(config.id) });
       } else {
-        slug = router.toURL(path, { id: slugify(escapeHtml(token.text)) });
+        slug = router.toURL(path, { id: slugify(escapeHtml(text)) });
       }
 
       if (str) {
-        title = str
-          .replace(/<!-- {docsify-ignore} -->/, '')
-          .replace(/{docsify-ignore}/, '')
-          .replace(/<!-- {docsify-ignore-all} -->/, '')
-          .replace(/{docsify-ignore-all}/, '')
-          .trim();
+        title = removeDocsifyIgnoreTag(str);
       }
 
       index[slug] = { slug, title: title, body: '' };
@@ -213,14 +211,15 @@ export function search(query) {
           }
 
           const matchContent =
+            handlePostContent &&
             '...' +
-            handlePostContent
-              .substring(start, end)
-              .replace(
-                regEx,
-                word => `<em class="search-keyword">${word}</em>`
-              ) +
-            '...';
+              handlePostContent
+                .substring(start, end)
+                .replace(
+                  regEx,
+                  word => `<em class="search-keyword">${word}</em>`
+                ) +
+              '...';
 
           resultStr += matchContent;
         }

diff --git a/test/e2e/search.test.js b/test/e2e/search.test.js
@@ -176,4 +176,24 @@ test.describe('Search Plugin Tests', () => {
     await searchFieldElm.fill('hello');
     await expect(resultsHeadingElm).toHaveText('Changelog Title');
   });
+  test('search when there is no body', async ({ page }) => {
+    const docsifyInitConfig = {
+      markdown: {
+        homepage: `
+          # EmptyContent
+          ---
+          ---
+        `,
+      },
+      scriptURLs: ['/lib/plugins/search.min.js'],
+    };
+
+    const searchFieldElm = page.locator('input[type=search]');
+    const resultsHeadingElm = page.locator('.results-panel h2');
+
+    await docsifyInit(docsifyInitConfig);
+
+    await searchFieldElm.fill('empty');
+    await expect(resultsHeadingElm).toHaveText('EmptyContent');
+  });
 });
diff --git a/test/integration/__snapshots__/emoji.test.js.snap b/test/integration/__snapshots__/emoji.test.js.snap
@@ -2,6 +2,10 @@
 
 exports[`Emoji Ignores all emoji shorthand codes (noEmoji:true) 1`] = `"<p>:smile:</p><p>:smile::smile:</p><p>:smile: :smile:</p><p>:smile::smile::smile:</p><p>:smile: :smile: :smile:</p><p>text:smile:</p><p>:smile:text</p><p>text:smile:text</p>"`;
 
+exports[`Emoji Ignores emoji shorthand codes in URIs 1`] = `"<p>Url <a href=\\"https://docsify.js.org/:foo:/\\" target=\\"_blank\\" rel=\\"noopener\\">https://docsify.js.org/:foo:/</a> <a href=\\"http://docsify.js.org/:100:/\\" target=\\"_blank\\" rel=\\"noopener\\">http://docsify.js.org/:100:/</a> <a href=\\"ftp://docsify.js.org/:smile:/\\" target=\\"_blank\\" rel=\\"noopener\\">ftp://docsify.js.org/:smile:/</a></p>"`;
+
+exports[`Emoji Ignores emoji shorthand codes in URIs while handling anchor content 1`] = `"<p>Achor tags <a href=\\"http://docsify.js.org/:100:/\\" target=\\"_blank\\" rel=\\"noopener\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8.png\\" alt=\\"100\\" class=\\"emoji\\" loading=\\"lazy\\"></a></p>"`;
+
 exports[`Emoji Ignores emoji shorthand codes in code, pre, script, and template tags 1`] = `
 "<pre>:100:</pre>
 
@@ -16,6 +20,10 @@ exports[`Emoji Ignores emoji shorthand codes in code, pre, script, and template
 
 exports[`Emoji Ignores emoji shorthand codes in comments 1`] = `"<p>Text <!-- :foo: :100: --></p>"`;
 
+exports[`Emoji Ignores emoji shorthand codes in html attributes 1`] = `"<p><a href=\\"http://domain.com/:smile:/\\"> <img src=\\"http://domain.com/:smile:/file.png\\"> <script src=\\"http://domain.com/:smile:/file.js\\"></script></a></p>"`;
+
+exports[`Emoji Ignores emoji shorthand codes in style url() values 1`] = `"<style>@import url(http://domain.com/:smile/file.css);</style>"`;
+
 exports[`Emoji Ignores unmatched emoji shorthand codes 1`] = `"<p>hh:mm</p><p>hh:mm:ss</p><p>Namespace::SubNameSpace</p><p>Namespace::SubNameSpace::Class</p><p>2014-12-29T16:11:20+00:00</p>"`;
 
 exports[`Emoji Renders GitHub emoji images (nativeEmoji:false) 1`] = `"<p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"> <img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"> <img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"> <img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p>text<img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\"></p><p><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\">text</p><p>text<img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\" alt=\\"smile\\" class=\\"emoji\\" loading=\\"lazy\\">text</p>"`;

diff --git a/test/integration/emoji.test.js b/test/integration/emoji.test.js
@@ -107,6 +107,59 @@ describe('Emoji', function () {
     expect(mainElm.innerHTML).toMatchSnapshot();
   });
 
+  test('Ignores emoji shorthand codes in URIs', async () => {
+    await docsifyInit({
+      markdown: {
+        homepage:
+          'Url https://docsify.js.org/:foo:/ http://docsify.js.org/:100:/ ftp://docsify.js.org/:smile:/',
+      },
+      // _logHTML: true,
+    });
+
+    const mainElm = document.querySelector('#main');
+
+    expect(mainElm.innerHTML).toMatchSnapshot();
+  });
+
+  test('Ignores emoji shorthand codes in URIs while handling anchor content', async () => {
+    await docsifyInit({
+      markdown: {
+        homepage: 'Achor tags [:100:](http://docsify.js.org/:100:/)',
+      },
+      // _logHTML: true,
+    });
+
+    const mainElm = document.querySelector('#main');
+
+    expect(mainElm.innerHTML).toMatchSnapshot();
+  });
+
+  test('Ignores emoji shorthand codes in html attributes', async () => {
+    await docsifyInit({
+      markdown: {
+        homepage: `<a href="http://domain.com/:smile:/"> <img src='http://domain.com/:smile:/file.png'> <script src=http://domain.com/:smile:/file.js></script>`,
+      },
+      // _logHTML: true,
+    });
+
+    const mainElm = document.querySelector('#main');
+
+    expect(mainElm.innerHTML).toMatchSnapshot();
+  });
+
+  test('Ignores emoji shorthand codes in style url() values', async () => {
+    await docsifyInit({
+      markdown: {
+        homepage: `<style>@import url(http://domain.com/:smile/file.css);</style>`,
+      },
+      // _logHTML: true,
+    });
+
+    const mainElm = document.querySelector('#main');
+
+    expect(mainElm.innerHTML).toMatchSnapshot();
+  });
+
   test('Ignores emoji shorthand codes in code, pre, script, and template tags', async () => {
     await docsifyInit({
       markdown: {