#8 Отказ от рерайтов в пользу определения порядка внутри самого md фа…

…йла документации
autumn-library · Oct 30, 2024 · c67bd76 · c67bd76
1 parent ae13868
commit c67bd76
Show file tree

Hide file tree

Showing 26 changed files with 44 additions and 9 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -32,10 +32,6 @@ export default defineConfig({
   // https://vitepress.dev/reference/site-config#base
   base: "/docs",
 
-  rewrites(id) {
-    return id.replace(/\d+-/, '').replace(/\\/, '/')
-  },
-
   cleanUrls: true,
 
   locales: {
@@ -90,6 +86,11 @@ interface SidebarOptions {
   collapsed: boolean;
 }
 
+// type _SidebarItem = DefaultTheme.SidebarItem & { order: string }
+interface OrderedSidebarItem extends DefaultTheme.SidebarItem {
+  order: number;
+}
+
 function getSidebar({ contentRoot, contentDirs, collapsed }: SidebarOptions): DefaultTheme.SidebarItem[] {
   const sidebar: DefaultTheme.SidebarItem[] = [];
 
@@ -113,7 +114,7 @@ function getSidebarConfig(contentRoot, contentDir, text, collapsed): DefaultThem
 }
 
 function getSidebarItems(contentRoot, contentDir): DefaultTheme.SidebarItem[] {
-  const sidebarItems: DefaultTheme.SidebarItem[] = [];
+  const sidebarItems: OrderedSidebarItem[] = [];
   const cwd = `${process.cwd()}/${contentRoot}`;
   const files = glob.sync(`${contentDir}/*.md`, { cwd }).sort();
 
@@ -123,11 +124,20 @@ function getSidebarItems(contentRoot, contentDir): DefaultTheme.SidebarItem[] {
     sidebarItems.push(sidebarItem);
   }
 
+  sidebarItems.sort((first, second) => {
+    if (first.order >= second.order) {
+      return 1;
+    } else if (second.order >= first.order) {
+      return -1;
+    } else {
+      return 0;
+    }
+  })
 
   return sidebarItems;
 }
 
-function getSidebarItem(contentRoot, file): DefaultTheme.SidebarItem {
+function getSidebarItem(contentRoot, file): OrderedSidebarItem {
   const fileName = path.basename(file, '.md');
   const pageName = fileName
     .replace(/^\d+-/, '')
@@ -138,10 +148,10 @@ function getSidebarItem(contentRoot, file): DefaultTheme.SidebarItem {
   const fileContent = fs.readFileSync(path.join(contentRoot, file), 'utf8');
   const { data: frontmatter } = matter(fileContent);
 
-  const sidebarItem: DefaultTheme.SidebarItem = {
+  const sidebarItem: OrderedSidebarItem = {
     text: frontmatter.title || pageName,
-    link: "/" + file.replace(/\d+-/, '').replace(/\\/, '/'),
-    // order: frontmatter.order || 0
+    link: "/" + file.replace(/\\/, '/'),
+    order: frontmatter.order || Number.MAX_VALUE
   };
 
   return sidebarItem;

diff --git a/docs/framework-elements/additional-processing.md b/docs/framework-elements/additional-processing.md
@@ -1,5 +1,6 @@
 ---
 title: Дополнительная обработка компонента
+order: 150
 ---
 
 # Дополнительная обработка компонента

diff --git a/docs/framework-elements/aliases-grouping.md b/docs/framework-elements/aliases-grouping.md
@@ -1,5 +1,6 @@
 ---
 title: Группировка компонентов по алиасу
+order: 220
 ---
 
 # Группировка компонентов по алиасу

diff --git a/docs/framework-elements/aliases.md b/docs/framework-elements/aliases.md
@@ -1,5 +1,6 @@
 ---
 title: Алиасы компонентов
+order: 90
 ---
 
 # Алиасы компонентов

diff --git a/docs/framework-elements/annotation-inheritance.md b/docs/framework-elements/annotation-inheritance.md
@@ -1,5 +1,6 @@
 ---
 title: Наследование аннотаций
+order: 200
 ---
 
 # Наследование аннотаций

diff --git a/docs/framework-elements/annotations-processing.md b/docs/framework-elements/annotations-processing.md
@@ -1,5 +1,6 @@
 ---
 title: Обработка аннотаций
+order: 210
 ---
 
 # Обработка аннотаций

diff --git a/docs/framework-elements/app-context.md b/docs/framework-elements/app-context.md
@@ -1,5 +1,6 @@
 ---
 title: Использование контекста приложения
+order: 160
 ---
 
 # Использование контекста приложения

diff --git a/docs/framework-elements/app-settings-injection.md b/docs/framework-elements/app-settings-injection.md
@@ -1,5 +1,6 @@
 ---
 title: Внедрение настроек приложения
+order: 60
 ---
 
 # Внедрение настроек приложения

diff --git a/docs/framework-elements/component-declaration.md b/docs/framework-elements/component-declaration.md
@@ -1,5 +1,6 @@
 ---
 title: Объявление компонента
+order: 10
 ---
 
 # Объявление компонента

diff --git a/docs/framework-elements/component-instance.md b/docs/framework-elements/component-instance.md
@@ -1,5 +1,6 @@
 ---
 title: Получение экземпляра компонента
+order: 20
 ---
 
 # Получение экземпляра компонента

diff --git a/docs/framework-elements/component-overriding.md b/docs/framework-elements/component-overriding.md
@@ -1,5 +1,6 @@
 ---
 title: Переопределение компонента по имени
+order: 120
 ---
 
 # Переопределение компонента по имени

diff --git a/docs/framework-elements/component-post-initialization.md b/docs/framework-elements/component-post-initialization.md
@@ -1,5 +1,6 @@
 ---
 title: Пост-инициализация компонента
+order: 130
 ---
 
 # Пост-инициализация компонента

diff --git a/docs/framework-elements/component-uniqueness.md b/docs/framework-elements/component-uniqueness.md
@@ -1,5 +1,6 @@
 ---
 title: Уникальность экземпляров компонентов
+order: 140
 ---
 
 # Уникальность экземпляров компонентов

diff --git a/docs/framework-elements/components-binding.md b/docs/framework-elements/components-binding.md
@@ -1,5 +1,6 @@
 ---
 title: Связывание компонентов между собой
+order: 30
 ---
 
 # Связывание компонентов между собой

diff --git a/docs/framework-elements/components-factory.md b/docs/framework-elements/components-factory.md
@@ -1,5 +1,6 @@
 ---
 title: Фабрика компонентов
+order: 40
 ---
 
 # Фабрика компонентов

diff --git a/docs/framework-elements/components-prioritization.md b/docs/framework-elements/components-prioritization.md
@@ -1,5 +1,6 @@
 ---
 title: Приоритизация компонентов с общим алиасом
+order: 110
 ---
 
 # Приоритизация компонентов с общим алиасом

diff --git a/docs/framework-elements/components-sorting.md b/docs/framework-elements/components-sorting.md
@@ -1,5 +1,6 @@
 ---
 title: Упорядочивание компонентов при получении в виде сортированных коллекций
+order: 100
 ---
 
 # Упорядочивание компонентов при получении в виде сортированных коллекций

diff --git a/docs/framework-elements/conditional-registration.md b/docs/framework-elements/conditional-registration.md
@@ -1,5 +1,6 @@
 ---
 title: Условная регистрация компонентов в контексте приложения
+order: 170
 ---
 
 # Условная регистрация компонентов в контексте приложения

diff --git a/docs/framework-elements/custom-annotations.md b/docs/framework-elements/custom-annotations.md
@@ -1,5 +1,6 @@
 ---
 title: Собственные аннотации
+order: 190
 ---
 
 # Собственные аннотации

diff --git a/docs/framework-elements/custom-arguments.md b/docs/framework-elements/custom-arguments.md
@@ -1,5 +1,6 @@
 ---
 title: Произвольные аргументы конструктора
+order: 80
 ---
 
 # Произвольные аргументы конструктора

diff --git a/docs/framework-elements/dependency-injection.md b/docs/framework-elements/dependency-injection.md
@@ -1,5 +1,6 @@
 ---
 title: Внедрение зависимостей в поля и функции-сеттеры
+order: 50
 ---
 
 # Внедрение зависимостей в поля и функции-сеттеры

diff --git a/docs/framework-elements/instance-generator.md b/docs/framework-elements/instance-generator.md
@@ -1,5 +1,6 @@
 ---
 title: Генератор экземпляров компонентов
+order: 70
 ---
 
 # Генератор экземпляров компонентов

diff --git a/docs/framework-elements/launch-control-inversion.md b/docs/framework-elements/launch-control-inversion.md
@@ -1,5 +1,6 @@
 ---
 title: Инверсия управления запуском приложения
+order: 180
 ---
 
 # Инверсия управления запуском приложения

diff --git a/docs/getting-started/10-about-autumn.md → docs/getting-started/about-autumn.md b/docs/getting-started/10-about-autumn.md → docs/getting-started/about-autumn.md
@@ -1,5 +1,6 @@
 ---
 title: Что такое Autumn?
+order: 10
 ---
 
 ![autumn](../static/cover.png)

diff --git a/...getting-started/30-additional-packages.md → docs/getting-started/additional-packages.md b/...getting-started/30-additional-packages.md → docs/getting-started/additional-packages.md
@@ -1,5 +1,6 @@
 ---
 title: Дополнительные пакеты Autumn
+order: 30
 ---
 
 # Модули и пакеты

diff --git a/docs/getting-started/20-first-steps.md → docs/getting-started/first-steps.md b/docs/getting-started/20-first-steps.md → docs/getting-started/first-steps.md
@@ -1,5 +1,6 @@
 ---
 title: Первое приложение
+order: 20
 ---
 
 <!-- TODO: Тут должен быть какой-то заголовок с #, иначе рендерится некрасиво -->