feat(cli): support partially linking .md files

Currently, running
`mermaid-chart link test/fixtures/partially-linked-markdown-file.md`
fails if the markdown file has some diagrams that are already linked.

Now, already linked diagrams are ignored if they're located within a
markdown file.

Author: aloisklink

packages/cli/src/commander.test.ts

@@ -13,7 +13,9 @@ import type { MCDocument, MCProject, MCUser } from '@mermaidchart/sdk/dist/types
 const CONFIG_AUTHED = 'test/fixtures/config-authed.toml';
 /** Markdown file that has every Mermaid diagrams already linked */
 const LINKED_MARKDOWN_FILE = 'test/fixtures/linked-markdown-file.md';
-/** Markdown file that has some unlinked Mermaid diagrams */
+/** Markdown file that has some linked and some unlinked Mermaid diagrams */
+const PARTIALLY_LINKED_MARKDOWN_FILE = 'test/fixtures/partially-linked-markdown-file.md';
+/** Markdown file that has unlinked Mermaid diagrams */
 const UNLINKED_MARKDOWN_FILE = 'test/fixtures/unlinked-markdown-file.md';
 
 type Optional<T> = T | undefined;
@@ -297,6 +299,30 @@ describe('link', () => {
     expect(file).toMatch(`id: ${mockedEmptyDiagram.documentID}\n`);
     expect(file).toMatch(`id: second-id\n`);
   });
+
+  it('should link diagrams in partially linked markdown file', async () => {
+    const partiallyLinkedMarkdownFile = 'test/output/partially-linked-markdown-file.md';
+    await copyFile(PARTIALLY_LINKED_MARKDOWN_FILE, partiallyLinkedMarkdownFile);
+
+    const { program } = mockedProgram();
+
+    vi.mock('@inquirer/confirm');
+    vi.mock('@inquirer/select');
+    vi.mocked(confirm).mockResolvedValue(true);
+    vi.mocked(select).mockResolvedValueOnce(mockedProjects[0].id);
+
+    vi.mocked(MermaidChart.prototype.createDocument).mockResolvedValueOnce({
+      ...mockedEmptyDiagram,
+      documentID: 'second-id',
+    });
+    await program.parseAsync(['--config', CONFIG_AUTHED, 'link', partiallyLinkedMarkdownFile], {
+      from: 'user',
+    });
+
+    const file = await readFile(partiallyLinkedMarkdownFile, { encoding: 'utf8' });
+
+    expect(file).toMatch(`id: second-id\n`);
+  });
 });
 
 describe('pull', () => {

packages/cli/src/commander.ts

@@ -218,6 +218,7 @@ function linkCmd() {
           cache: linkCache,
           title: path,
           getProjectId,
+          ignoreAlreadyLinked: false,
         });
 
         await writeFile(path, linkedDiagram, { encoding: 'utf8' });

packages/cli/src/methods.ts

@@ -39,28 +39,37 @@ interface CommonOptions {
 export interface LinkOptions extends CommonOptions {
   /** Function that asks the user which project id they want to upload a diagram to */
   getProjectId: (cache: LinkOptions['cache'], documentTitle: string) => Promise<string>;
-  // cache to be shared between link calls. This object may be modified between calls.
+  /** cache to be shared between link calls. This object may be modified between calls. */
   cache: Cache;
+  /** If `true`, ignore diagrams that are already linked. */
+  ignoreAlreadyLinked: boolean;
 }
 
 /**
  * Creates a new diagram on MermaidChart.com for the given local diagram.
  *
  * @returns The diagram with an added `id: xxxx` field.
  */
-export async function link(diagram: string, client: MermaidChart, options: LinkOptions) {
+export async function link(
+  diagram: string,
+  client: MermaidChart,
+  { title, getProjectId, cache, ignoreAlreadyLinked }: LinkOptions,
+) {
   const frontmatter = extractFrontMatter(diagram);
 
   if (frontmatter.metadata.id) {
-    throw new CommanderError(
-      /*exitCode=*/ 1,
-      'EALREADY_LINKED',
-      'This document already has an `id` field',
-    );
+    if (ignoreAlreadyLinked) {
+      console.log(`○ - ${title} is already linked`);
+      return diagram; // no change required
+    } else {
+      throw new CommanderError(
+        /*exitCode=*/ 1,
+        'EALREADY_LINKED',
+        'This document already has an `id` field',
+      );
+    }
   }
 
-  const { title, getProjectId, cache } = options;
-
   const projectId = await getProjectId(cache, title);
 
   const createdDocument = await client.createDocument(projectId);

packages/cli/src/remark.ts

@@ -53,6 +53,7 @@ export function plugin({ client, ...options }: MCPluginOptions) {
             cache: options.cache,
             title: ``,
             getProjectId: options.getProjectId,
+            ignoreAlreadyLinked: true,
           });
           break;
         case 'pull': {

packages/cli/test/fixtures/partially-linked-markdown-file.md

@@ -0,0 +1,25 @@
+# Test markdown file with some linked diagrams and some unlinked diagrams
+
+Here is a markdown comment: <!-- Hello World -->
+
+This is a journey diagram that is already linked.
+
+```mermaid
+---
+id: xxxxxxx-journey
+---
+journey
+    title This is a linked journey diagram.
+    section Use mermaidchart.com CLI
+        Run link command: 5: Me
+        Edit diagram on mermaidchart.com: 5: Me
+        Run pull command to sync changes locally: 5: Me
+```
+
+This is a class diagram that isn't linked.
+
+```mermaid
+classDiagram
+    note "From local to mermaidchart"
+    mermaidchart <|-- local
+```