Registry / devops / ember-cli-deploy-plugin

ember-cli-deploy-plugin

library0.2.9jsnpmunverified

Base class for building plugins for ember-cli-deploy. Version 0.2.9 is the latest stable release, with a slow release cadence (last release 2016). It provides a base class with helpers for config management (defaultConfig, requiredConfig, readConfig), logging (log method with color and verbose options), and async hooks (returning promises). Key differentiator: standardizes plugin development across the ember-cli-deploy ecosystem, reducing boilerplate and ensuring consistent behavior. Older versions may have breaking changes, e.g., v0.2.7 changed `this` context in config functions.

devops

npm install ember-cli-deploy-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · EMBER-CLI-DEPLOY-P

ember-cli-deploy-plugin

devopsjavascriptv0.2.9

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DeployPluginBase

✓ const DeployPluginBase = require('ember-cli-deploy-plugin');

✗ import DeployPluginBase from 'ember-cli-deploy-plugin';

The package only provides a CommonJS module; ESM import is not supported.

module.exports.createDeployPlugin

✓ module.exports = { createDeployPlugin: function(options) { ... } };

✗ export default function createDeployPlugin(options) { ... }

The plugin must be exported as an object with a createDeployPlugin function, not a default function.

this.readConfig

✓ this.readConfig('key');

✗ this.config['key'];

Use readConfig method instead of directly accessing config object to get default values or dynamic functions.

Demonstrates creating a custom deploy plugin using the base class, with default config, required config, and a hook.

// index.js 'use strict'; var DeployPluginBase = require('ember-cli-deploy-plugin'); module.exports = { name: 'ember-cli-deploy-awesomeness', createDeployPlugin: function(options) { var DeployPlugin = DeployPluginBase.extend({ name: options.name, defaultConfig: { someKey: 'defaultValue' }, requiredConfig: ['awesomeApiKey'], willUpload: function(context) { var someValue = this.readConfig('someKey'); this.log('Log message', { color: 'green' }); return Promise.resolve(); } }); return new DeployPlugin(); } };

Debug

Known issues

breakingContext of `this` within user-defined config property functions changed from the base plugin to the surrounding config object.

fix

Update config functions to reference the config object instead of the plugin instance.

affects: 0.2.7

gotchaThe package only supports CommonJS require; using ES6 import syntax will fail.

fix

Use const pkg = require('ember-cli-deploy-plugin'); instead of import.

affects: >=0.2.0

deprecatedThe package is now in maintenance mode and not actively developed for new features.

fix

Consider migrating to ember-cli-deploy's newer plugin patterns if available.

affects: >=0.2.9

Errors

Common errors & fixes

Cannot find module 'ember-cli-deploy-plugin'

Package not installed or incorrect module path.

fix

Run `npm install ember-cli-deploy-plugin --save-dev` in your plugin directory.

TypeError: this.readConfig is not a function

The plugin instance does not have readConfig method, likely because the base class was not extended correctly.

fix

Ensure you call DeployPluginBase.extend({...}) and return new DeployPlugin() in createDeployPlugin.

The plugin did not provide a name

Missing name property in the plugin object or options.name not passed.

fix

Set name in module.exports.name or pass options.name to the createDeployPlugin function.

Upgrade

Version history

0.2.9latest on npm

Audit

Dependencies

core-objectrequiredBase class for the DeployPluginBase uses CoreObject.extend pattern

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/ember-cli-deploy/ember-cli-deploy-plugin ↗

packagehttps://www.npmjs.com/package/ember-cli-deploy-plugin ↗