@docusaurus/utils 2.0.0-beta.15 → 2.0.0-beta.16

package/src/tags.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {kebabCase, uniq, uniqBy} from 'lodash';
+import _ from 'lodash';
 import {normalizeUrl} from './urlUtils';
 
 export type Tag = {
@@ -22,15 +22,15 @@ export function normalizeFrontMatterTag(
   function toTagObject(tagString: string): Tag {
     return {
       label: tagString,
-      permalink: kebabCase(tagString),
+      permalink: _.kebabCase(tagString),
     };
   }
 
   // TODO maybe make ensure the permalink is valid url path?
   function normalizeTagPermalink(permalink: string): string {
-    // note: we always apply tagsPath on purpose
-    // for versioned docs, v1/doc.md and v2/doc.md tags with custom permalinks don't lead to the same created page
-    // tagsPath is different for each doc version
+    // note: we always apply tagsPath on purpose. For versioned docs, v1/doc.md
+    // and v2/doc.md tags with custom permalinks don't lead to the same created
+    // page. tagsPath is different for each doc version
     return normalizeUrl([tagsPath, permalink]);
   }
 
@@ -53,7 +53,7 @@ export function normalizeFrontMatterTags(
     normalizeFrontMatterTag(tagsPath, tag),
   );
 
-  return uniqBy(tags, (tag) => tag.permalink);
+  return _.uniqBy(tags, (tag) => tag.permalink);
 }
 
 export type TaggedItemGroup<Item> = {
@@ -61,11 +61,14 @@ export type TaggedItemGroup<Item> = {
   items: Item[];
 };
 
-// Permits to group docs/blogPosts by tag (provided by FrontMatter)
-// Note: groups are indexed by permalink, because routes must be unique in the end
-// Labels may vary on 2 md files but they are normalized.
-// Docs with label='some label' and label='some-label' should end-up in the same group/page in the end
-// We can't create 2 routes /some-label because one would override the other
+/**
+ * Permits to group docs/blogPosts by tag (provided by front matter)
+ * Note: groups are indexed by permalink, because routes must be unique in the
+ * end. Labels may vary on 2 md files but they are normalized. Docs with
+ * label='some label' and label='some-label' should end-up in the same
+ * group/page in the end. We can't create 2 routes /some-label because one would
+ * override the other
+ */
 export function groupTaggedItems<Item>(
   items: Item[],
   getItemTags: (item: Item) => Tag[],
@@ -74,7 +77,8 @@ export function groupTaggedItems<Item>(
 
   function handleItemTag(item: Item, tag: Tag) {
     // Init missing tag groups
-    // TODO: it's not really clear what should be the behavior if 2 items have the same tag but the permalink is different for each
+    // TODO: it's not really clear what should be the behavior if 2 items have
+    // the same tag but the permalink is different for each
     // For now, the first tag found wins
     result[tag.permalink] = result[tag.permalink] ?? {
       tag,
@@ -94,7 +98,7 @@ export function groupTaggedItems<Item>(
   // If user add twice the same tag to a md doc (weird but possible),
   // we don't want the item to appear twice in the list...
   Object.values(result).forEach((group) => {
-    group.items = uniq(group.items);
+    group.items = _.uniq(group.items);
   });
 
   return result;

package/src/urlUtils.ts

@@ -16,7 +16,8 @@ export function normalizeUrl(rawUrls: string[]): string {
   if (urls[0].match(/^[^/:]+:\/*$/) && urls.length > 1) {
     const first = urls.shift();
     if (first!.startsWith('file:') && urls[0].startsWith('/')) {
-      // Force a double slash here, else we lose the information that the next segment is an absolute path
+      // Force a double slash here, else we lose the information that the next
+      // segment is an absolute path
       urls[0] = `${first}//${urls[0]}`;
     } else {
       urls[0] = first + urls[0];
@@ -26,10 +27,9 @@ export function normalizeUrl(rawUrls: string[]): string {
   // There must be two or three slashes in the file protocol,
   // two slashes in anything else.
   const replacement = urls[0].match(/^file:\/\/\//) ? '$1:///' : '$1://';
-  urls[0] = urls[0].replace(/^([^/:]+):\/*/, replacement);
+  urls[0] = urls[0].replace(/^(?<protocol>[^/:]+):\/*/, replacement);
 
-  // eslint-disable-next-line
-  for (let i = 0; i < urls.length; i++) {
+  for (let i = 0; i < urls.length; i += 1) {
     let component = urls[i];
 
     if (typeof component !== 'string') {
@@ -40,7 +40,7 @@ export function normalizeUrl(rawUrls: string[]): string {
       if (i === urls.length - 1 && hasEndingSlash) {
         resultArray.push('/');
       }
-      // eslint-disable-next-line
+      // eslint-disable-next-line no-continue
       continue;
     }
 
@@ -49,14 +49,15 @@ export function normalizeUrl(rawUrls: string[]): string {
         // Removing the starting slashes for each component but the first.
         component = component.replace(
           /^[/]+/,
-          // Special case where the first element of rawUrls is empty ["", "/hello"] => /hello
+          // Special case where the first element of rawUrls is empty
+          // ["", "/hello"] => /hello
           component[0] === '/' && !hasStartingSlash ? '/' : '',
         );
       }
 
       hasEndingSlash = component[component.length - 1] === '/';
-      // Removing the ending slashes for each component but the last.
-      // For the last component we will combine multiple slashes to a single one.
+      // Removing the ending slashes for each component but the last. For the
+      // last component we will combine multiple slashes to a single one.
       component = component.replace(/[/]+$/, i < urls.length - 1 ? '' : '/');
     }
 
@@ -69,14 +70,14 @@ export function normalizeUrl(rawUrls: string[]): string {
   // except the possible first plain protocol part.
 
   // Remove trailing slash before parameters or hash.
-  str = str.replace(/\/(\?|&|#[^!])/g, '$1');
+  str = str.replace(/\/(?<search>\?|&|#[^!])/g, '$1');
 
   // Replace ? in parameters with &.
   const parts = str.split('?');
   str = parts.shift() + (parts.length > 0 ? '?' : '') + parts.join('&');
 
   // Dedupe forward slashes in the entire path, avoiding protocol slashes.
-  str = str.replace(/([^:/]\/)\/+/g, '$1');
+  str = str.replace(/(?<textBefore>[^:/]\/)\/+/g, '$1');
 
   // Dedupe forward slashes at the beginning of the path.
   str = str.replace(/^\/+/g, '/');

package/src/webpackUtils.ts

@@ -33,12 +33,13 @@ type FileLoaderUtils = {
 
 // Inspired by https://github.com/gatsbyjs/gatsby/blob/8e6e021014da310b9cc7d02e58c9b3efe938c665/packages/gatsby/src/utils/webpack-utils.ts#L447
 export function getFileLoaderUtils(): FileLoaderUtils {
-  // files/images < urlLoaderLimit will be inlined as base64 strings directly in the html
+  // files/images < urlLoaderLimit will be inlined as base64 strings directly in
+  // the html
   const urlLoaderLimit = WEBPACK_URL_LOADER_LIMIT;
 
   // defines the path/pattern of the assets handled by webpack
   const fileLoaderFileName = (folder: AssetFolder) =>
-    `${OUTPUT_STATIC_ASSETS_DIR_NAME}/${folder}/[name]-[hash].[ext]`;
+    `${OUTPUT_STATIC_ASSETS_DIR_NAME}/${folder}/[name]-[contenthash].[ext]`;
 
   const loaders: FileLoaderUtils['loaders'] = {
     file: (options: {folder: AssetFolder}) => ({
@@ -56,7 +57,7 @@ export function getFileLoaderUtils(): FileLoaderUtils {
       },
     }),
 
-    // TODO find a better solution to avoid conflicts with the ideal-image plugin
+    // TODO avoid conflicts with the ideal-image plugin
     // TODO this may require a little breaking change for ideal-image users?
     // Maybe with the ideal image plugin, all md images should be "ideal"?
     // This is used to force url-loader+file-loader on markdown images
@@ -78,12 +79,12 @@ export function getFileLoaderUtils(): FileLoaderUtils {
      */
     images: () => ({
       use: [loaders.url({folder: 'images'})],
-      test: /\.(ico|jpg|jpeg|png|gif|webp)(\?.*)?$/,
+      test: /\.(?:ico|jpe?g|png|gif|webp)(?:\?.*)?$/i,
     }),
 
     fonts: () => ({
       use: [loaders.url({folder: 'fonts'})],
-      test: /\.(woff|woff2|eot|ttf|otf)$/,
+      test: /\.(?:woff2?|eot|ttf|otf)$/i,
     }),
 
     /**
@@ -92,11 +93,11 @@ export function getFileLoaderUtils(): FileLoaderUtils {
      */
     media: () => ({
       use: [loaders.url({folder: 'medias'})],
-      test: /\.(mp4|webm|ogv|wav|mp3|m4a|aac|oga|flac)$/,
+      test: /\.(?:mp4|webm|ogv|wav|mp3|m4a|aac|oga|flac)$/i,
     }),
 
     svg: () => ({
-      test: /\.svg?$/,
+      test: /\.svg$/i,
       oneOf: [
         {
           use: [
@@ -111,6 +112,7 @@ export function getFileLoaderUtils(): FileLoaderUtils {
                       name: 'preset-default',
                       params: {
                         overrides: {
+                          removeTitle: false,
                           removeViewBox: false,
                         },
                       },
@@ -125,7 +127,7 @@ export function getFileLoaderUtils(): FileLoaderUtils {
           // We don't want to use SVGR loader for non-React source code
           // ie we don't want to use SVGR for CSS files...
           issuer: {
-            and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
+            and: [/\.(?:tsx?|jsx?|mdx?)$/i],
           },
         },
         {
@@ -136,7 +138,7 @@ export function getFileLoaderUtils(): FileLoaderUtils {
 
     otherAssets: () => ({
       use: [loaders.file({folder: 'files'})],
-      test: /\.(pdf|doc|docx|xls|xlsx|zip|rar)$/,
+      test: /\.(?:pdf|docx?|xlsx?|zip|rar)$/i,
     }),
   };