Writer Plugin Utilities

Package with useful commands, scripts, and utilities used by writer plugins which use the Writer Plugin Jumpstart project to get started.

Upgrading to version 2.0+?

Please read this handy guide when upgrading to version 2.0+.

Features

Webpack and Babel configuration

The main export of this package is a webpack configuration which can be used when developing a Writer Plugin.

TypeScript

As a sub feature to webpack and babel this package also comes with typescript support.

Build and Validation Commands

This package exposes some commands which are used when developing a Writer Plugin.

writer-bump-manifest
writer-validate-manifest
writer-validate-plugin

CI Commands

The following commands are used in bitbucket pipelines to upload a built plugin to S3.

writer-ci-version-sync
writer-ci-manifest-env
writer-ci-upload-plugin

Jumpstart Command

The following command will jumpstart development of a new Writer Plugin.

writer-jumpstart-plugin
writer-jumpstart-upgrade

Usage

No commands should really be run on their own, this package is intended to be used by the Writer Plugin Jumpstart project.

Environment Variables

Recommended to set these variables in bitbucket on Team level.

// Values used by bitbucket pipeline
WRITER_PLUGIN_AWS_ACCESS_KEY_ID
WRITER_PLUGIN_AWS_SECRET_ACCESS_KEY_ID
WRITER_PLUGIN_ARCHIVE_BUCKET // Target bucket for zip archives
WRITER_PLUGIN_AWS_REGION // Region where the bucket is

// Values used by writerctl
WRITER_WPM_AWS_ACCESS_KEY_ID
WRITER_WPM_AWS_SECRET_ACCESS_KEY
WRITER_WPM_AWS_DEFAULT_REGION
WRITER_WPM_AWS_DEFAULT_REGION