feat(cli): support reading auth token in CLI with --auth-token and in ENV with MERMAID_CHART_AUTH_TOKEN

[aloisklink]

Note

This PR is stacked on top of:

• feat(cli)!: use a URL id in the frontmatter #20, which is stacked on top of
• feat(cli): support mermaid diagrams within GFM (github flavored markdown) #16, which is stacked on top of
• feat(cli): support pull/push/link on multiple mermaid files at once #15, which is stacked on top of
• Add a @mermaidchart/cli CLI tool for accessing Mermaid Chart #12

Support loading the auth token and Mermaid Chart base URL from environment variables using MERMAID_CHART_AUTH_TOKEN and MERMAID_CHART_BASE_URL, and from the CLI using --auth-token <authToken> and --base-url <baseUrl>.

The order of priority is:

1. CLI --options
2. Environment variables
3. Config file
4. Default values

This is to make it easier for us to use the @mermaidchart/cli in CI providers, like in a GitHub Action workflow.

Notes to reviewers

I've used Commander.js to handle setting these variables, so run npx @mermaidchart/cli automatically prints documentation for this:

alois@pc:~/plugins/packages/cli (feat/support-loading-tokens-from-environment-variables)$ npx tsx src/cli.ts --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")
  --base-url <base_url>       The base URL of the Mermaid Chart instance to use. (default: "https://mermaidchart.com", env: MERMAID_CHART_BASE_URL)
  --auth-token <auth_token>   The Mermaid Chart API token to use. (env: MERMAID_CHART_AUTH_TOKEN)
  -h, --help                  display help for command

<---TRUNCATED TO MAKE THIS PR SMALLER -->

Also, I know this is a bit of a big PR, so it might be easier to review it commit-by-commit!

[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 12, 2024 1:11pm