Skip to content
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

Add PHP linter and PHP linting in GitHub Actions #109

Merged
merged 17 commits into from
Apr 19, 2024
Merged

Add PHP linter and PHP linting in GitHub Actions #109

merged 17 commits into from
Apr 19, 2024

Conversation

eason9487
Copy link
Member

@eason9487 eason9487 commented Apr 18, 2024 •
edited
Loading

Changes proposed in this Pull Request:

Implements parts of #4

  • Add PHP linter and PHP linting in GitHub Actions
  • Fix all linting errors.

Detailed test instructions:

  1. Run composer install
  2. Run npm run lint:php locally to test the linter
  3. View the failed run that was intentionally left with some linting errors
  4. View the error and warning annotations with this link
  5. View the successful run
  6. View automatically fixed errors with this diff
  7. View manually fixed errors with this diff

@eason9487
Add linter for PHP.
609203b
@eason9487
Resolve PHP linting errors can be fixed automatically by phpcbf.
4346284
@eason9487
Fix a PHP linting error for rule `Generic.CodeAnalysis.UnusedFunction…
01eb6c0 
…Parameter.Found`.
@eason9487
Fix PHP linting errors for rule `WordPress.DateTime.RestrictedFunctio…
45eb24c 
…ns.date_date`.
@eason9487
Fix PHP linting errors for rule `Squiz.Commenting.FunctionComment.Mis…
22e96d4 
…singParamTag`.
@eason9487
Fix PHP linting errors for rule `Squiz.Commenting.FunctionCommentThro…
3c10f7e 
…wTag.Missing`.
@eason9487
Fix a PHP linting error for rule `Squiz.Commenting.FunctionComment.Th…
0d8aa51 
…rowsNoFullStop`.
@eason9487
Fix PHP linting errors for rule `WordPress.NamingConventions.ValidVar…
d303789 
…iableName.VariableNotSnakeCase`.
@eason9487
Fix PHP linting errors for rule `WordPress.WP.AlternativeFunctions.fi…
fc678a1 
…le_get_contents_file_get_contents`.
@eason9487
Fix a PHP linting error for rule `WordPress.WP.AlternativeFunctions.f…
c97006b 
…ile_system_operations_fopen`.
@eason9487
Fix a PHP linting error for rule `Generic.CodeAnalysis.AssignmentInCo…
a291f29 
…ndition.FoundInWhileCondition`.
@eason9487
Fix a PHP linting error for rule `PSR12.Properties.ConstantVisibility…
01ef9a2 
….NotFound`.
@eason9487
Fix a PHP linting error for rule Squiz.Classes.ClassFileName.NoMatch.
03f873a
@eason9487
Fix PHP linting errors for rule Squiz.PHP.CommentedOutCode.Found.
5643ec9
@eason9487
Fix a PHP linting error for rule `Squiz.Commenting.FunctionComment.Pa…
f2fd792 
…ramNameNoMatch`.
@eason9487
Fix a PHP linting error for rule `WordPress.NamingConventions.ValidFu…
57bcac4 
…nctionName.FunctionNameInvalid`.
@eason9487 eason9487 self-assigned this Apr 18, 2024
@eason9487 eason9487 requested a review from a team April 18, 2024 10:33
@eason9487 eason9487 marked this pull request as ready for review April 18, 2024 10:34
ianlin
ianlin approved these changes Apr 19, 2024
View reviewed changes
Copy link
Member

@ianlin ianlin left a comment

Choose a reason for hiding this comment

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

Thanks for adding PHP linter here. Tested locally and everything worked as expected.

.github/workflows/php-coding-standards.yml
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
Copy link
Member

@ianlin ianlin Apr 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Just curious can we use checkout@v4 (using Node.js v20 runtime)?

Copy link
Member Author

Choose a reason for hiding this comment

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

Considering the current .nvmrc is still lts/fermium (v14), I plan to update it along with the work for #108.

@eason9487 eason9487 merged commit e89cb26 into trunk Apr 19, 2024
3 checks passed
@eason9487 eason9487 deleted the dev/4-phpcs branch April 19, 2024 08:15
@github-actions github-actions bot mentioned this pull request Apr 25, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ianlin ianlin ianlin approved these changes

Assignees

@eason9487 eason9487

Labels
[actions] changelog: tweak
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eason9487 @ianlin