https://github.com/WPP-Public/Drupal-KIT-Docksal-Commands

Docksal development environment commands provided as part of VML's Drupal KIT distribution.
https://github.com/WPP-Public/Drupal-KIT-Docksal-Commands

Last synced: 11 months ago
JSON representation

Docksal development environment commands provided as part of VML's Drupal KIT distribution.

• Host: GitHub
• URL: https://github.com/WPP-Public/Drupal-KIT-Docksal-Commands
• Owner: VMLYR
• Created: 2018-08-28T22:09:20.000Z (almost 8 years ago)
• Default Branch: 8.x-2.x
• Last Pushed: 2023-08-15T21:56:08.000Z (almost 3 years ago)
• Last Synced: 2024-11-24T11:35:46.037Z (over 1 year ago)
• Language: Shell
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 8
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Drupal KIT Docksal Commands

The project uses [Docksal](https://docksal.io/) for local-environment development and project-building. To get these to

install correctly for your project, make sure that `".docksal/commands/kit": ["vmlyr-drupal/kit-docksal-commands"],` is

set correctly in the `extra / installer-paths` section of the project's composer.json file.

 The following is a list of the KIT-specific Docksal commands included:

 - `kit/check-url` – Runs through the collection of URLs and checks whether they appropriate match their requested

 response (default is 200). Can also count number of errors logged when pages were checked.

 - `kit/conf` – A wrapper command used in lieu of `drush cex`/`cim` which helps handle environment-specific

 configuration export and import. **Please Note: To correctly export _as_ an environment, the environment first needs to

 be imported. The changes can then be made and exported. This makes sure that there is no environment cross-polution.

 Typically, importing and exporting as "local" is the most fool-proof way of handling configuration unless an

 environment-specific change needs to be made.**

 - `kit/gulp` – Wrapper command to run the npm gulp commands inside theme source directory.

 - `kit/init-db` – To initialize or reinitialize one or multiple site's databases based on their drush alias files.

 - `kit/npm` – Wrapper command to run the npm gulp commands inside theme source directory.

 - `kit/phpcbf` – Run Code Beautifier & Fixer (`phpcbf`) against a given path.

 - `kit/phpcs` – Run Code Sniffer (`phpcs`) against a given path.

 - `kit/sync` – Sync database (and optionally files) to a local environment from an external environment. After the

 database is imported, the site runs various updates and imports configuration as a specified (default: local)

 environment.

 - `kit/theme` – Use this command to auto-create new themes based on VMLY&R's scaffolding themes.