Automattic / Automattic/VIP-Coding-Standards

Check files in the vip-config/ directory for WordPress functions

Abierto
#467 2 comentarios 2 reacciones 0 asignados Ver en GitHub
Standard: VIP-Go Type: Enhancement
Lenguaje dominante
PHP
Estrellas
261
Forks
44
Merge medio
19 min
PR fusionados (30 d)
1

Descripción

## What problem would the enhancement address for VIP?

The VIP app repo has a [`vip-config/` directory](https://github.com/Automattic/vip-go-skeleton/tree/master/vip-config) which contains files that run before WordPress is loaded. Usually there's just a `vip-config/vip-config.php` file, but clients can create other files in this directory and include/require them from the default file.

Since WordPress is not loaded when these files are read, WordPress-defined functions are not available, but this can be easy to forget. Using a WP function when not defined, gives a fatal error which can take down a site.

## Describe the solution you'd like

A new sniff that can be applied to files in the `vip-config/` directory, and look for any functions that are not defined yet. We can use [`get_defined_functions()` function](https://www.php.net/manual/en/function.get-defined-functions.php) to look for defined functions. The `internal` index key will verify against PHP native functions, but we also need to consider functions that may be defined within the files of `vip-config/` itself. It may also depend on if a function call is done before or after the definition in the same file. There may be some false positives cases, but these are more likely to be edge cases vs capturing functions only defined in WordPress.

Early in the `process()`, use `$phpcs->getFilename()` which can give the complete file path, to abort the sniff early if not correct. The sniff should have a public property with the default pattern of files which should be scanned.

## What code should be reported as a violation?

```php
// In vip-config/vip-config.php:
home_url();
wp_redirect( ... );
// etc.
```

## What code should *not* be reported as a violation?

```php
// In vip-config/vip-config.php:
function foo() {
return 'foo';
}
foo();

bar();
function bar() {
return 'bar';
}
```

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Start with the new sniff's process() and use $phpcs->getFilename() to confirm the public file pattern matches vip-config/vip-config.php; review get_defined_functions() and function definitions and calls in that file. Done means calls such as home_url() and wp_redirect() are reported, while functions defined in the same file, such as foo() and bar(), are not.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
php, wordpress
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.