Registry / devops / codeplay-common

codeplay-common

JSON →
library3.2.19jsnpmunverified

CodePlay Common is a set of build scripts and shared configuration files for Capacitor-based mobile apps. Version 3.2.19 simplifies common tasks like splash screen animation, automatic AdMob ID extraction from capacitor.config.json, and generating build variants for multiple app stores. It installs In-App Purchase plugins conditionally based on the target store. The package is intended to reduce boilerplate and manual setup by 40% for multi-app projects. It integrates with Ionic and Capacitor workflows, targeting developers who maintain multiple apps with shared build logic. The package is actively maintained on GitHub by merbin2012, though full source requires donation.

devops
npm install codeplay-common
github ↗package ↗
INSTALL
IMPORT
SIG · CODEPLAY-COMMON
C
codeplay-common
devopsjavascriptv3.2.19
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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

default
✓ import codeplayCommon from 'codeplay-common'
✗ const codeplayCommon = require('codeplay-common')
ESM-only package; CommonJS require not supported
CodePlayBuild
✓ import { CodePlayBuild } from 'codeplay-common'
✗ import CodePlayBuild from 'codeplay-common'
Named export, not default
SplashConfig
✓ import type { SplashConfig } from 'codeplay-common'
✗ import { SplashConfig } from 'codeplay-common'
Use type import for TypeScript type declarations

Demonstrates importing the default export and running a build with common configuration for splash screen and multi-store output.

import codeplayBuild from 'codeplay-common'; const config = { appName: 'MyApp', version: '1.0.0', stores: ['google', 'apple'], splash: { backgroundColor: '#ffffff', animation: 'fade' } }; codeplayBuild(config) .then(() => console.log('Build completed')) .catch(err => console.error(err));
Debug
Known issues
gotchaDo not import from subpaths; only main entry point is supported.
fix
Use 'import codeplayCommon from 'codeplay-common'' instead of 'import ... from 'codeplay-common/dist/...'
affects: >=3.0
deprecatedThe 'cordova-plugin-iap' dependency is deprecated; migrate to @capacitor/inapppurchases.
fix
Replace IAP plugin with @capacitor/inapppurchases and update build config.
affects: >=3.0
breakingVersion 3.0 changed the configuration structure — old 'googlePlay' and 'appleStore' keys are now merged into 'stores' array.
fix
Use 'stores: ['google', 'apple']' instead of 'googlePlay: true, appleStore: true'
affects: >=3.0
gotchaThe package requires capacitor.config.json to exist in the project root; missing file causes silent failure.
fix
Ensure capacitor.config.json is present and contains valid JSON.
affects: >=1.0
Errors
Common errors & fixes
Error: Cannot find module 'codeplay-common'
Package not installed or ESM import used in CommonJS project
fix
Run 'npm install codeplay-common' and ensure project is configured for ESM (type: module in package.json or use .mjs extension)
TypeError: codeplayCommon is not a function
Incorrect import — default import used when named import was expected
fix
Use 'import codeplayBuild from 'codeplay-common'' for default, or 'import { CodePlayBuild } from 'codeplay-common'' if using named export
SyntaxError: Unexpected token 'export'
ESM syntax used without proper configuration or transpilation
fix
Add 'type': 'module' to package.json or transpile with Babel/TypeScript
Error: Could not find capacitor.config.json
Missing configuration file in project root
fix
Create capacitor.config.json with at least {} in the project root directory
Upgrade
Version history
3.2.19latest on npm
Audit
Dependencies
@capacitor/corerequiredRuntime dependency for Capacitor APIs used in build scripts and app configuration
cordova-resrequiredUsed for generating splash screens and icons
cordova-plugin-request-reviewoptionalPlugin for in-app review requests, conditional on store
cordova-plugin-iapoptionalPlugin for in-app purchases, installed conditionally based on store
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/merbin2012/codeplay-common ↗
packagehttps://www.npmjs.com/package/codeplay-common ↗
codeplay-common — npm install codeplay-common · libregistry