@docusaurus/utils 2.4.1 → 3.0.0-beta.0

package/src/pathUtils.ts

@@ -96,12 +96,16 @@ export function aliasedSitePath(filePath: string, siteDir: string): string {
  * When you have a path like C:\X\Y
  * It is not safe to use directly when generating code
  * For example, this would fail due to unescaped \:
- * `<img src={require('${filePath}')} />`
- * But this would work: `<img src={require('${escapePath(filePath)}')} />`
+ * `<img src={require("${filePath}")} />`
+ * But this would work: `<img src={require("${escapePath(filePath)}")} />`
  *
  * posixPath can't be used in all cases, because forward slashes are only valid
  * Windows paths when they don't contain non-ascii characters, and posixPath
  * doesn't escape those that fail to be converted.
+ *
+ * This function escapes double quotes but not single quotes (because it uses
+ * `JSON.stringify`). Therefore, you must put the escaped path inside double
+ * quotes when generating code.
  */
 export function escapePath(str: string): string {
   const escaped = JSON.stringify(str);
@@ -114,5 +118,5 @@ export function addTrailingPathSeparator(str: string): string {
   return str.endsWith(path.sep)
     ? str
     : // If this is Windows, we need to change the forward slash to backward
-      `${str.replace(/\/$/, '')}${path.sep}`;
+      `${str.replace(/[\\/]$/, '')}${path.sep}`;
 }

package/src/tags.ts

@@ -25,6 +25,8 @@ export type TagsListItem = Tag & {
 export type TagModule = TagsListItem & {
   /** The tags list page's permalink. */
   allTagsPath: string;
+  /** Is this tag unlisted? (when it only contains unlisted items) */
+  unlisted: boolean;
 };
 
 export type FrontMatterTag = string | Tag;
@@ -128,3 +130,32 @@ export function groupTaggedItems<Item>(
 
   return result;
 }
+
+/**
+ * Permits to get the "tag visibility" (hard to find a better name)
+ * IE, is this tag listed or unlisted
+ * And which items should be listed when this tag is browsed
+ */
+export function getTagVisibility<Item>({
+  items,
+  isUnlisted,
+}: {
+  items: Item[];
+  isUnlisted: (item: Item) => boolean;
+}): {
+  unlisted: boolean;
+  listedItems: Item[];
+} {
+  const allItemsUnlisted = items.every(isUnlisted);
+  // When a tag is full of unlisted items, we display all the items
+  // when tag is browsed, but we mark the tag as unlisted
+  if (allItemsUnlisted) {
+    return {unlisted: true, listedItems: items};
+  }
+  // When a tag has some listed items, the tag remains listed
+  // but we filter its unlisted items
+  return {
+    unlisted: false,
+    listedItems: items.filter((item) => !isUnlisted(item)),
+  };
+}

package/src/urlUtils.ts

@@ -6,7 +6,7 @@
  */
 
 import resolvePathnameUnsafe from 'resolve-pathname';
-import {removeSuffix} from './jsUtils';
+import {addPrefix, addSuffix, removeSuffix} from './jsUtils';
 
 /**
  * Much like `path.join`, but much better. Takes an array of URL segments, and
@@ -175,13 +175,13 @@ export function resolvePathname(to: string, from?: string): string {
 }
 /** Appends a leading slash to `str`, if one doesn't exist. */
 export function addLeadingSlash(str: string): string {
-  return str.startsWith('/') ? str : `/${str}`;
+  return addPrefix(str, '/');
 }
 
 // TODO deduplicate: also present in @docusaurus/utils-common
 /** Appends a trailing slash to `str`, if one doesn't exist. */
 export function addTrailingSlash(str: string): string {
-  return str.endsWith('/') ? str : `${str}/`;
+  return addSuffix(str, '/');
 }
 
 /** Removes the trailing slash from `str`. */