Docs updated, tests rewritten

Author: Bob-chemist

Diff for: README.md

@@ -1260,7 +1260,7 @@ Compare for array.sort with priority
 _Example:_
 
 ```js
-files.sort(common.sortComparePriority);
+files.sort(common.sortComparePriority(priority));
 ```
 
 ### sortCompareDirectories(a, b)

Diff for: lib/sort.js

@@ -6,7 +6,7 @@
 //   s2 - <string>, to compare
 // Returns: <number>
 //
-// Example: files.sort(common.sortComparePriority)
+// Example: files.sort(common.sortComparePriority(priority))
 const sortComparePriority = priority => (s1, s2) => {
   let a = priority.indexOf(s1);
   let b = priority.indexOf(s2);

Diff for: test/sort.js

@@ -21,18 +21,24 @@ const CONFIG_FILES_PRIORITY = [
   'routes.js',
 ];
 
+const getTestSorting = config => (file1, file2, sortRes) => {
+  return [config, cb => cb(file1, file2) === sortRes];
+};
+const testSorting = getTestSorting(CONFIG_FILES_PRIORITY);
+
 metatests.case(
   'Common / sort',
   { common },
   {
     'common.sortComparePriority': [
-      [CONFIG_FILES_PRIORITY, res => res('files.js', 'sandbox.js') === 1],
-      [CONFIG_FILES_PRIORITY, res => res('filestorage.js', 'routes.js') === -1],
-      [CONFIG_FILES_PRIORITY, res => res('unknown.js', 'sandbox.js') === 1],
-      [CONFIG_FILES_PRIORITY, res => res('log.js', 'sandbox.js') === 1],
-      [CONFIG_FILES_PRIORITY, res => res('sandbox.js', 'sandbox.js') === 0],
-      [CONFIG_FILES_PRIORITY, res => res('log.js', 'log.js') === 0],
-      [CONFIG_FILES_PRIORITY, res => res('tasks.js', 'application.js') === -1],
+      testSorting('files.js', 'sandbox.js', 1),
+      testSorting('filestorage.js', 'routes.js', -1),
+      testSorting('unknown.js', 'sandbox.js', 1),
+      testSorting('log.js', 'sandbox.js', 1),
+      testSorting('sandbox.js', 'sandbox.js', 0),
+      testSorting('log.js', 'log.js', 0),
+      testSorting('tasks.js', 'application.js', -1),
+      testSorting('files.js', 'sandbox.js', 1),
     ],
     'common.sortCompareDirectories': [
       [{ name: '/abc' }, { name: 'abc.ext' }, -1],