Check our own coding standards and basic editor configurations

Migrated issue

Reported by: fjgarlin

Related to !151 (merged)

Problem/Motivation

We don't check for coding standards on our own files and there is no editor configuration, so sometimes we get unexpected whitespace changes (and similar) when rebasing after other issues have been merged.

Proposed resolution

- Add .editorconfig file, similar to https://git.drupalcode.org/project/drupal/-/blob/11.x/.editorconfig?ref_type=heads
- Do a basic linting of the files in the repo via a job

Outcome

This project's own .gitlab-ci.yml has a new job Check Code which runs the following:

  • CSPELL checks for spelling errors in all project files ( * except the markdown files in /docs)
  • ESLINT (including PRETTIER formatting) checks all .yml files
  • PHPCS checks all php files using the full Drupal and DrupalPractice coding standards
  • SHELLCHECK checks the .sh bash scripts

* Spelling of the markdown documentation files was already being done. The dictionary of words is now shared with CSPELL.

Related issue: Issue #3367780

Related issue: Issue #3357647

Edited by drupalbot