feat(cli): support pull/push/link on multiple mermaid files at once

[aloisklink]

Draft PR: This PR is stacked on top of:

• Add a @mermaidchart/cli CLI tool for accessing Mermaid Chart #12, which is stacked on top of
• feat: add setDocument(document) API function #11, which is stacked on top of
• feat: add deleteDocument(documentID) API func #10, which is stacked on top of
• feat: add createDocument(projectID) API function #9.

Please change this PR to target main once #12 has been merged.

📖 Description

Currently, the mermaid-chart CLI can only pull/push/link a single file at a time.

This PR adds support for pulling/pushing/linking multiple files at once with the @mermaidchart/cli CLI, e.g. like mermaid-chart pull file1 file2.

If using bash, this means you can run commands like npx mermaid-chart pull docs/*.mmd, as your shell will automatically expand docs/*.mmd.

me@pc:~$ npx mermaid-chart --help
Usage: mermaid-cli [options] [command]

CLI for interacting with https://MermaidChart.com, the platform that makes collaborating with Mermaid diagrams easy.

Options:
  -V, --version               output the version number
  -c, --config <config_file>  The path to the config file to use. (default: "/home/alois/.config/mermaid-chart.toml")
  -h, --help                  display help for command

Commands:
  whoami                      Display Mermaid Chart username
  login                       Login to a Mermaid Chart account
  logout                      Log out of a Mermaid Chart account
  link <path...>              Link the given Mermaid diagrams to Mermaid Chart
  pull [options] <path...>    Pulls documents from Mermaid Chart
  push <path...>              Push local diagrams to Mermaid Chart
  help [command]              display help for command

link-ing multiple files

When running mermaid-chart link diagram1.mmd diagram2.mmd diagram3.mmd, the mermaid-chart CLI will ask the user if they want to upload all the diagrams to the same project. If not, then the CLI will ask the user for the project for each diagram:

me@pc:~/MermaidChart/plugins/packages/cli (feat/support-multiple-files-at-once-in-cli)$ npx ts-node@^11.0.0-beta.1 --esm ./src/cli.ts link test/output/unsynced*.mmd
? Select a project to upload test/output/unsynced1.mmd to tmp
? Would you like to upload all diagrams to this project? no
? Select a project to upload test/output/unsynced2.mmd to tmp
? Select a project to upload test/output/unsynced3.mmd to tmp
? Select a project to upload test/output/unsynced.mmd to
  personal
  GitHub Actions test project
❯ tmp

push/pull-ing multiple files

When pulling/pushing multiple files, the CLI will print some info about each file:

me@pc:~/MermaidChart/plugins/packages/cli (feat/support-multiple-files-at-once-in-cli)$ npx ts-node@^11.0.0-beta.1 --esm ./src/cli.ts push test/output/unsynced*.mmd
✅ - test/output/unsynced3.mmd is up to date
✅ - test/output/unsynced2.mmd is up to date
✅ - test/output/unsynced1.mmd is up to date
me@pc:~/MermaidChart/plugins/packages/cli (feat/support-multiple-files-at-once-in-cli)$ npx ts-node@^11.0.0-beta.1 --esm ./src/cli.ts pull test/output/unsynced*.mmd
✅ - test/output/unsynced1.mmd is up to date
✅ - test/output/unsynced2.mmd was updated
✅ - test/output/unsynced3.mmd is up to date

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
office-plugin-site	⬜️ Ignored (Inspect)	Visit Preview		Apr 16, 2024 8:48am