@automattic/calypso-config
Advanced tools
Readme
This library can be used for managing server- and client-side configs.
All configs are stored in .json files (see examples in sample-config) in a config folder in your working directory. This path can be overridden via the CALYPSO_CONFIG_PATH environment variable.
At boot-up time, the server decides which config file to use based on the NODE_ENV environment variable. The default value is development. For values shared across environments, add them to the _shared.json file. Local-only values can be added via a {environment}.local.json file (e.g. development.local.json).
The entire configuration is available on the server-side and certain keys can be exposed to the client.
Config values can be retrieved by invoking the config() exported function with the desired key name:
import config from '@automattic/calypso-config';
console.log( config( 'redirect_uri' ) );
To access config values on the client-side, add the property name to the client.json file, which is a whitelist of config properties that will be exposed to the client.
A global configData object must also be output during the initial render. Here's an example using webpack and the interpolate
In your webpack build config:
const HtmlWebpackPlugin = require( 'html-webpack-plugin' );
const InterpolateHtmlPlugin = require( 'react-dev-utils/InterpolateHtmlPlugin' );
const clientData = require( '@automattic/calypso-config' ).clientData;
// ...
const interpolateHtmlData = Object.assign( {}, {
CALYPSO_CONFIG_DATA_AS_JSON: JSON.stringify( clientData ),
} );
// ...
module.exports = {
// ...
plugins: [
new InterpolateHtmlPlugin( interpolateHtmlData ),
new HtmlWebpackPlugin( {
inject: true,
template: '/path/to/index.html',
} ),
],
// ...
}
Then, in your index.html template:
<html>
<head>
...
<script>var configData = %CALYPSO_CONFIG_DATA_AS_JSON%;</script>
...
</head>
</html>
And finally, to access the configs:
import config from '@automattic/calypso-config/client';
console.log( config( 'redirect_uri' ) );
console.log( config.isEnabled( 'secret-features' ) );
The config files contain a features object that can be used to determine whether to enable a feature for certain environments. This allows us to merge in-progress features without launching them to production. The config module adds a method to detect this: config.isEnabled(). Please make sure to add new feature flags alphabetically so they are easy to find.
{
"features": {
"manage/posts": true,
"reader": true
}
}
If you want to temporarily enable/disable some feature flags for a given build, you can do so by setting the ENABLE_FEATURES and/or DISABLE_FEATURES environment variables. Set them to a comma separated list of features you want to enable/disable, respectively:
ENABLE_FEATURES=manage/plugins/compatibility-warning DISABLE_FEATURES=code-splitting,reader npm start
If you want to temporarily enable/disable some feature flags you can add a ?flags= query parameter to the URL.
Note that this only works on development, staging, and calypso.live, not in production (this functionality is not suitable for public use on *.wordpress.com).
?flags=foo enables feature foo.?flags=-bar disables feature bar.?flags=foo,-bar enables feature foo and disables feature bar.E.g. http://calypso.localhost:3000/?flags=manage/plugins/compatibility-warning
FAQs
Simple server and client config module. Originally written for wp-calypso.
The npm package @automattic/calypso-config receives a total of 6,719 weekly downloads. As such, @automattic/calypso-config popularity was classified as popular.
We found that @automattic/calypso-config demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 29 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.