Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): document the --zip flag in the plasmo build CLI #1051

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

timrogers
Copy link
Contributor

@timrogers timrogers commented Aug 23, 2024

Details

The plasmo build CLI supports a --zip flag which builds your extension and then packages it into a ZIP file.

This is mentioned in the Plasmo docs, but not in the in-CLI help, which I found confusing.

This adds it to the help output, in the process splitting the documentation for the dev and build commands.

Code of Conduct

  • I agree to follow this project's Code of Conduct
  • I agree to license this contribution under the MIT LICENSE
  • I checked the current PR for duplication.

Contacts

  • (OPTIONAL) Discord ID:

If your PR is accepted, we will award you with the Contributor role on Discord server.

To join the server, visit: https://www.plasmo.com/s/d

The `plasmo build` CLI supports a `--zip` flag which builds your
extension and then packages it into a ZIP file.

This is mentioned in the Plasmo docs, but not in the in-CLI
help, which I found confusing.

This adds it to the help output, in the process splitting the
documentation for the `dev` and `build` commands.
@timrogers timrogers changed the title Document the --zip flag in the plasmo build CLI fix(docs): document the --zip flag in the plasmo build CLI Aug 23, 2024
@timrogers
Copy link
Contributor Author

After this change, the output looks like this:

🟣 Plasmo v0.88.0
🔴 The Browser Extension Framework
🟠 CMDS   | help | start | init | dev | build | package | version | -v | --version
🟡 OPTS   |

    init

      --entry                     entry files (default: popup)
      --with-<name>               use an example template

    dev

      --target [string]           set the target (default: chrome-mv3)
      --tag [string]              set the build tag (default: dev or prod depending on NODE_ENV)
      --src-path [path]           set the source path relative to project root (default: src)
      --build-path [path]         set the build path relative to project root (default: build)
      --entry                     entry point name (default: popup)
      --env                       relative path to top-level env file

    build

      --target [string]           set the target (default: chrome-mv3)
      --tag [string]              set the build tag (default: dev or prod depending on NODE_ENV)
      --src-path [path]           set the source path relative to project root (default: src)
      --build-path [path]         set the build path relative to project root (default: build)
      --entry                     entry point name (default: popup)
      --env                       relative path to top-level env file
      --zip                       zip the build output

@louisgv louisgv self-requested a review August 26, 2024 07:16
Copy link
Contributor

@louisgv louisgv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@louisgv louisgv added this pull request to the merge queue Aug 26, 2024
Merged via the queue into PlasmoHQ:main with commit bed1eec Aug 26, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants