conform our existing code to our standards

[rgilman]

We should at least do this for the files we have created or modified.

I did a comparison between BFCom and JointsWP. The issues I found are:

• parts/nav-bftop.php and parts/nav-bfsubmenu.php – the 'nav- ...' structure meshes with get_template_part() which is a WP function so we need to stay with that structure. We could rename the files nav-bfc_top.php and nav-bfc_submenu.php. I'm using underscores so the part after nav- gets treated as a block. The code in the files should also be conformed with our standards.
• header.php contains a 'get_template_part' reference to ('parts/nav', 'bftop') that would need to be updated to match the new file name.
• /assets/styles/style.css – any new code in here should be checked for coding standards.
• /functions/bfcom-fn.php – this should likely be changed to bfc-functions.php
• /functions.php contains a reference to bfcom-fn.php that would need to be updated.

I'm willing to do this clean-up.

[iangilman]

Sounds good.

[rgilman]

I've done all the file renaming and tested it to make sure it works. I'm going to hold off on the linting until I have better tools in place.

[iangilman]

I recommend ESLint for JavaScript... I don't know what the PHP equivalent is.

[rgilman]

Looks like PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions is what people use. It integrates with VS Code and I suspect with Atom as well.

[rgilman]

Commits here and here

While this will be an on-going process, I'm closing this as an issue now.

[iangilman]

Now that I'm actually seeing it in the commit, nav-bfc_submenu.php seems odd to me (and it goes against the recommendation in the cheat sheet). Why not nav-bfc-submenu.php?

[iangilman]

Otherwise those changes look good.

[rgilman]

I agree it looks odd. I'll test nav-bfc-submenu.php locally. If there are no issues, I'd be happy to update.

[iangilman]

Cool :-)