added flatten directory option

photodow · Apr 30, 2021 · 16e8198 · 16e8198
1 parent a6e6473
commit 16e8198
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 19 deletions.
diff --git a/.github/workflows/repo-to-wiki.yml b/.github/workflows/repo-to-wiki.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: photodow/wiki-helpers@v1.7
+      - uses: photodow/wiki-helpers@v1.8
         with:
           rootPath: "./samples"
       - name: Upload Documentation to Wiki

diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ You can find this script in the [GitHub Action Marketplace](https://github.com/m
 
 ```yml
 - name: Wiki Helpers
-  uses: photodow/wiki-helpers@v1.7
+  uses: photodow/wiki-helpers@v1.8
 ```
 
 <details>
@@ -103,7 +103,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           repository: ${{github.repository}}.wiki
-      - uses: photodow/wiki-helpers@v1.7
+      - uses: photodow/wiki-helpers@v1.8
         with:
           rootPath: ./
           buildPath: ./
@@ -131,9 +131,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: photodow/wiki-helpers@v1.7
+      - uses: photodow/wiki-helpers@v1.8
         with:
           rootPath: "./samples"
+          flattenDir: true
       - name: Upload Documentation to Wiki
         uses: SwiftDocOrg/github-wiki-publish-action@v1
         with:
@@ -159,6 +160,7 @@ npm run build [...optionName=optionValue]
 | `templatePath`  | `String`  | Path to your custom template for everything. |
 | `depsTitleHook` | `String`  | Title of your dependencies list. Defaults to `Dependencies`. Case sensitive. |
 | `buildPath`     | `String`  | `./build (default)` Indicate a directory you would like the updated files to build into. |
+| `flattenDir`     | `Boolean`  | `false (default)` By default it maintains folder structure. `true` flattens all the files into a flat structure within the `buildPath`. |
 
 ## Helpers
 

diff --git a/action.js b/action.js
@@ -8,7 +8,8 @@ try {
       resetOnly: core.getInput('resetOnly'),
       templatePath: core.getInput('templatePath'),
       depsTitleHook: core.getInput('depsTitleHook'),
-      buildPath: core.getInput('buildPath')
+      buildPath: core.getInput('buildPath'),
+      flattenDir: core.getInput('flattenDir')
   });
 } catch (error) {
   core.setFailed(error.message);

diff --git a/action.yml b/action.yml
@@ -11,6 +11,8 @@ inputs:
     description: 'Title of your dependencies list. Defaults to Dependencies. Case sensitive.'
   buildPath:  # id of input
     description: './build (default) Indicate a directory you would like the updated files to build into.'
+  flattenDir:  # id of input
+    description: 'false (default) By default it maintains folder structure. true flattens all the files into a flat structure within the buildPath.'
 branding:
   icon: 'book-open'  
   color: 'gray-dark'

diff --git a/dist/index.js b/dist/index.js
@@ -8,8 +8,7 @@ const fs = __nccwpck_require__(747);
 const Path = __nccwpck_require__(622);
 let globalOptions, builders, miners;
 
-// TODO: build action and publish
-// TODO: Publish action
+// TODO: global option booleans not exactly working
 // TODO: Publish npm
 // TODO: ignore list
 // TODO: custom miners, builders ... miners=./lib/mine.js builders=./lib/build.js done=./lib/done.js
@@ -48,7 +47,8 @@ function setGlobalOptions (config = {}) {
         resetOnly: arguments.resetOnly || false,
         templatePath: arguments.templatePath || undefined,
         depsTitleHook: arguments.depsTitleHook || 'Dependencies',
-        buildPath: arguments.buildPath || './build'
+        buildPath: arguments.buildPath || './build',
+        flattenDir: arguments.flattenDir || false
     };
 }
 
@@ -414,17 +414,26 @@ function writeEachFileOnce (filesObj) {
         const updated = filesObj[key].content.updated;
         const name = filesObj[key].name;
         const path = Path.join(globalOptions.buildPath, filesObj[key].path.replace(globalOptions.rootPath.replace('./', ''), ''));
+        let writeTo = Path.join(path, filesObj[key].name);
 
         if (original !== updated || globalOptions.buildPath) {
 
             if (globalOptions.buildPath) {
-                fs.mkdirSync(path, { recursive: true });
+                fs.mkdirSync(globalOptions.buildPath, { recursive: true });
+
+                if (!globalOptions.flattenDir) {
+                    fs.mkdirSync(path, { recursive: true });
+                }
+            }
+console.log(typeof globalOptions.flattenDir, globalOptions.flattenDir);
+            if (globalOptions.flattenDir) {
+                writeTo = Path.join(globalOptions.buildPath, filesObj[key].name);
             }
 
             waitForIt.push(new Promise((resolve, reject) => {
-                fs.writeFile(Path.join(path, filesObj[key].name), updated, (err) => {
+                fs.writeFile(writeTo, updated, (err) => {
                     if (err) console.log(err);
-                    console.log(`Successfully ${!globalOptions.buildPath ? 'updated' : 'created'} ${Path.join(path, filesObj[key].name)}.`);
+                    console.log(`Successfully ${!globalOptions.buildPath ? 'updated' : 'created'} ${writeTo}.`);
                     count += 1;
                     resolve(filesObj);
                 });
@@ -6659,7 +6668,8 @@ try {
       resetOnly: core.getInput('resetOnly'),
       templatePath: core.getInput('templatePath'),
       depsTitleHook: core.getInput('depsTitleHook'),
-      buildPath: core.getInput('buildPath')
+      buildPath: core.getInput('buildPath'),
+      flattenDir: core.getInput('flattenDir')
   });
 } catch (error) {
   core.setFailed(error.message);

diff --git a/lib/index.js b/lib/index.js
@@ -2,8 +2,7 @@ const fs = require("fs");
 const Path = require("path");
 let globalOptions, builders, miners;
 
-// TODO: build action and publish
-// TODO: Publish action
+// TODO: global option booleans not exactly working
 // TODO: Publish npm
 // TODO: ignore list
 // TODO: custom miners, builders ... miners=./lib/mine.js builders=./lib/build.js done=./lib/done.js
@@ -42,7 +41,8 @@ function setGlobalOptions (config = {}) {
         resetOnly: arguments.resetOnly || false,
         templatePath: arguments.templatePath || undefined,
         depsTitleHook: arguments.depsTitleHook || 'Dependencies',
-        buildPath: arguments.buildPath || './build'
+        buildPath: arguments.buildPath || './build',
+        flattenDir: arguments.flattenDir || false
     };
 }
 
@@ -408,17 +408,26 @@ function writeEachFileOnce (filesObj) {
         const updated = filesObj[key].content.updated;
         const name = filesObj[key].name;
         const path = Path.join(globalOptions.buildPath, filesObj[key].path.replace(globalOptions.rootPath.replace('./', ''), ''));
+        let writeTo = Path.join(path, filesObj[key].name);
 
         if (original !== updated || globalOptions.buildPath) {
 
             if (globalOptions.buildPath) {
-                fs.mkdirSync(path, { recursive: true });
+                fs.mkdirSync(globalOptions.buildPath, { recursive: true });
+
+                if (!globalOptions.flattenDir) {
+                    fs.mkdirSync(path, { recursive: true });
+                }
+            }
+console.log(typeof globalOptions.flattenDir, globalOptions.flattenDir);
+            if (globalOptions.flattenDir) {
+                writeTo = Path.join(globalOptions.buildPath, filesObj[key].name);
             }
 
             waitForIt.push(new Promise((resolve, reject) => {
-                fs.writeFile(Path.join(path, filesObj[key].name), updated, (err) => {
+                fs.writeFile(writeTo, updated, (err) => {
                     if (err) console.log(err);
-                    console.log(`Successfully ${!globalOptions.buildPath ? 'updated' : 'created'} ${Path.join(path, filesObj[key].name)}.`);
+                    console.log(`Successfully ${!globalOptions.buildPath ? 'updated' : 'created'} ${writeTo}.`);
                     count += 1;
                     resolve(filesObj);
                 });

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "backlinks-test",
-  "version": "1.0.0",
+  "version": "v1.8",
   "description": "This action offers a number of helpers to help automate some of the laborious tasks across many files within a wiki. For example generating table of contents or backlinking references.",
   "main": "./lib/index.js",
   "scripts": {