Merge pull request maddevsio#15 from maddevsio/MAR-3010

MAR-3010. Added a parameter sitemapUrl to inputSpaFolder and inputNext
GuideToIceland · Jun 21, 2022 · 16a7c95 · 16a7c95
2 parents 8a73b8c + 8105acc
commit 16a7c95
Show file tree

Hide file tree

Showing 10 changed files with 550 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ const SeoAnalyzer = require('seo-analyzer');
 
 new SeoAnalyzer()
   .ignoreUrls(['/404', '/login'])
-  .inputSpaFolder('/dist', 3000)
+  .inputSpaFolder('/dist', 'sitemapindex.xml', 3000)
   .addRule('imgTagWithAltAttributeRule')
   .outputConsole();
 ```
@@ -134,7 +134,7 @@ new SeoAnalyzer()
 | ignoreUrls     | ['/404']             | This method expects an array of urls to ignore before analysis.                                         |
 | inputFiles     | ['dist/index.html']  | This method expects an array of html files.                                                             |
 | inputFolders   | ['dist', 'src']      | This method expects an array of folders with html files.                                                |
-| inputSpaFolder | '/dist', 3000        | This method expects an string of folder with SPA builded files to production & port for run server.     |
+| inputSpaFolder | '/dist', 'sitemap.xml', 3000        | This method expects an string of folder with SPA builded files to production & port for run server.     |
 | inputNextJs    | 3000                 | This method expects a port for run next.js server.                                                              |
 | addRule        | function(dom) {}     | This method adds a custom rule to check incoming HTML files.                                            |
 | outputObject   | function(obj) {}     | This method will return the report as a javascript object.                                              |

diff --git a/README_RU.md b/README_RU.md
@@ -62,7 +62,7 @@ const SeoAnalyzer = require('seo-analyzer');
 
 new SeoAnalyzer()
   .ignoreUrls(['/404', '/login'])
-  .inputSpaFolder('/dist', 3000)
+  .inputSpaFolder('/dist', 'sitemap.xml', 3000)
   .addRule('imgTagWithAltAttributeRule')
   .outputConsole();
 ```
@@ -119,7 +119,7 @@ new SeoAnalyzer()
 const SeoAnalyzer = require('seo-analyzer');
 
 new SeoAnalyzer()
-  .inputNextJs(3000)
+  .inputNextJs('sitemap-index.xml', 3000)
   .addRule('imgTagWithAltAttributeRule')
   .outputConsole();
 ```
@@ -133,8 +133,8 @@ new SeoAnalyzer()
 | ignoreUrls     | ['/404']             | Массив URL-адресов, которые будут проигнорированны во время анализа. |
 | inputFiles     | ['dist/index.html']  | Массив файлов, которые нужно анализировать. |
 | inputFolders   | ['dist', 'src']      | Массив папкок с файлами, которые нужно анализировать. |
-| inputSpaFolder | '/dist', 3000        | Метод для запуска анализаторв для SPA приложений. Ожидает папку с финальными кодом приложения и порт на котором запустится анализатор. |
-| inputNextJs    | 3000                 | Метод для запуска анализаторв для Next.js SSR приложений. Ожидает порт для запуска Next.js сервера.                                                       |
+| inputSpaFolder | '/dist', 'sitemap.xml', 3000        | Метод для запуска анализаторв для SPA приложений. Ожидает папку с финальными кодом приложения и порт на котором запустится анализатор. |
+| inputNextJs    | 'sitemap.xml', 3000                 | Метод для запуска анализаторв для Next.js SSR приложений. Ожидает порт для запуска Next.js сервера.                                                       |
 | addRule        | function(dom) {}     | Метод для добавления встроенных правил или собственных. |
 | outputObject   | function(obj) {}     | Метод для вывода результата. Вернёт js объект. |
 | outputJson     | function(json) {}    | Метод для вывода результата. Вернёт JSON. |

diff --git a/example/index.js b/example/index.js
@@ -21,7 +21,7 @@ new SeoAnalyzer()
   // ------- Input methods -------- //
   .inputFolders(['example'])
   // .inputFiles(['example/html/index.html'])
-  // .inputSpaFolder('example/spa')
+  // .inputSpaFolder('example/spa', 'sitemap.xml')
   // .inputNextJs()
 
   // ------ Default rules -------- //