Merge pull request #2 from mysiki/feature/sort

Feature/sort

Author: mysiki

Diff for: .gitignore

@@ -0,0 +1,3 @@
+dist/*
+*.egg-info
+test/site/*

Diff for: CHANGELOG

@@ -0,0 +1,19 @@
+# CHANGELOG #
+
+## 1.1.0 ##
+
+- Add sort options
+- Fix potential bug
+
+## 1.0.0 ##
+
+- Init
+- Scan navigation for replace folder to all sub file
+- Recurcive scan into folder
+- Accept all classic mkdocs file type (direct reference, reference with title ...)
+- Convert sub folder to section
+- Options :
+    - flat : Disable sub folder as section
+    - file_name_as_title : Usine file name as title instead of let mkdocs detect H1 balise in file
+    - recurse : disabled nested search in folder
+    - file_pattern : Regex for select markdown file (default '.*\.md$')

Diff for: README.md

@@ -13,11 +13,14 @@ Features :
 - Accept all classic mkdocs file type (direct reference, reference with title ...)
 - Convert sub folder to section
 - Options :
-    - `flat` : Disable sub folder as section
-    - `file_name_as_title` : Usine file name as title instead of let mkdocs detect H1 balise in file
-    - `recurse` : disabled nested search in folder
+    - `flat` : Disable sub folder as section (default=True)
+    - `file_name_as_title` : Usine file name as title instead of let mkdocs detect H1 balise in file (default=False)
+    - `recurse` : disabled nested search in folder (default=True)
     - `file_pattern` : Regex for select markdown file (default `'.*\.md$'`)
-
+    - `sort_file` : Sort file (default=True)
+    - `sort_directory` : Sort directory (default=True)
+    - `reverse_sort_file` : Sort file in reverse order (default=False)
+    - `reverse_sort_directory` : Sort file in reverse order (default=False)
 If you need more features, look at [mkdocs-awesome-pages-plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin>) than seem to make many more think.
 
 ## Setup ##
@@ -210,6 +213,70 @@ Result :
         - dirNamedSub-page02: dirNamed/dirNamedSub/dirNamedSub-page02.md
 ```
 
+## Sort option ##
+
+> Options :
+>
+> - `sort_file` : Sort file (default=True)
+> - `sort_directory` : Sort directory (default=True)
+> - `reverse_sort_file` : Sort file in reverse order (default=False)
+> - `reverse_sort_directory` : Sort file in reverse order (default=False)
+
+```yaml
+plugins:
+  - search
+  - include_dir_to_nav:
+      sort_file: true
+      sort_directory: true
+ ```
+
+Result :
+
+```yaml
+- aafolder:
+  - fold_sort/aafolder/0page.md
+  - fold_sort/aafolder/Cpage.md
+  - fold_sort/aafolder/apage.md
+  - fold_sort/aafolder/bpage.md
+  - fold_sort/aafolder/page-with-header.md
+  - fold_sort/aafolder/page-with-no-header.md
+  - fold_sort/aafolder/zpage.md
+- ccfolder:
+  - fold_sort/ccfolder/apage.md
+  - fold_sort/ccfolder/zpage.md
+- zzfolder:
+  - fold_sort/zzfolder/apage.md
+  - fold_sort/zzfolder/zpage.md
+```
+
+```yaml
+plugins:
+  - search
+  - include_dir_to_nav:
+      sort_file: true
+      sort_directory: true
+      reverse_sort_directory: true
+ ```
+
+Result :
+
+```yaml
+- zzfolder:
+  - fold_sort/zzfolder/apage.md
+  - fold_sort/zzfolder/zpage.md
+- ccfolder:
+  - fold_sort/ccfolder/apage.md
+  - fold_sort/ccfolder/zpage.md
+- aafolder:
+  - fold_sort/aafolder/0page.md
+  - fold_sort/aafolder/Cpage.md
+  - fold_sort/aafolder/apage.md
+  - fold_sort/aafolder/bpage.md
+  - fold_sort/aafolder/page-with-header.md
+  - fold_sort/aafolder/page-with-no-header.md
+  - fold_sort/aafolder/zpage.md
+```
+
 More 'complexe' example in test folder.
 
 ## Contribution ##

Diff for: mkdocs_include_dir_to_nav/include_dir_to_nav.py

@@ -18,6 +18,10 @@ class IncludeDirToNav(BasePlugin):
         ("file_pattern", config_options.Type(str, default='.*\.md$')),
         ("file_name_as_title", config_options.Type(bool, default=True)),
         ("recurse", config_options.Type(bool, default=True)),
+        ("sort_file", config_options.Type(bool, default=True)),
+        ("sort_directory", config_options.Type(bool, default=True)),
+        ("reverse_sort_file", config_options.Type(bool, default=False)),
+        ("reverse_sort_directory", config_options.Type(bool, default=False)),
     )
 
     def on_files(self, files, config):
@@ -30,7 +34,10 @@ def on_files(self, files, config):
                 pattern=self.config['file_pattern'],
                 flat=self.config['flat'],
                 file_name_as_title=self.config['file_name_as_title'],
-                recurse=self.config['recurse']
+                reverse_sort_directory=self.config['reverse_sort_directory'],
+                reverse_sort_file=self.config['reverse_sort_file'],
+                sort_file=self.config['sort_file'],
+                sort_directory=self.config['sort_directory']
             )
             log.debug(f"IncludeDirToNav : ## Final NAV : \n{yaml.dump(config['nav'], indent=2)}##")
 
@@ -39,7 +46,7 @@ def on_files(self, files, config):
 #### If Yes, get direct files and direct directory, and insert it to nav
 #### If direct directory was finding, recall parse with current index, in order to subCheck needsted folder
 #### Take care of direct notation ( - myFolder ) and page title notation ( - my folder : myFolder)
-def parse(ori_nav,config, pattern: str = '.*\.md$', flat: bool = False, previous=None, file_name_as_title: bool=False, recurse: bool=True):
+def parse(ori_nav,config, pattern: str = '.*\.md$', flat: bool = False, previous=None, file_name_as_title: bool=False, recurse: bool=True, reverse_sort_file: bool=False, reverse_sort_directory: bool=False, sort_file: bool=True, sort_directory: bool=True):
     log.debug("IncludeDirToNav : ##START Parse state###")
     log.debug(f"IncludeDirToNav : ori_nav = {ori_nav} | previous = {previous} | type of ori_nav {type(ori_nav)}")
 
@@ -62,14 +69,18 @@ def parse(ori_nav,config, pattern: str = '.*\.md$', flat: bool = False, previous
                             flat=flat,
                             previous=item,
                             file_name_as_title=file_name_as_title,
-                            recurse=recurse
+                            recurse=recurse,
+                            reverse_sort_directory=reverse_sort_directory,
+                            reverse_sort_file=reverse_sort_file,
+                            sort_file=sort_file,
+                            sort_directory=sort_directory
                         )
 
                     ## Else, item is simple dict, aka, value is string
                     else:
                         current_item = os.path.join(config["docs_dir"], item[k])
                         log.debug(f"    IncludeDirToNav : check current item : {current_item}")
-                        to_add, directory_was_insered = _generate_nav(current_item, pattern, config, flat, file_name_as_title, recurse)
+                        to_add, directory_was_insered = _generate_nav(current_item, pattern, config, flat, file_name_as_title, recurse, reverse_sort_file, reverse_sort_directory, sort_file, sort_directory)
                         if to_add:
                             item.update({k: to_add})
                             if directory_was_insered:
@@ -80,46 +91,53 @@ def parse(ori_nav,config, pattern: str = '.*\.md$', flat: bool = False, previous
                                     flat=flat,
                                     previous=item,
                                     file_name_as_title=file_name_as_title,
-                                    recurse=recurse
+                                    recurse=recurse,
+                                    reverse_sort_directory=reverse_sort_directory,
+                                    reverse_sort_file=reverse_sort_file,
+                                    sort_file=sort_file,
+                                    sort_directory=sort_directory
                                 )
             ## Else if item is no named, value like { - 'pagePath' }
             elif isinstance(item, str):
                 log.debug(f"  IncludeDirToNav : Item in loop is string. Item = {item}")
                 current_item = os.path.join(config["docs_dir"], item)
-                to_add, directory_was_insered = _generate_nav(current_item, pattern, config, flat, file_name_as_title, recurse)
+                to_add, directory_was_insered = _generate_nav(current_item, pattern, config, flat, file_name_as_title, recurse, reverse_sort_file, reverse_sort_directory, sort_file, sort_directory)
                 if to_add:
-                    log.debug(f"    IncludeDirToNav : Add item to ori_nav[index]. ori_nav = {ori_nav} | index = {index} | item = {to_add}")
                     # Replace current index by object in order to avoir infinite loop
                     ori_nav[index] = to_add.pop(-1)
                     ## Now, index position is an object, so insert new value
                     for insert_index, insert in enumerate(to_add):
                         ori_nav.insert(index + insert_index, insert)
-
                     if directory_was_insered:
                         parse(
-                            ori_nav=ori_nav[index],
+                            # ori_nav=ori_nav[index],
+                            ori_nav=ori_nav,
                             config=config,
                             pattern=pattern,
                             flat=flat,
                             previous=ori_nav[index],
                             file_name_as_title=file_name_as_title,
-                            recurse=recurse
+                            recurse=recurse,
+                            reverse_sort_directory=reverse_sort_directory,
+                            reverse_sort_file=reverse_sort_file,
+                            sort_file=sort_file,
+                            sort_directory=sort_directory
                             )
 
-def _generate_nav(current_item: str, pattern: str, config, flat, file_name_as_title, recurse):
+def _generate_nav(current_item: str, pattern: str, config, flat, file_name_as_title, recurse, reverse_sort_file, reverse_sort_directory, sort_file, sort_directory):
     ## Init var
     directory_was_insered = False
     to_add = []
 
     ## Check if value is directory
     if os.path.isdir(current_item):
-        log.debug(f"IncludeDirToNav_generate_nav : Current item is dir")
+        log.debug(f"IncludeDirToNav_generate_nav : Current item is dir ({current_item})")
 
         ## Get all direct files and direct folder
         ## r=root, d=directories, f = files
         for r, d, f in os.walk(current_item):
             ## For each file, check if pattern is respected
-            for file in f:
+            for file in (sorted(f, reverse=reverse_sort_file) if sort_file else f):
                 if re.match(pattern, file):
                     ## Add it to temp var
                     rpath = os.path.relpath(os.path.os.path.join(r, file), config["docs_dir"] )
@@ -133,11 +151,12 @@ def _generate_nav(current_item: str, pattern: str, config, flat, file_name_as_ti
             ## Work because first walk loop return all direct file and direct directory
             if not flat and d and recurse:
                 directory_was_insered = True
-                for sd in d:
+                for sd in (sorted(d, reverse=reverse_sort_directory) if sort_directory else d):
                     rpath = os.path.relpath(os.path.os.path.join(r, sd), config["docs_dir"] )
                     to_add.append({sd : rpath })
+                    log.debug(f"IncludeDirToNav_generate_nav : adding dir (sd : {sd}, rpath: {rpath})")
                 break
             elif not recurse:
                 break
 
-    return to_add, directory_was_insered
+    return to_add, directory_was_insered

Diff for: test/docs/fold_sort/aafolder/0page.md

@@ -0,0 +1,3 @@
+# This is a header #
+
+bla bla 

Diff for: test/docs/fold_sort/aafolder/Cpage.md

@@ -0,0 +1 @@
+Nothing to see

Diff for: test/docs/fold_sort/aafolder/apage.md

@@ -9,23 +9,24 @@ plugins:
   - search:
   - include_dir_to_nav:
       # flat: false
-      # file_name_as_title: false
+      file_name_as_title: true
       # recurse: true
       # file_pattern: '.*\.md$'
+      sort_file: true
+      sort_directory: true
+      reverse_sort_directory: true
 docs_dir: './docs'
 
-nav:
-  - Home: README.md
-  - dirDirectRef
-  - SubDirDirectRef/SubDirDirectRefSub
-  - emptyDir
-  - dirNamed: dirNamed
-  - SubDirNamed: SubDirNamed/SubDirNamedSub
-  - dirDirectRefUnderMenu:
-    - dirDirectRefUnderMenu
-    - dirNamedUnderMenu: dirNamedUnderMenu
-
 # nav:
 #   - Home: README.md
 #   - dirDirectRef
+#   - SubDirDirectRef/SubDirDirectRefSub
+#   - emptyDir
 #   - dirNamed: dirNamed
+#   - SubDirNamed: SubDirNamed/SubDirNamedSub
+#   - dirDirectRefUnderMenu:
+#     - dirDirectRefUnderMenu
+#     - dirNamedUnderMenu: dirNamedUnderMenu
+
+nav:
+  - fold_sort