@adobe/helix-importer 1.14.0 → 1.15.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.15.0](https://github.com/adobe/helix-importer/compare/v1.14.0...v1.15.0) (2022-08-10)
+
+
+### Features
+
+* add sanitize path helper ([f0d6865](https://github.com/adobe/helix-importer/commit/f0d6865a6e2dc79ae51b017ab8da0e431d57a539))
+
 # [1.14.0](https://github.com/adobe/helix-importer/compare/v1.13.1...v1.14.0) (2022-07-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-importer",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "Helix Importer tool: create md / docx from html",
   "main": "src/index.js",
   "type": "module",

package/src/utils/FileUtils.js

@@ -14,6 +14,7 @@ import sanitize from 'sanitize-filename';
 
 export default class FileUtils {
   static sanitizeFilename(name) {
+    if (!name) return '';
     return sanitize(decodeURIComponent(name))
       .trim()
       .toLowerCase()
@@ -22,4 +23,20 @@ export default class FileUtils {
       .replace(/\s/g, '-')
       .replace(/-{2,}/g, '-');
   }
+
+  static sanitizePath(path) {
+    if (!path) return '';
+    const extension = path.split('.').pop();
+    const pathname = extension !== path ? path.substring(0, path.lastIndexOf('.')) : path;
+    let sanitizedPath = '';
+    pathname.split('/').forEach((p) => {
+      if (p !== '') {
+        sanitizedPath += `/${FileUtils.sanitizeFilename(p)}`;
+      }
+    });
+    if (extension !== path) {
+      sanitizedPath += `.${extension}`;
+    }
+    return sanitizedPath;
+  }
 }

package/test/utils/FileUtils.spec.js

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { strictEqual } from 'assert';
+import { describe, it } from 'mocha';
+
+import FileUtils from '../../src/utils/FileUtils.js';
+
+describe('FileUtils tests', () => {
+  it('FileUtils#sanitizeFilename empty', () => {
+    strictEqual(FileUtils.sanitizeFilename(), '');
+  });
+
+  it('FileUtils#sanitizeFilename no change', () => {
+    strictEqual(FileUtils.sanitizeFilename('simple'), 'simple');
+    strictEqual(FileUtils.sanitizeFilename('with-dash-and-1-number'), 'with-dash-and-1-number');
+  });
+
+  it('FileUtils#sanitizeFilename sanitize', () => {
+    strictEqual(FileUtils.sanitizeFilename('UPPERCASE---with spaces and%20encoded.dotalso'), 'uppercase-with-spaces-and-encodeddotalso');
+  });
+
+  it('FileUtils#sanitizePath empty', () => {
+    strictEqual(FileUtils.sanitizePath(), '');
+  });
+
+  it('FileUtils#sanitizePath no change', () => {
+    strictEqual(FileUtils.sanitizePath('/should/be/valid/path'), '/should/be/valid/path');
+    strictEqual(FileUtils.sanitizePath('/should/be/valid/path/with.extension'), '/should/be/valid/path/with.extension');
+  });
+
+  it('FileUtils#sanitizePath sanitize', () => {
+    strictEqual(FileUtils.sanitizePath('//should/BE/1/paTh/to sanitize/but.still.keep.extension'), '/should/be/1/path/to-sanitize/butstillkeep.extension');
+  });
+});