@mservicestech/design-system-automator
v1.19.0-rc.16
Published
Command-line interface for managing design systems
Downloads
4
Readme
design-system-automator
Command-line interface for managing design systems.
Configuration
To configure the tool, put the relevant confguration inside design-system-automator.config
file with a ts
or cjs
extension.
When using TypeScript, make sure to transpile it before usage, as native TypeScript configuration is not currently supported.
Example configuration:
/* example TypeScript configuration */
export default {
designSystemPackage: {
scopeName: '@mbank-design',
packageName: 'design-system',
},
};
/* example CommonJS configuration */
module.exports = {
default: {
designSystemPackage: {
scopeName: '@mbank-design',
packageName: 'design-system',
},
},
};
Custom commit message
In order to set an environment variable AUTOMATOR_COMMIT_MESSAGE
with the message that will be used for the commit, run:
for example:
AUTOMATOR_COMMIT_MESSAGE="chore(<your project>): update design system to version <version>" npx --yes @mservicestech/design-system-automator@latest
Note: if variable is not set, default commit message "chore: Upgrade <scopeName/packageName>" will be used.
Logging debug information
The tool will output only info, warning and error messages when NODE_ENV
environment variable is set to production
. In
order to view debug logs, please set NODE_ENV
to development
:
NODE_ENV=development npx --yes @mservicestech/design-system-automator@latest
In that case, debug logs will show with all the above messages as defined in production
mode.