fix: playwright tests

Author: ycnmhd

README.md

@@ -1,8 +1,8 @@
 # Lineage
-Lineage is an Obsidian plugin that allows you to edit markdown files within a [gingko-like](https://gingkowriter.com/) interface.
+Lineage is an Obsidian plugin that allows you to edit markdown files in a [gingko-like](https://gingkowriter.com/) interface.
 
 ![](https://raw.githubusercontent.com/ycnmhd/obsidian-lineage/docs/docs/media/screenshot.png)
 
 ## Usage
-To open a file, use the file context menu or the command palette.
+To open a file, use the file context menu or the command palette.  
 To export a file, use the view context menu.

e2e/tests/file-and-folder-menu.spec.ts

@@ -7,7 +7,7 @@ import { createNewFolder } from '../helpers/interactions/obsidian-ui/create-new-
 import { getTextsOfColumns } from '../helpers/getters/lineage-view/card/get-texts-of-columns';
 import { text } from '../helpers/general/text';
 
-export const MI_NEW_LINEAGE_FILE = 'New lineage document';
+export const MI_NEW_LINEAGE_FILE = 'New document';
 
 test('should create file from context menu', async () => {
     await closeThisTabGroup();

e2e/tests/text-area.spec.ts

@@ -44,6 +44,7 @@ test.describe('text should be saved', () => {
         // move card before saving
         await moveCardUsingHotkey('right');
 
+        await saveCardUsingHotkey();
         expect(await getTextsOfColumns()).toEqual([[n1], [n2]]);
     });
 

manifest.json

@@ -1,9 +1,9 @@
 {
 	"id": "lineage",
 	"name": "Lineage",
-	"version": "0.5.4",
+	"version": "0.6.0",
 	"minAppVersion": "0.15.0",
-	"description": "A writing interface that combines structure and content. Inspired by Gingko Writer.",
+	"description": "A keyboard-centric hierarchical writing interface. Inspired by Gingko Writer.",
 	"author": "ycnmhd",
 	"isDesktopOnly": false
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lineage",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "description": "",
   "scripts": {
     "dev": "node esbuild.config.mjs",

src/lib/data-conversion/helpers/correct-headings.spec.ts

@@ -1,5 +1,6 @@
 import { describe, expect, test } from 'vitest';
 import { correctHeadings } from 'src/lib/data-conversion/helpers/correct-headings';
+import { ginkgo_academic_paper } from 'src/lib/data-conversion/test-data/ginkgo_acedemic_paper';
 
 // some tests are inspired from https://github.com/platers/obsidian-linter/blob/952bba9d7b6a4f084d68ffdd469bd89e785206b2/__tests__/header-increment.test.ts#L1
 describe('correctHeadings', () => {
@@ -235,4 +236,191 @@ This is another paragraph.
 `;
         expect(correctHeadings(markdown)).toBe(expected);
     });
+
+    test('case: gingko academic paper', () => {
+        const output = `# Title: **Statement** of your core result or finding.
+Try to make your title an assertive statement, such as:
+- "Changes in cytoplasmic volume are sufficient to drive spindle scaling." 
+
+and not
+- "High-performance silicon photoanodes passivated with ultrathin nickel films for water oxidation"
+
+Rule of thumb: if your title would look weird with a period at the end, it is probably a poor title.
+
+Don't do [this](http://www.phdcomics.com/comics/archive/phd053106s.gif).
+
+# Abstract
+Try to tell a *story* here, no matter what your field. You are writing for human beings, not computers. What's the area, what's the problem you are trying to understand. How? What have you found?
+
+(You are *summarizing* your core results, not *cramming* them into this tiny space).
+
+---
+## target:  84-151 words
+## current: 43 ![](https://dl.dropboxusercontent.com/s/6k720i6vkig7siq/cross_circle.png)
+
+<!-- URL for checkmark: https://dl.dropboxusercontent.com/s/elo7ckzspvxvx0t/checkmark.gif -->
+
+## (This is a word count footer. We don't have automatic word counts yet, so I use is [this Chrome extension](https://chrome.google.com/webstore/detail/word-count/pnngehidikgomgfjbpffonkeimgbpjlh))
+
+## Introduction - "The Setup"
+### [In field X, we still don't understand Y & Z.]
+
+Write a summary of *the question(s) you are trying to answer*.
+What is the state of the world before your research came along?
+Also, answer the harsh but important question: *Who cares*?
+
+In writing this, you can start general, but make sure clearly define the "before" state of the world's knowledge for the *specific area* this paper is addressing.
+
+### Intro - Assertive Statement 1
+
+Here you can expand on your introduction. To guide your writing, title this card with assertive statements:
+Instead of "Problem Description", be direct: "The problem is that X doesn't do Y."
+
+# Introduction
+
+[You can write your actual paper here in this column. Then choosing "Export column 5" to Word or Markdown will help you move it to your final platform.]
+
+You can keep notes & comments here.
+
+...
+
+...
+
+## Intro - Assertive Statement 2
+
+...
+
+...
+
+## Intro - Assertive Statement 3
+
+...
+
+...
+
+## Materials & Methods - "The Characters"
+### [We have here method A, B, and our new method C.]
+You have established the core question(s) of your research. Now introduce the tools you are going to  use to understand it.
+
+## Method A
+More details on the method, experiment design, etc.
+
+Remember that these are cards, so you can drag and drop them to rearrange if necessary.
+
+# Methods
+
+## Method A
+
+Some other note. For example:
+
+#Xusheng , make sure you include the voltage you used."
+
+(the # syntax makes it easier to search for & filter comments directed at a specific person).
+
+...
+
+...
+
+## Method B
+More details on the method, experiment design, etc.
+
+### Method B...
+
+...
+
+...
+
+## Method C
+More details on the method, experiment design, etc.
+
+If you need a checklist to make sure you address all points, go ahead:
+[ ] e.g. "Mention pH of the setup"
+[ ] What temperature?
+[ ] For how long?
+
+### Method C
+
+...
+
+...
+
+## Results
+What happened (objectively)?
+
+Do not interpret, simply state the facts.
+
+Let's be honest: the first thing most of us do when skimming a paper is look at the figures. If your key results can be presented in figures, then start with that, and structure your paper around that.
+
+## Key Result
+You can add figures if you'd like:
+
+![](https://dl.dropboxusercontent.com/s/gieldum0s47m25v/1-plot.jpg)
+
+# Results
+
+Final text for results goes here
+
+...
+
+...
+
+Remember these are **cards** so you can rearrange your results at will.
+Any subcards will follow.
+
+Other results
+
+## Discussion
+Results are objective, but science isn't about listing data, it's about extracting meaning from what we observe.
+
+What do your results tell you about the core problem you were investigating?
+
+## Conclusion
+Bring it back to the big picture. How do your results fit into the current body of knowledge?
+
+Most importantly, how can these results help you [ask better questions](http://www.youtube.com/watch?v=nq0_zGzSc8g#t=493)?
+
+## Conclusion (further detail)
+
+Expand on your conclusion summary, and add more details to it.
+
+# Conclusion
+
+Final text for conclusion goes here
+
+in as many
+
+cards as you like.
+
+## References
+We don't have bibliography support yet, but we do have "named links" so you can refer to specific links by name rather than retyping it each time.
+
+"Black holes are cool." [[1]][prl2010], and DNA is cool too [[2]][dnaRef]. But black holes are still cool, though not "absolute zero" cool [[1]][prl2010].
+
+[prl2010]: http://arxiv.org/abs/1311.3007
+[dnaRef]: http://biorxiv.org/content/early/2013/11/07/000026
+
+## List
+Or you can simply list your references here:
+
+1. some ref
+1. some other ref. Numbering fixes itself automatically.
+2. A third ref.
+
+# References
+
+Some reference by J. Doe
+
+Notes on this reference.
+
+Some other reference
+
+## How to use this template
+The idea here is to start at the far left, and clarify what the core of what you want to say is *first*, and then expand on it by moving to the right, one column at a time.
+
+After a couple of "passes" of expanding, you will end up with your complete, and well structured paper on column 5, which you can export separately.
+
+Here's a (somewhat dated) video which might help.
+<iframe width="256" height="144" src="//www.youtube.com/embed/J4prcx0jZ9M?rel=0" frameborder="0" allowfullscreen></iframe>`;
+        expect(correctHeadings(ginkgo_academic_paper.md)).toBe(output);
+    });
 });

src/lib/data-conversion/helpers/correct-headings.ts

@@ -47,6 +47,8 @@ export const correctHeadings = (markdown: string): string => {
                         correctedLevel = parent.correctedLevel + 1;
                     }
                 }
+            } else if (level === state.previousLevel) {
+                correctedLevel = state.previousCorrectedLevel;
             } else {
                 correctedLevel = level;
             }

src/lib/format-detection/has-n-heading.spec.ts

@@ -46,4 +46,11 @@ Some text.`;
         const input = `# Heading 1 ## Heading 2`;
         expect(hasNHeadings(input)).toBe(false);
     });
+
+    it('should return true if the heading is in an outline', () => {
+        const input = `- # Heading 1
+  This is some text.
+\t- ## Heading 2`;
+        expect(hasNHeadings(input)).toBe(true);
+    });
 });

src/lib/format-detection/has-n-headings.ts

@@ -2,7 +2,7 @@ export const hasNHeadings = (input: string, n = 2): boolean => {
     const lines = input.split('\n');
     let count = 0;
     for (const line of lines) {
-        if (/^#+ +/.test(line)) {
+        if (/^((\t*)- )?#+ +/.test(line)) {
             count++;
             if (count >= n) return true;
         }

src/obsidian/commands/helpers/export-document/export-document.ts

@@ -1,28 +1,26 @@
-import { TFile } from 'obsidian';
 import { createNewFile } from 'src/obsidian/events/workspace/effects/create-new-file';
-import Lineage from 'src/main';
 import { openFile } from 'src/obsidian/events/workspace/effects/open-file';
 import { onPluginError } from 'src/lib/store/on-plugin-error';
 import { prepareExportedDocument } from 'src/obsidian/commands/helpers/export-document/prepare-exported-document';
+import { getDocumentFormat } from 'src/obsidian/events/workspace/helpers/get-document-format';
+import { LineageView } from 'src/view/view';
 
-export type ExportMode = 'markdown' | 'outline';
-export const exportDocument = async (
-    plugin: Lineage,
-    file: TFile,
-    mode: ExportMode,
-) => {
+export const exportDocument = async (view: LineageView) => {
     try {
+        const file = view.file;
+        if (!file) return;
         if (!file.parent) return;
-        const fileData = await plugin.app.vault.read(file);
-        const output = prepareExportedDocument(fileData, file.basename, mode);
+        const fileData = await view.plugin.app.vault.read(file);
+        const format = getDocumentFormat(view);
+        const output = prepareExportedDocument(fileData, file.basename, format);
         const newFile = await createNewFile(
-            plugin,
+            view.plugin,
             file.parent,
             output,
             file.basename,
         );
         if (newFile) {
-            await openFile(plugin, newFile, 'split');
+            await openFile(view.plugin, newFile, 'split');
         }
     } catch (e) {
         onPluginError(e, 'command', { type: 'export-document' });