jakob/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remove util/typo

Browse source 
- Updated documentation
- Fixed typo in documenation
This commit is contained in:
Hypolite Petovan 2018-03-18 23:52:07 -04:00
parent 05b6cf7559
commit 4622f42b1d
5 changed files with 15 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG
View file

@ -485,7 +485,7 @@ Version 3.3.3 (2015-02-24)
Share-it button support (annando)
More reliable reshare from Diaspora (annando)
Load more images via proxy (annando)
util/typo.php uses "php -l" insead of "eval()" to validate code (fabrixxm)
typo console command uses "php -l" insead of "eval()" to validate code (fabrixxm)
Use $_SERVER array in cli script instead of $argv/$argc (issue #1218) (annando)
Updated vagrant setup script (silke)
API: support to star/unstar items (fabrixxm)

2
doc/Developer-How-To-Move-Classes-to-src.md
View file

@ -94,7 +94,7 @@ Please remove all the `require_once` mentions of the former file, as they will p
## Miscellaneous tips
When you are done with moving the class, please run `php util/typo.php` from the Friendica base directory to check for obvious mistakes.
When you are done with moving the class, please run `php bin/console typo` from the Friendica base directory to check for obvious mistakes.
Howevever, this tool isn't bullet-proof, and a staging install of Friendica is recommended to test your class move without impairing your production server if you host one.
Most of Friendica processes are run in the background, so make sure to turn on your debug log to check for errors that wouldn't show up while simply browsing Friendica.

4
doc/Github.md
View file

@ -68,7 +68,9 @@ If possible get an experienced Friendica developer to review the code.
Don't hesitate to ask us in case of doubt.
3. Check your code for typos.
There is a PHP script in the *util* directory called *typos.php* for this.
There is a console command called *typo* for this.
$> php bin/console typo
Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!

2
util/README
View file

@ -1,6 +1,6 @@
Utilities
typo.php - is a crude syntax checker to avoid checking in files with simple
php bin/console typo - is a crude syntax checker to avoid checking in files with simple
typos. It basically just loads each of our project files at once. Run from
cmdline and see if any parsing errors are reported.

78
util/typo.php
View file

@ -1,78 +0,0 @@
#!/usr/bin/env php
<?php
// Tired of chasing typos and finding them after a commit.
// Run this from cmdline in basedir and quickly see if we've
// got any parse errors in our application files.
use Friendica\App;
use Friendica\BaseObject;
error_reporting(E_ERROR | E_WARNING | E_PARSE);
ini_set('display_errors', '1');
ini_set('log_errors', '0');
include 'boot.php';
$a = new App(dirname(__DIR__));
BaseObject::setApp($a);
@include '.htconfig.php';
$phpath = $a->getConfigValue('config', 'php_path', 'php');
echo 'Directory: src' . PHP_EOL;
$Iterator = new RecursiveDirectoryIterator('src');
foreach (new RecursiveIteratorIterator($Iterator) as $file) {
if (substr($file, -4) === '.php') {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}
}
echo "Directory: mod\n";
$files = glob('mod/*.php');
foreach ($files as $file) {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}
echo "Directory: include\n";
$files = glob('include/*.php');
foreach ($files as $file) {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}
echo "Directory: object\n";
$files = glob('object/*.php');
foreach ($files as $file) {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}
echo "Directory: addon\n";
$dirs = glob('addon/*');
foreach ($dirs as $dir) {
$addon = basename($dir);
$files = glob($dir . '/' . $addon . '.php');
foreach ($files as $file) {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}
}
echo "String files\n";
echo 'util/strings.php' . "\n";
passthru("$phpath -l util/strings.php", $ret);
$ret === 0 || die();
$files = glob('view/lang/*/strings.php');
foreach ($files as $file) {
passthru("$phpath -l $file", $ret);
$ret === 0 || die();
}