Update code to comply with WP Coding Standards (rebased) #32

Rumperuu · 2021-02-21T18:48:34Z

Updates the codebase to ensure compliance with the WP Coding Standards.

Also Composerises the project to allow for the installation of a pre-commit PHP_CodeSniffer hook (and other hooks later on).

Note 1: because pretty much every line of every file is being changed (even if just to change indentation format), the diff tool is not particularly useful on this PR.

Note 2: This branch's commit history will be squashed on merge, so do not make any commits to this branch that you're going to want to remain in the project history. Keep it scoped to WP Coding Standards compliance only.

This is a duplicate of #23, except rebased to separate commit 3a44a19 into two different commits (27abf83 and b349544), ensuring the files in class/dashboard/* are properly tracked as having been renamed to class/layout/*, rather than just deleted.

Replace #23

Close #8
Close #10
Close #11

…7882f5101c1ed008cd9d)

… time)

…pt in footer

… parameter comments, etc.

Reordered entries in Contributors field of readme.txt in sync with project. Correct my typo: missing comma.

Change misleading variable names C_BOOL_… to C_STR_… — The type in the variable name was useful to show the intention.

Deferring jQuery Tools to the footer breaks jQuery tooltip display. Fix docblock. (Trailing comma after last argument can stay.)

class/init.php

Rumperuu · 2021-02-23T11:27:09Z

class/init.php

 			 */
 			wp_enqueue_script(
 				'mci-footnotes-jquery-tools',
 				plugins_url( 'footnotes/js/jquery.tools.min.js' ),
 				array(),
-				'1.2.7.redacted.2'
+				'1.2.7.redacted.2',
+				true


This should be false, fixed by @pewgeuges in 9226a40

These are class variables because they’re used both in search() and in reference_container(), hence the TODO item has been replaced with an explanatory comment. The deleted attribution is now restored. The version number for the variables is corrected (2.3.0, not 2.0.0). Docblock heading corrected to “The slug and identifier separator.”

Same issues as in e3c865b

markcheret

This is only a test comment. Thanks for your work

markcheret · 2021-02-23T13:20:52Z

This is only a test comment. Thanks for your work

another test

class/init.php

class/task.php

Rumperuu · 2021-02-23T15:44:35Z

This GitHub thing is totally unusable on this branch. The plethora of mostly duplicated commits due to bugs on the platform is hard to review in detail, while the changed files view is worthless. It just shows all files with changes in them, and is unable to detect the many identical strings. @Rumperuu did not move blocks of code, so the useless diff view is the sole responsibility of the platform. Note that all space indentation was already converted back to tabs! So the code is fully diffable, but the platform is failing.

As we must track deleted docblocks and disruptive changes to the code, I cannot approve until I’ve diffed all changed files locally in VSCode.

That will take some time, and over this we should add all the missing docblocks as well, since we’re on it and so much is already fixed (or broken).

You're right, the indentation wasn't the issue — it was the newlines. The files in main don't have any (the ^M characters in this git diff output):

rumperuu@ben-desktop:footnotes$ git diff -R main includes.php
diff --git b/includes.php a/includes.php
index 9501097..aa35d1c 100644
--- b/includes.php
+++ a/includes.php
@@ -1,39 +1,37 @@
-<?php
-/**
- * Includes all common files.
- *
[shortened]
+<?php^M
+/**^M
+ * Includes all common files.^M
+ *^M

I assume this comes from copy-pasting code into the Web tool — I didn't notice it until now because all my earlier PRs (e.g., adding the README were a) operating on entirely new files and b) done through the GitHub Web tool.

Solution: I'll checkout main, renormalise all of the files so that every line has a line ending char and then make a separate PR (that will only add line endings). Once that's merged with main, the diff tool will no longer pick up on the differences in line endings!

markcheret · 2021-02-23T16:05:34Z

Do you need to rebase again?

Rumperuu · 2021-02-23T16:13:37Z

Do you need to rebase again?

It's working locally now:

rumperuu@ben-desktop:footnotes$ git diff main includes.php
diff --git a/includes.php b/includes.php
index 732cfb9..9501097 100644
--- a/includes.php
+++ b/includes.php
@@ -3,36 +3,37 @@
  * Includes all common files.
  *
  * @filesource
- * @author Stefan Herndler
+ * @package footnotes
  * @since 1.5.0 14.09.14 13:40

I think the GitHub one might have some caching so it might take a while to update.

I have only been dealing with PHP files in this branch so far, so the non-PHP files still lack line endings. This commit adds line endings to only those files, which should ensure that they are in line with the files on `main` and do not appear in this PR's diff view.

Rumperuu · 2021-02-23T16:56:27Z

Do you need to rebase again?

It's working locally now:

rumperuu@ben-desktop:footnotes$ git diff main includes.php
diff --git a/includes.php b/includes.php
index 732cfb9..9501097 100644
--- a/includes.php
+++ b/includes.php
@@ -3,36 +3,37 @@
  * Includes all common files.
  *
  * @filesource
- * @author Stefan Herndler
+ * @package footnotes
  * @since 1.5.0 14.09.14 13:40

I think the GitHub one might have some caching so it might take a while to update.

Not a caching issue; I think it's still diffing this branch with the version of main that it was branched from rather than the current version (with the line endings), so rather than mess around trying to rebase again I've just recreated the branch and created a new PR at #38

Closing this PR

Rumperuu and others added 30 commits February 20, 2021 20:00

Autofix 2845 errors with PHPCBF

2b6d7bf

Set up PHPCS pre-commit hook

bcf2e03

Add vendor/ to gitignore

077ac22

Add pre-commit hook

81a4120

Ran [conversion script](https://gist.github.com/Rumperuu/51bccc659e1b…

bb3b555

…7882f5101c1ed008cd9d)

Add @Package PHPDoc tags, delete top-level @author PHPDoc tags

27abf83

Rename files and directory

b349544

Add *.bak to gitignore

2899e87

Convert all variables from camelCase to snake_case

1371c19

Replace args with string literal

663ff8e

Fix variable case in root files too

c2f0720

Replace discouraged function

df4c988

Replace $domain arg with string literal (missed these files the first…

eea9316

… time)

Strip \@author tags

d13245a

Automatically fix 227 errors

0933769

Convert varible cases, remove double-vspacing

7970edd

Use Yoda conditions (and strict comparisons), we must

70be320

Remove comments from method args list

cc92437

Replace comparison with strict comparison

c633013

Add parameter comments, replace deprecated function

742da45

Add docblock, safely escape output

63c9de0

Take function calls out of for loops

a205f63

Add class variable docblock, correct jQuery in comments, enqueue scri…

d3fec6b

…pt in footer

Escape output

c2e8c36

Remove debug comment

16a4eac

Add parameter comment, disable PHPCS warning

89c771c

Disable PHPCS error caused by JetBrains @nointrospection comment

e3568ba

Disable PHPCS errors about filename format

3dc2752

Fix 'j_query' typos

da9cc32

Replace deprecated functions, escape output, add Yoda conditions, add…

b063a09

… parameter comments, etc.

pewgeuges added 6 commits February 23, 2021 05:47

Reordered entries in Contributors field

252fc19

Reordered entries in Contributors field of readme.txt in sync with project. Correct my typo: missing comma.

Change variables in class/init.php

99ac3f8

Change misleading variable names C_BOOL_… to C_STR_… — The type in the variable name was useful to show the intention.

Change variables in class/layout/settings.php

fa80832

Change misleading variable names C_BOOL_… to C_STR_… — The type in the variable name was useful to show the intention.

Change variables in class/settings.php

ba73b02

Change misleading variable names C_BOOL_… to C_STR_… — The type in the variable name was useful to show the intention.

Change variables in class/task.php

81ab726

Change misleading variable names C_BOOL_… to C_STR_… — The type in the variable name was useful to show the intention.

Disable jQuery Tools deferral in class/init.php

9226a40

Deferring jQuery Tools to the footer breaks jQuery tooltip display. Fix docblock. (Trailing comma after last argument can stay.)

Rumperuu commented Feb 23, 2021

View reviewed changes

class/init.php Outdated Show resolved Hide resolved

Rumperuu commented Feb 23, 2021

View reviewed changes

Rumperuu mentioned this pull request Feb 23, 2021

Replace custom type conversion functions with PHP cast operations #36

Open

pewgeuges added 3 commits February 23, 2021 13:07

Restore and fix docblocks class/task.php

e900db8

Same issues as in e3c865b

Restore and fix docblocks class/task.php

79800ac

Same issues as in e3c865b

markcheret self-requested a review February 23, 2021 13:14

markcheret approved these changes Feb 23, 2021

View reviewed changes

pewgeuges suggested changes Feb 23, 2021

View reviewed changes

class/init.php Outdated Show resolved Hide resolved

class/task.php Show resolved Hide resolved

Rumperuu mentioned this pull request Feb 23, 2021

Append line endings #37

Merged

Rumperuu mentioned this pull request Feb 23, 2021

Update code to comply with WP Coding Standards (third time's the charm!) #38

Merged

Rumperuu closed this Feb 23, 2021

Rumperuu deleted the wp-coding-standard--rebased branch February 23, 2021 16:56

pewgeuges added the wpcs-compliance WordPress Coding Standards conformance label Mar 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update code to comply with WP Coding Standards (rebased) #32

Update code to comply with WP Coding Standards (rebased) #32

Rumperuu commented Feb 21, 2021 •

edited

Loading

Rumperuu Feb 23, 2021

markcheret left a comment

markcheret commented Feb 23, 2021

Rumperuu commented Feb 23, 2021 •

edited

Loading

markcheret commented Feb 23, 2021

Rumperuu commented Feb 23, 2021

Rumperuu commented Feb 23, 2021

Update code to comply with WP Coding Standards (rebased) #32

Update code to comply with WP Coding Standards (rebased) #32

Conversation

Rumperuu commented Feb 21, 2021 • edited Loading

Rumperuu Feb 23, 2021

Choose a reason for hiding this comment

markcheret left a comment

Choose a reason for hiding this comment

markcheret commented Feb 23, 2021

Rumperuu commented Feb 23, 2021 • edited Loading

markcheret commented Feb 23, 2021

Rumperuu commented Feb 23, 2021

Rumperuu commented Feb 23, 2021

Rumperuu commented Feb 21, 2021 •

edited

Loading

Rumperuu commented Feb 23, 2021 •

edited

Loading