Use double-space for pretty-printed HTML indentation

4ce317f5 · Alejandro Celaya · Alejandro Celaya · 19aed53e · 4ce317f5 · 4ce317f5
Commit 4ce317f5 authored Jan 16, 2024 by Alejandro Celaya Committed by Alejandro Celaya Jan 16, 2024
4 changed files
--- a/src/sidebar/components/ShareDialog/test/ExportAnnotations-test.js
+++ b/src/sidebar/components/ShareDialog/test/ExportAnnotations-test.js
@@ -469,8 +469,8 @@ describe('ExportAnnotations', () => {
  context('when copying annotations export to clipboard', () => {
    [true, false].forEach(exportFormatsEnabled => {
      it('displays copy button if `export_formats` FF is enabled', () => {
-        fakeStore.isFeatureEnabled.callsFake(
-          ff => exportFormatsEnabled || ff !== 'export_formats',
+        fakeStore.isFeatureEnabled.callsFake(ff =>
+          ff === 'export_formats' ? exportFormatsEnabled : true,
        );

        const wrapper = createComponent();

--- a/src/sidebar/services/annotations-exporter.tsx
+++ b/src/sidebar/services/annotations-exporter.tsx
@@ -275,7 +275,10 @@ export class AnnotationsExporter {
      </html>,
      {},
      { pretty: true },
-    );
+      // `renderToString` indents lines with tabs when using `pretty: true`.
+      // Replacing them with double spaces we avoid side effects when pasting
+      // the result in a web app.
+    ).replace(/\t/g, '  ');
  }

  private _exportCommon(

--- a/src/sidebar/services/test/annotations-exporter-test.js
+++ b/src/sidebar/services/test/annotations-exporter-test.js
@@ -292,13 +292,9 @@ ${formattedNow},John Doe,,http://example.com,My group,Annotation,,Annotation tex
        now,
      });

-      // The result uses tabs to indent lines.
-      // We can get rid of that for simplicity and just compare the markup
-      const removeAllIndentation = str => str.replace(/^[ \t]+/gm, '');
-
      assert.equal(
-        removeAllIndentation(result),
-        removeAllIndentation(`<html lang="en">
+        result,
+        `<html lang="en">
  <head>
    <title>
      Annotations on &quot;A special document&quot;
@@ -444,7 +440,7 @@ ${formattedNow},John Doe,,http://example.com,My group,Annotation,,Annotation tex
      </article>
    </section>
  </body>
-</html>`),
+</html>`,
      );
    });
  });

--- a/src/sidebar/util/copy-to-clipboard.ts
+++ b/src/sidebar/util/copy-to-clipboard.ts
@@ -45,8 +45,7 @@ export async function copyPlainText(text: string, navigator_ = navigator) {
 }

 /**
- * Copy the string `text` to the clipboard, rendering HTML if any, instead of
- * raw markup.
+ * Copy the string `text` to the clipboard with an HTML media type.
 *
 * If the browser does not support this, it will fall back to copy the string
 * as plain text.