From 4622f42b1d84b1bd626d2273253843eda03f6893 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 18 Mar 2018 23:52:07 -0400 Subject: [PATCH] Remove util/typo - Updated documentation - Fixed typo in documenation --- CHANGELOG | 20 +++--- doc/Developer-How-To-Move-Classes-to-src.md | 2 +- doc/Github.md | 4 +- util/README | 2 +- util/typo.php | 78 --------------------- 5 files changed, 15 insertions(+), 91 deletions(-) delete mode 100755 util/typo.php diff --git a/CHANGELOG b/CHANGELOG index 9ad913771..b3e3059ff 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -72,7 +72,7 @@ Version 3.5.3 (2017-10-05) Fixes to buffer, diaspora, libertree, pumpio, gnu social, tumblr, twitter and wppost bridges to redistribute remote_self content [annando] Fixed a bug in securemail settings form [FuzzJunket] external poller addons are deprecated, as this is now a core functionality [annando] - + Friendica Directory: Fix a problem with the Vagrant config [tobiasd] Fix not working node health page [Hypolite] @@ -82,7 +82,7 @@ Version 3.5.3 (2017-10-05) 1257, 2786, 2864, 2872, 2998, 3013, 3018, 3131, 3180, 3234, 3248, 3309, 3313, 3360, 3362, 3391, 3482, 3511, 3512, 3515, 3516, 3529, 3531, 3536, 3545, 3552, 3553, 3560, 3571, 3589, 3592, 3599, 3615, - 3616, 3621, 3624, 3636, 3645, 3661, 3684, 3685, 3691, 3696, 3699, + 3616, 3621, 3624, 3636, 3645, 3661, 3684, 3685, 3691, 3696, 3699, 3700, 3732 Version 3.5.2 (2017-06-06) @@ -199,8 +199,8 @@ Version 3.5.1 (2017-03-12) Twitter-bridge now supports quotes and long posts when importing tweets [annando] Closed Issues - 1019, 1163, 1612, 1613, 2103, 2177, 2252, 2260, 2403, 2991, 2614, - 2751, 2752, 2772, 2791, 2800, 2804, 2813, 2814, 2816, 2817, 2823, + 1019, 1163, 1612, 1613, 2103, 2177, 2252, 2260, 2403, 2991, 2614, + 2751, 2752, 2772, 2791, 2800, 2804, 2813, 2814, 2816, 2817, 2823, 2850, 2858, 2865, 2892, 2894, 2895, 2907, 2908, 2914, 2015, 2926, 2948, 2955, 2958, 2963, 2964, 2968, 2987, 2993, 3020, 3052, 3062, 3066, 3091, 3108, 3113, 3116, 3117, 3118, 3126, 3130, 3135, 3155, @@ -304,7 +304,7 @@ Version 3.4.3 (2015-12-22) Diaspora and OStatus can be enabled only if requirements are satisfied (annando) Support for additional passwords for ejabberd (annando) Use proxy for profile photos (annando) - 'Reload active themes' in theme admin page (fabrixxm) + 'Reload active themes' in theme admin page (fabrixxm) Install routine checks for ImageMagick and GIF support (fabrixxm) Install routine checks for availability of "mcrypt_create_iv()" function, needed for RINO2 (fabrixxm) Only suported themes are shown in admin page (annando) @@ -315,7 +315,7 @@ Version 3.4.3 (2015-12-22) Show an info message if an empty contact group is shown (issue #1871) (annando) User setting to disable network page autoupdate (issue #1921) (annando) Settings to limit or permit access to crawler to search page (annando) - What's new for developers: + What's new for developers: Themes can show Events entry in navbar (annando) Themes can now override colorbox (fabrixxm) Updated Vagrant development VM (silke, hauke) @@ -343,7 +343,7 @@ Version 3.4.3 (2015-12-22) Fix mention completition popup with TinyMCE (issue #1920) (fabrixxm) Fix photo cache and proxy when installed in subfolder (ddorian1) Fix bbcode conversion of the about text for the profile (issue #1607) (annando) - + Version 3.4.2 (2015-09-29) @@ -388,8 +388,8 @@ Version 3.4.2 (2015-09-29) Checks for mcrypt availability before enable or use RINO2 (fabrixm) Fix following email contacts (issue #1896) (annando) Parse BBCode in contact request notification email (annando) - - + + Version 3.4.1 (2015-07-06) Implement server-to-server encryption (RINO) using php-encryption library as "RINO 2", deprecate "RINO 1" (issue #1655) (fabrixxm) @@ -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) diff --git a/doc/Developer-How-To-Move-Classes-to-src.md b/doc/Developer-How-To-Move-Classes-to-src.md index 134c2a1f5..69e17e9c9 100644 --- a/doc/Developer-How-To-Move-Classes-to-src.md +++ b/doc/Developer-How-To-Move-Classes-to-src.md @@ -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. diff --git a/doc/Github.md b/doc/Github.md index a34855bf7..0145a85f8 100644 --- a/doc/Github.md +++ b/doc/Github.md @@ -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! diff --git a/util/README b/util/README index 0f0a169b3..33bfb9e11 100644 --- a/util/README +++ b/util/README @@ -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. diff --git a/util/typo.php b/util/typo.php deleted file mode 100755 index fba761e81..000000000 --- a/util/typo.php +++ /dev/null @@ -1,78 +0,0 @@ -#!/usr/bin/env php -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(); -}