Skip to content

Add and apply coding standards. #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
costdev merged 39 commits into from
Jun 26, 2025
Merged

Add and apply coding standards. #129

costdev merged 39 commits into from
Jun 26, 2025

Conversation

@costdev
Copy link
Member

@costdev costdev commented Jun 24, 2025 •
edited
Loading

This adds coding standards heavily based on the Human Made Coding Standards, with some modifications to suit our needs.

Ruleset changes

  • Generic.Functions.CallTimePassByReference is excluded as it's deprecated in PHPCS and will be removed in 4.0.0.
  • HM.Debug.ESLint is excluded as scanning CSS/JS files is deprecated in PHPCS and will be removed in 4.0.0.
  • HM.Files.FunctionFileName.WrongFile is excluded for plugin.php as it's the main plugin file.
  • PSR1.Files.SideEffects is excluded for plugin.php and tests/phpunit/bootstrap.php as they intentionally define symbols and execute code.
  • Excluded for test files:
    • WordPress.Files.FileName
    • HM.Files.ClassFileName
    • HM.Functions.NamespacedFunctions.MissingNamespace
    • PSR1.Classes.ClassDeclaration.MissingNamespace

Development scripts

The following scripts have been added:

  • Composer
    • composer run lint - Runs PHPCS against the codebase.
    • composer run format - Runs PHPCBF against the codebase.
  • NPM
    • npm run lint:php - Runs PHPCS against the codebase inside the cli container.
    • npm run format:php - Runs PHPCBF against the codebase inside the cli container.

This PR also includes a coding standards workflow for GitHub Actions.

Codebase changes

This PR includes various fixes to ensure the codebase complies with the coding standards. These are separated into different commits, prefixed with "Fix:", "Ignore:" or "Disable:".

Fixes #128

@costdev costdev requested review from afragen and rmccue June 24, 2025 16:18
afragen
afragen approved these changes Jun 26, 2025
View reviewed changes
Copy link
Contributor

@afragen afragen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now working (for me)

costdev
costdev commented Jun 26, 2025
View reviewed changes
afragen
afragen previously requested changes Jun 26, 2025
View reviewed changes
@afragen afragen dismissed their stale review June 26, 2025 15:06

Fixed

costdev
costdev commented Jun 26, 2025
View reviewed changes
@afragen afragen mentioned this pull request Jun 26, 2025
Merged
@afragen afragen self-requested a review June 26, 2025 16:52
@costdev costdev force-pushed the coding_standards branch from 3f1d6e3 to 94b0eae Compare June 26, 2025 16:57
costdev added 19 commits June 26, 2025 17:58
@costdev
Add Human Made Coding Standards.
aa93537 
Signed-off-by: costdev <[email protected]>
@costdev
Add ruleset.
2fe173d 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Use tabs for indentation.
0c2c378 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Use allowed end characters for inline comments.
e852443 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Spacing issues.
af77b76 
Signed-off-by: costdev <[email protected]>
@costdev
Disable: Some embedded PHP rules for the Settings module.
975f984 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Use short array syntax.
a9771f5 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Remove unused use statements.
a716c66 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Use a proper docblock for FAIR\load_textdomain().
53d69e2 
Signed-off-by: costdev <[email protected]>
@costdev
Ignore: CapitalPDangit for a regex pattern.
4da9665 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Escape output.
f1c6157 
Signed-off-by: costdev <[email protected]>
@costdev
Ignore: print_r() rule when $return is true.
c2d7acc 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Unslash and sanitize $_POST variable.
7b4a33b 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Account for a missing $_GET variable.
ff07ef0 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Verify the nonce when saving avatar uploads.
ed8792b 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Use wp_rand() instead of mt_rand().
5d79724 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Add missing parameter comments.
3ba175b 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Add missing file doc comments.
3e2e417 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Add missing function doc comments.
3e2a739 
Signed-off-by: costdev <[email protected]>
costdev and others added 15 commits June 26, 2025 17:58
@costdev
Add Workflow.
d1cc177 
Signed-off-by: costdev <[email protected]>
@costdev
Add Composer and NPM scripts.
6faee6a 
Signed-off-by: costdev <[email protected]>
@costdev
Remove duplicated permissions entry in the workflow.
a468c81 
Signed-off-by: costdev <[email protected]>
@costdev
Don't ignore the .cache directory yet.
aa53c49 
Signed-off-by: costdev <[email protected]>
@costdev
Workflow: Add missing . to PHPCS run.
46ac5ea 
Signed-off-by: costdev <[email protected]>
@costdev
Remove --report=summary,source.
a1033a1 
Signed-off-by: costdev <[email protected]>
@costdev
Add text_domain and minimum_supported_version properties.
03a7eb3 
Signed-off-by: costdev <[email protected]>
@costdev
Fix: Add missing text domain.
e5db8fc 
Signed-off-by: costdev <[email protected]>
@costdev
Workflow: Remove tests directory run since this is already scanned.
104dd6c 
Signed-off-by: costdev <[email protected]>
@costdev
Track placeholders for empty directories that are required.
d061979 
Signed-off-by: costdev <[email protected]>
@costdev
Set the minimum WP version and text domain globally instead.
34f3af3 
Signed-off-by: costdev <[email protected]>
@costdev
Actually add the .cache directory to .gitignore.
76da944 
Signed-off-by: costdev <[email protected]>
@costdev @afragen
Fix typo in docblock.
49a13f2 
Co-authored-by: Andy Fragen <[email protected]>
Signed-off-by: Colin Stewart <[email protected]>
@costdev
Try just using @v4 for the checkout action.
af859ca 
Signed-off-by: Colin Stewart <[email protected]>
@costdev
Try removing caching and related steps.
039a690 
Signed-off-by: costdev <[email protected]>
@costdev costdev force-pushed the coding_standards branch from 94b0eae to 039a690 Compare June 26, 2025 16:58
@costdev costdev merged commit 0dc693b into main Jun 26, 2025
46 checks passed
@costdev costdev deleted the coding_standards branch June 26, 2025 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@afragen afragen afragen approved these changes

@rmccue rmccue Awaiting requested review from rmccue

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Coding Standards

3 participants

@costdev @afragen