🍾 Next release planning [0.2.0]

[dingo-d]

Now that the 0.1.0 is out 🎉 I think that we should try to keep the momentum and make some kind of planning as to what can be done for the next release 🙂

We can have a hangouts meeting, but we can also leave comments here about it.

I was thinking that we should go through the issues, see what can be closed, and maybe see which sniff proposals would be good to tackle (maybe some easy ones).

Even setting up a release timeline wouldn't be a bad idea, maybe set a milestone (or even several of them) and go through the issues and tag them according to each milestone. This will give us some sense of completion for each release.

I'd also like for theme review admins to join so that we can update the theme review handbook, to closely follow the standards (for less confusion), but also because it could do with some updates in the general sense 🙂

And last but not the least, we need to find a way to reach out to find more contributors. This part is the trickiest, but people need to know that contributing is not only writing sniffs but also writing good/bad code examples.

I'd like to hear your thoughts about this.

@jrfnl @grappler @ernilambar @jocastaneda @carolinan @justintadlock @pattonwebz

[joyously]

Does that include making it so anyone can run it? My eyes glaze over if I have to install 3 tools to use this tool.

[dingo-d]

It's actually super easy to run it in a project, you can check the twentynineteen and wprig PR, it's a matter of adding it to composer and running the composer script. Couldn't be easier 😄

[joyously]

Couldn't be easier

Well, yes it's easier if I don't have to figure out Composer and its script. I like the WP plugin route.

[dingo-d]

Well, yes it's easier if I don't have to figure out Composer and its script. I like the WP plugin route.

This is where theme-sniffer comes into play, but that's not related to this repo 😉

[jocastaneda]

Just now seeing this. Will take a look over in the next couple of days

[dingo-d]

Just a self reminder: Downgrade the prefix sniff to a warning instead of error in the next release, and possibly release the 0.2.0 (or 0.1.1) this week so that it can be used in the next release of the Theme Sniffer plugin

[jrfnl]

Downgrade the prefix sniff to a warning instead of error in the next release,

I would strongly recommend against that. If anything, you may just want to downgrade the specific message about non-prefixed variables which is causing all the strive, definitely not the whole sniff.

possibly release the 0.2.0 (or 0.1.1) this week so that it can be used in the next release of the Theme Sniffer plugin

I'd suggest holding off for a week or so, WPCS 2.1.0 is expected to be released soon and it might be a good idea to update before releasing a new Theme Sniffer version.

[dingo-d]

The progress of the 0.2.0 release is as follows:

Added

• Added modified PrefixAllGlobals sniff (PR Feature/prefix globals warning #208)
• Added xsd schema tag to the rulesets and added validation against it in CI checks

Changed

• Updated WPCS to 2.1.0 version (PR Composer: use WPCS ^2.1.0 #211)
• Updated TravisCI against different mixes of PHPCS and WPCS versions (PR Travis: test against high/low WPCS #210)
• Updated NoAddAdminPagesSniff (PR Update NoAddAdminPagesSniff.php #206)
• Updated ruleset grammar changes (PR fixing headers already sent message #204)
• Updated TravisCI builds against PHP 7.4 and workaround for PHPUnit 8 (PR Travis: test builds against PHP 7.4 & work around for PHPUnit 8 #198)
• Updated composer-installer package to 0.5.0 version (PR Bump suggested installer version #197)
• Updated readme (PR Minor readme changes #195)

Removed

• Removed autoload.php used in tests (PR Remove aliases reference from autoload #196)
• Remove sudo: false flag from travis.yml

To do (PRs pending review):

• Review URL shorteners sniff (PR Add sniff for URL shorteners used in a theme #216)
• Review adding additional functions to forbidden functions sniff (PR Add register block functions to forbidden functions sniff #215). Comment in issue Usage of CRON functions in theme #146; decision needed to include CRON functions in the list or to create a new sniff
• Review required template functions sniff (PR Feature/templates/required #214)
• Review reserved template name sniff (PR Add Reserved Template Name Sniff #213)
• Review deprecated parameter values rule in the ruleset (PR Add deprecated parameter values rule in the ruleset #217)
• Review post per page rule addition as a warning in the ruleset (PR Include post per page rule and make it into a warning #218)
• Review forbid setting INI configuration in themes (PR Add rule about setting INI during runtime in themes #219)
• Issue grooming
• Update WPCS version to 2.1.1 (PR pending)
• Add example phpcs.xml.distfile in the repo (PR pending)

I'll collect all the tickets for decision needed and propose that we go through them in a meeting to resolve them.

Issues that need discussion in the meeting before decision is made

• Add EnqueueudResourceParameter sniff (Add sniff: WordPress.WP.EnqueuedResourceParameters #170)
• Add additional rulesets (Proposal: additional rulesets #168)
• Discourage CSS rules for images setting width:auto ([New sniff] Discourage CSS rules for images setting width:auto #137)
• Metadata sniffs (Metadata sniffs #136)
• Disallow hiding or removing the themes section of the customizer (Dissallow hiding or removing the themes section of the customizer #127)
• Add malware/worm sniff ([New sniff] Malware/worm sniff #98)
• Add incorrect function parameter usage sniff ([New sniff] Incorrect function parameter usage #96)
• Check for direct load of searchform.php (Check for direct load of searchform.php #74)
• Check required headers in style.css (Check that all required headers in style.css are there. #50)
• Check that widget_title filter has all parameters ([New Sniff] Make sure widget_title filter has all parameters #42)
• Check text-domains usage ([Implement Sniff] Check that only one - or at most two - text-domains are used in the theme #35)
• Check that all strings are translated and in the same language (Check that all text strings are translated and in the same language #33)
• Add discouraged CDN usage sniff ([New sniff] Using a CDN is discouraged #20)
• Check for removal of admin pages ([New Sniff] Check for removal of admin pages #17)

[jrfnl]

One more TODO: I expect WPCS 2.1.1 to be released this week, so TRTCS may as well upgrade to using that (should be automatic as there is no composer.lock, but being explicit doesn't hurt).

[dingo-d]

All the changes will be in the changelog once the release is out, I'll close this issue and when the release is out and I sit down a bit I will open a new roadmap for the next release.