@squiz/dxp-plugin-template

Install Tool

This is the install tool for the plug and play components. This tool can be installed in a repo as a node module or run one time via npx.

Installation

NPX

To install plug and play components via npx simply run npx git+ssh://[e-mail]:plug-and-play/install-tool.git this will download the install tool and run it, giving you the available components to install. It should be noted that if you have components that clash with the selected components to install, the tool will alert you to this and suggest that you rename these folders.

You will need to run the npx command each time you wish to run the install tool.

Dependencies

There are two kinds of dependencies for Plug and Play components: Local and External. Local dependencies are other Plug and Play components which may be re-usable block of code used im multiple places across the P&P landscape. e.g the Video Modal component makes use of the common Modal component. External dependencies are other NPM packages which are needed for the component to function, often utility packages, e.g. the Modal component uses ally.js and focus-trap to perfom several WCAG functions.

Auto install

When installing components using the Plug and Play Install Tool you will be prompted for if you want the tool to automatically install the dependencies; if you do the tool will handle the rest, if you refuse you will be prompted for each components dependency set for if you want it installed or if you will handle the dependency installation yourself.

Local depedency detection

The tool will check if a local dependency is already installed and skip if it is, this check is performed ONLY based on the /src/module/; no attempt to verify this is actually a P&P component is performed or that it is the correct version.

Manually resolving local dependencies

If you opt to install dependencies yourself you may find not all Local Dependencies are includes in the install tool options by default, to expand the full list to include dependant only modules include the --deps argument when invoking the install tool.

Name conflicts when installing components or dependencies

The install tool will not install a component or dependency if it find a like named module in /src/module, it will alert via the console that the install has been skipped. To resolve backout the changes performed by the P&P install tool, rename or move the folder(s) that are causing issues and re-installed P&P component via the tool. Once installed you can rename the P&P or existing components as needed.

Where do i report an issue or error with the tool?

#plug-and-play slack channel