@bbc/morty-docs 1.6.2 → 1.8.1

package/README.md

@@ -88,17 +88,12 @@ through because it is not markdown or asciidoc e.g. images
 
 ## Things to Consider
 
-### File Ordering
+### File & Directory Ordering
 
-File names are sorted lexically (0-9 < a-z>), meaning that files prefixed with dates will appear at the top of the list. 
+These are sorted lexically (0-9 < a-z>).
 
-If you want your documents to be sorted reverse chronologically, use the date as a prefix to the file name in the format of YYYY-MM-DD - (19-11-2019-some-document).
-
-## Releasing
-
-Releases are versioned through `npm version`, and publishing is handled by our [Travis CI Integration](./.travis.yml)
-
-`$ npm version (major|minor|patch)`
+There is an additional sort.
+If you want your documents to be sorted reverse chronologically, use the date as a prefix to the file name in the format YYYY-MM-DD e.g. `19-11-2019-some-document`. These will then be placed first above the regular sort.
 
 ## Example Architecture
 
@@ -134,6 +129,29 @@ We welcome contributions from everyone.
 
 Please respect each other.
 
+## How to contribute
+
+Steps:
+
+- fork the repo
+- implement your fix or feature - with test coverage :-)
+- raise a [PR](https://github.com/bbc/morty-docs/pulls)
+- this repo now uses github actions for automated Pull Request checking & Publishing
+  - n.b. first-time contributors require approval to run github actions
+  (so your PR checker should fail to run initially)
+- use ['Pull Request Checks' github action](https://github.com/bbc/morty-docs/actions/workflows/pull-requests.yml) to
+see if the PR checker is passing
+
+### Maintainers only
+
+- merge PR (or suggest changes)
+- after merge
+  - use `npm version (major|minor|patch)`
+  - the tag created above causes
+  ['Node.js Package' github action](https://github.com/bbc/morty-docs/actions/workflows/npm-publish.yml) to run.
+  Wait for this to complete.
+  - verify the new version on [NPM](https://www.npmjs.com/package/@bbc/morty-docs)
+
 ### Adding an issue
 
 If you spot an issue or just want to raise one please use the issue template.
@@ -171,4 +189,4 @@ We would expect code quality to be at least as good if not better than
 the code quality of the project at the time you make your contribution.
 After all, we all hope to leave things better than we find them!
 
-© BBC 2019
+© BBC 2021

package/build/generate-indexes.js

@@ -8,13 +8,13 @@ const filterFilesInDirectory = require('./helpers/filter-files-in-dir');
 
 const filterDirectoriesInDirectory = require('./helpers/filter-dirs-in-dir');
 
-const generateIndex = (directory, htmlFilePaths, subDirPaths, options) => {
+const generateIndex = (directory, filePaths, subDirPaths, options) => {
   const subDirLinks = subDirPaths.filter(dirPath => !dirPath.includes('/')).map(dirPath => ({
     link: `${dirPath}/index.html`,
     text: dirPath,
     iconClass: 'fas fa-folder-open'
   }));
-  const fileLinks = htmlFilePaths.map(filePath => {
+  const fileLinks = filePaths.map(filePath => {
     const text = path.basename(filePath);
     return {
       link: encodeURIComponent(text),
@@ -28,8 +28,8 @@ const generateIndex = (directory, htmlFilePaths, subDirPaths, options) => {
 const generateIndexes = (files, options = {
   contentTitle: ''
 }) => {
-  const htmlFilePaths = files.map(file => file.relativePath).filter(relativePath => path.extname(relativePath) === '.html');
-  const directories = getDirectories(htmlFilePaths); // If we have not got a 'root' folder, then add one.
+  const supportedFilePaths = files.map(file => file.relativePath).filter(relativePath => path.extname(relativePath) === '.html' || path.extname(relativePath) === '.pdf');
+  const directories = getDirectories(supportedFilePaths); // If we have not got a 'root' folder, then add one.
   // TODO: Refactor this so it is not needed (maybe?)
 
   if (!directories.includes('')) {
@@ -37,7 +37,7 @@ const generateIndexes = (files, options = {
   }
 
   const indexes = directories.map(directory => {
-    const filesInDir = filterFilesInDirectory(htmlFilePaths, directory);
+    const filesInDir = filterFilesInDirectory(supportedFilePaths, directory);
     const subDirsInDir = filterDirectoriesInDirectory(directories, directory);
     const indexPath = directory ? `${directory}/index.html` : 'index.html';
     return {

package/build/helpers/filter-dirs-in-dir.js

@@ -1,3 +1,7 @@
+const {
+  sortArrayByDate
+} = require('../../src/helpers/sort-array-by-date');
+
 const filterDirs = (directoryPaths, directory) => {
   const directoryArray = [];
   const nestedDirFolders = directoryPaths.filter(directoryPath => directoryPath.includes(directory) && !directoryPath.startsWith(directory) && directoryPath !== directory);
@@ -6,8 +10,15 @@ const filterDirs = (directoryPaths, directory) => {
   const rootDirFolders = directoryPaths.filter(directoryPath => directoryPath.startsWith(directory) && directoryPath !== directory);
   const rootDir = rootDirFolders.map(directoryPath => directoryPath.startsWith(`${directory}/`) && directory !== '' ? directoryPath.replace(`${directory}/`, '') : directoryPath);
   if (rootDir.length) directoryArray.push(rootDir); // if directory path starts with the config folder then remove the directory from the path
+  // sort array here
+
+  let sortedDirectoryArray = directoryArray;
+
+  if (sortedDirectoryArray.length) {
+    sortedDirectoryArray.map(arr => sortArrayByDate(arr));
+  }
 
-  return directoryArray.flat();
+  return sortedDirectoryArray.flat();
 };
 
 module.exports = filterDirs;

package/build/helpers/filter-files-in-dir.js

@@ -1,8 +1,6 @@
-const dateRegex = /\d{4}-\d{2}-\d{2}/; // i.e. 2019-10-29
-
-function sortByDate(a, b) {
-  return a.match(dateRegex) && b.match(dateRegex) ? b.localeCompare(a) : a.localeCompare(b);
-}
+const {
+  sortArrayByDate
+} = require('../../src/helpers/sort-array-by-date');
 
 const directoryDepth = path => path.split('/').length;
 
@@ -12,5 +10,5 @@ const isIn = directory => filePath => filePath.startsWith(directory) && director
 
 module.exports = (filePaths, directory) => {
   const isInSpecifiedDirectory = directory ? isIn(directory) : isInRootDirectory;
-  return filePaths.filter(isInSpecifiedDirectory).sort(sortByDate);
+  return sortArrayByDate(filePaths.filter(isInSpecifiedDirectory));
 };

package/build/helpers/sort-array-by-date.js

@@ -0,0 +1,13 @@
+const dateRegex = /\d{4}-\d{2}-\d{2}/; // i.e. 2019-10-29
+
+function sortByDate(a, b) {
+  return a.match(dateRegex) && b.match(dateRegex) ? b.localeCompare(a) : a.localeCompare(b);
+}
+
+const sortArrayByDate = arr => {
+  return arr.sort(sortByDate);
+};
+
+module.exports = {
+  sortArrayByDate
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bbc/morty-docs",
-  "version": "1.6.2",
+  "version": "1.8.1",
   "description": "To generate a static website from markdown documentation, to allow users to consume content in an easily accessible format",
   "main": "build/index.js",
   "publishConfig": {
@@ -16,7 +16,7 @@
     "coverage": "jest --coverage --runInBand && open coverage/lcov-report/index.html",
     "lint": "standard",
     "prepare": "npm run build",
-    "postversion": "git push origin master && git push --tags origin master"
+    "postversion": "git push origin main && git push --tags origin main"
   },
   "files": [
     "build/"