feat: new card option for disabling indented bullets

This is useful for creating cloze deletions on the front and reducing
lots of unnecessary cards created.

src/controllers/SettingsController/SettingsController.test.ts

@@ -47,6 +47,7 @@ describe('SettingsController', () => {
       'remove-mp3-links': 'true',
       'perserve-newlines': 'true',
       'vertex-ai-pdf-questions': 'false',
+      'disable-indented-bullets': 'false',
     });
   });
 

src/controllers/SettingsController/supportedOptions.ts

@@ -124,6 +124,12 @@ const supportedOptions = (): CardOption[] => {
       'Use Vertex AI API to generate questions from PDFs. This is a paid feature and if enabled will send your notes to Google Cloud.',
       false
     ),
+    new CardOption(
+      'disable-indented-bullets',
+      'Disable Indented Bullets',
+      'Disable indented bullets from becoming separate cards. This applies to bullet lists.',
+      false
+    ),
   ];
 
   return v.filter(Boolean);

src/lib/parser/DeckParser.ts

@@ -26,6 +26,7 @@ import { handleNestedBulletPointsInMarkdown } from './handleNestedBulletPointsIn
 import { checkFlashcardsLimits } from '../User/checkFlashcardsLimits';
 import { extractStyles } from './extractStyles';
 import { withFontSize } from './withFontSize';
+import { findToggleLists } from './findToggles';
 
 export interface DeckParserInput {
   name: string;
@@ -117,14 +118,6 @@ export class DeckParser {
     return dom(selector).toArray();
   }
 
-  findToggleLists(dom: cheerio.Root): cheerio.Element[] {
-    const selector =
-      this.settings.isCherry || this.settings.isAll
-        ? '.toggle'
-        : '.page-body > ul';
-    return dom(selector).toArray();
-  }
-
   removeNestedToggles(input: string) {
     return input
       .replace(/<details(.*?)>(.*?)<\/details>/g, '')
@@ -206,9 +199,19 @@ export class DeckParser {
     const paragraphs = this.extractCardsFromParagraph(dom);
     let cards: Note[] = this.extractCards(dom, toggleList);
 
+    const disableIndentedBullets = this.settings.disableIndentedBulletPoints;
     // Note: this is a fallback behaviour until we can provide people more flexibility on picking non-toggles
     if (cards.length === 0) {
-      cards.push(...[...this.extractCardsFromLists(dom), ...paragraphs]);
+      cards.push(
+        ...[
+          ...this.extractCardsFromLists(dom, disableIndentedBullets),
+          ...paragraphs,
+        ]
+      );
+    } else if (this.settings.disableIndentedBulletPoints) {
+      cards.push(
+        ...[...this.extractCardsFromLists(dom, disableIndentedBullets)]
+      );
     }
 
     //  Prevent bad cards from leaking out
@@ -551,7 +554,11 @@ export class DeckParser {
   }
 
   private extractToggleLists(dom: cheerio.Root) {
-    const foundToggleLists = this.findToggleLists(dom);
+    const foundToggleLists = findToggleLists(dom, {
+      isCherry: this.settings.isCherry,
+      isAll: this.settings.isAll,
+      disableIndentedBulletPoints: this.settings.disableIndentedBulletPoints,
+    });
 
     return [...foundToggleLists, ...this.findIndentedToggleLists(dom)];
   }
@@ -646,14 +653,24 @@ export class DeckParser {
     return paragraphs.map((p) => new Note(dom(p).html() ?? '', ''));
   }
 
-  private extractCardsFromLists(dom: cheerio.Root) {
+  private extractCardsFromLists(
+    dom: cheerio.Root,
+    disableIndentedBullets: boolean
+  ) {
     const cards: Note[] = [];
-    const lists = [...dom('ul').toArray(), ...dom('ol').toArray()];
+    const lists = !disableIndentedBullets
+      ? [...dom('ul').toArray(), ...dom('ol').toArray()]
+      : [...dom('.page-body > .bulleted-list').toArray()];
 
     lists.forEach((list) => {
-      for (const child of dom(list).find('li')) {
+      if (!disableIndentedBullets) {
+        for (const child of dom(list).find('li')) {
+          this.checkLimits(cards.length, []);
+          cards.push(new Note(dom(child).html() ?? '', ''));
+        }
+      } else {
         this.checkLimits(cards.length, []);
-        cards.push(new Note(dom(child).html() ?? '', ''));
+        cards.push(new Note(dom(list).html() ?? '', ''));
       }
     });
 

src/lib/parser/Settings/Settings.ts

@@ -67,6 +67,7 @@ export class Settings {
   readonly nestedBulletPoints: boolean;
 
   readonly vertexAIPDFQuestions: boolean;
+  readonly disableIndentedBulletPoints: boolean;
 
   constructor(input: { [key: string]: string }) {
     this.deckName = input.deckName;
@@ -100,6 +101,8 @@ export class Settings {
     this.pageEmoji = input['page-emoji'] || 'first_emoji';
     this.addNotionLink = input['add-notion-link'] === 'true';
     this.vertexAIPDFQuestions = input['vertex-ai-pdf-questions'] === 'true';
+    this.disableIndentedBulletPoints =
+      input['disable-indented-bullets'] === 'true';
     /* Is this really needed? */
     if (this.parentBlockId) {
       this.addNotionLink = true;

src/lib/parser/findToggles.ts

@@ -0,0 +1,16 @@
+import cheerio from 'cheerio';
+
+import Settings from './Settings';
+
+export function findToggleLists(
+  dom: cheerio.Root,
+  context: Pick<Settings, 'isAll' | 'isCherry' | 'disableIndentedBulletPoints'>
+): cheerio.Element[] {
+  if (context.isCherry || context.isAll) {
+    return dom('.toggle').toArray();
+  }
+  if (!context.disableIndentedBulletPoints) {
+    return dom('.page-body > ul').toArray();
+  }
+  return dom('.page-body > ul:not(.bulleted-list)').toArray();
+}