diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 00000000..a9e1f66c --- /dev/null +++ b/.cspell.json @@ -0,0 +1,37 @@ +{ + // Version of the setting file. Always 0.2 + "version": "0.2", + // language - current active spelling language + "language": "en-US", + "ignorePaths": [ + "composer.*", + "tests", + "vendor" + ], + "dictionaries": [ + "dictionary", + "drupal", + "companies", + "fonts", + "html", + "php", + "softwareTerms" + ], + // words - list of words to be always considered correct + "words": [ + "autoloader", + "codesniffer", + "Komodo", + "Netbeans", + "phpcbf", + "ruleset", + "squizlabs", + "Squiz" + ], + // flagWords - list of words to be always considered incorrect + // This is useful for offensive words and common spelling errors. + // For example "hte" should be "the" + "flagWords": [ + "hte" + ] +} diff --git a/README.md b/README.md index b7493fdf..5c5ee203 100644 --- a/README.md +++ b/README.md @@ -73,8 +73,8 @@ phpcs.xml.dist file in your project like this: ```xml - - PHP CodeSniffer configuration for myproject development. + + PHP CodeSniffer configuration for example development. . @@ -139,7 +139,7 @@ Then execute the coding standards checker on Coder itself: Then execute static analysis: - ./vendor/bin/phpstan analyse + ./vendor/bin/phpstan ## Contributing @@ -154,6 +154,8 @@ Thank you! ## Maintainers +[//]: # cspell:ignore Pieter Frenssen Welford + - Pieter Frenssen, https://www.drupal.org/u/pfrenssen - Michael Welford, https://www.drupal.org/u/mikejw - Klaus Purer, https://www.drupal.org/u/klausi