Skip to content

Commit

Permalink
Note the phpcs setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark-H committed Sep 19, 2023
1 parent ff68ff3 commit f08e3f8
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Commerce Module Skeleton

This repository contains a skeleton for a Commerce module project. It is meant to be installed with composer.

```` bash
```` bash
mkdir my-project
composer create-project modmore/moduleskeleton my-project
````

The skeleton will automatically rename the various bits and pieces with the name of the directory you install it in. This will apply a few transforms.
The skeleton will automatically rename the various bits and pieces with the name of the directory you install it in. This will apply a few transforms.

- For the name of directories, lexicons, etc, the directory name will be lowercased and in some places prefixed with `commerce_`.
- For the name of the namespace, module, and other "friendly" places the project name is used, it breaks up the project name by `-`, uppercase the first letter of each part, and stick those together. (E.g. a directory named `foo-bar` will be turned into `FooBar`)
Expand All @@ -23,5 +23,9 @@ The skeleton will automatically rename the various bits and pieces with the name
- Under `model/schema`, a sample xPDO package schema. If you use this, you'll find a script in `/_build/build.schema.php` to turn it into a model and (commented out) code in `src/Modules/Projectname.php` to load the package.
- In `src/Modules/Projectname.php` a module, complete with basic methods filled out.
- A `composer.json` file defining a PSR-4 autoloader for your namespace and project name. If you change this, run `composer dump-autoload` in the `core/components/projectname/` directory to update the autoloader.
- A basic phpcs ruleset that both checks PHP 7.4-8.2 compatibility and a standard set of coding standards that we use for our projects. This is in both `.github/workflows/phpcs.yml` to run automatically on pushes to GitHub, and in `composer.json` in the root of the project.
- To run locally, make sure to do a `composer install` in the root.
- Run `composer run phpcs` to check the coding standards and PHP version compatibility
- Run `composer run phpcbf` to automatically fix code that doesn't comply with the coding standards, where possible

Happy building!
Happy building!

0 comments on commit f08e3f8

Please sign in to comment.