file-path-helper 1.4.0 → 1.4.4

package/index.d.ts

@@ -0,0 +1,206 @@
+import { IOptions } from 'glob';
+
+/**
+ * Directory Separator
+ */
+export type Separator = '/'|'\\';
+
+export interface Size {
+  bytes: number;
+  /**
+   * e.g. '>' or '<='
+   */
+  operator: string;
+}
+
+export interface ParsedDate {
+  date: Date;
+  year: number;
+  month: number;
+  day: number;
+  /**
+   * Returns only date as string. e.g. '2019-01-01'
+   */
+  toDateString(): string;
+}
+
+//
+// file methods
+//
+
+/**
+ * Glob promise.
+ *
+ * @param {string} pattern
+ * @param {GlobOptions} options
+ * @returns {Promise<string[], Error>}
+ */
+export function globPromise(pattern: string, options: IOptions): Promise<string[]>;
+
+/**
+ * Replace directory separator.
+ *
+ * @param {string} path
+ * @param {Separator} separator default: '/'
+ * @returns {string}
+ */
+export function replaceSeparator(path: string, separator: Separator): string;
+
+/**
+ * Append last slash to directory.
+ *
+ * @param {string} dir
+ * @param {Separator} separator default: '/'
+ */
+export function trimDir(dir:string, separator?: Separator): string;
+
+/**
+ * Set directory part of path.
+ *
+ * @param {string} path
+ * @param {string} dir
+ * @param {Separator} separator default: '/'
+ * @returns {string}
+ */
+export function setDir(path: string, dir: string, separator?: Separator): string;
+
+/**
+ * Get last number from path.
+ *
+ * @param {string} path
+ * @returns {string}
+ */
+export function getLastNumber(path: string): string;
+
+/**
+ * Remove last number from file name.
+ *
+ * @param {string} file
+ * @returns {string}
+ */
+export function removeLastNumber(file: string): string;
+
+/**
+ * Auto increase path.
+ * If the same file exists, It's returns filename what increased number.
+ *
+ * @param {string} path
+ * @returns {Promise<string>} auto increased path.
+ */
+export function autoIncrease(path: string): Promise<string>;
+
+/**
+ * Resolve output file name.
+ *
+ * @param {string} output
+ * @param {string} source
+ * @returns {string}
+ */
+export function resolveOutputFile(output: string, source: string): string;
+
+/**
+ * Convert size in bytes.
+ * @see https://stackoverflow.com/questions/15900485/correct-way-to-convert-size-in-bytes-to-kb-mb-gb-in-javascript
+ *
+ * @param {number} bytes
+ * @param {number} decimals default: 2
+ * @returns {string}
+ */
+export function bytesToSize(bytes: number, decimals?: number): string;
+
+/**
+ * Parses string that includes file size and operator.
+ *
+ * @param {string} size e.g '10.5mb' '>1GB' '=<10kb'
+ * @returns {Size} Size
+ */
+export function parseSize(size: string): Size;
+
+//
+// string methods
+//
+
+/**
+ * truncate string.
+ *
+ * @param {string} str
+ * @param {number} length default: 40
+ * @param {string} ellipsis default: '…'
+ * @returns {string}
+ */
+export function truncate(str: string, length?: number, ellipsis?: string): string;
+
+/**
+ * Sanitize string for safe filename.
+ * @see https://github.com/parshap/node-sanitize-filename#readme
+ *
+ * @param {string} str
+ * @param {string} replacer default: `''`
+ * @returns {string}
+ */
+export function sanitize(str: string, replacer?: string): string;
+
+//
+// array methods
+//
+
+/**
+ * Sorting array of alphanumerical strings naturally.
+ * @see https://stackoverflow.com/questions/2802341/javascript-natural-sort-of-alphanumerical-strings
+ *
+ * @param {string[]} arr
+ * @returns {string[]}
+ */
+export function naturalSort(arr: string[]): string[];
+
+/**
+ * Filtering an array with Promise
+ * @see https://stackoverflow.com/questions/33355528/filtering-an-array-with-a-function-that-returns-a-promise
+ *
+ * @template T
+ * @param {T[]} arr - filtering target array.
+ * @param {function(T, number, T[]): Promise<boolean>} cb - callback function for filtering. arguments is value, index, array.
+ * @returns {Promise<T[]>}
+ */
+export function filter<T>(arr: T[], cb: (value: T, index: number, arr: T[]) => Promise<boolean>): Promise<T[]>;
+
+/**
+ * Split array into chunks
+ * @see https://stackoverflow.com/questions/8495687/split-array-into-chunks#answer-8495740
+ *
+ * @template T
+ * @param {T[]} arr
+ * @param {number} size
+ * @returns {T[][]}
+ */
+export function chunks<T>(arr: T[], size: number): T[][];
+
+//
+// date methods
+//
+
+/**
+ * Parsing the value to date. it's useful handling 'date'(not hours and minutes) purpose.
+ *
+ * @param {string|number|Date} value
+ * @returns {ParsedDate}
+ */
+export function parseDate(value: string|number|Date): ParsedDate;
+
+/**
+ * Get array of date strings
+ *
+ * @param {string} value date string. e.g. '2020-01-01~2020-01-03'
+ * @returns {string[]} e.g. ['2020-01-01', '2020-01-02', '2020-01-03']
+ */
+export function getDates(value: string): string[];
+
+/**
+ * difference between two dates.
+ * @see https://stackoverflow.com/questions/3224834/get-difference-between-2-dates-in-javascript
+ *
+ * @param {string|number|Date} a
+ * @param {string|number|Date} b
+ * @returns {number}
+ */
+export function diffDays(a: string|number|Date, b: string|number|Date): number;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "file-path-helper",
-  "version": "1.4.0",
+  "version": "1.4.4",
+  "types": "index.d.ts",
   "description": "Helpful methods for handling file path.",
   "main": "src/index.js",
   "scripts": {
@@ -12,12 +13,12 @@
   "author": "archco",
   "license": "MIT",
   "dependencies": {
-    "fs-extra": "^8.1.0",
-    "glob": "^7.1.6"
+    "fs-extra": "^10.0.0",
+    "glob": "^7.2.0"
   },
   "devDependencies": {
-    "@types/jest": "^25.1.2",
-    "eslint": "^6.8.0",
-    "jest": "^25.1.0"
+    "@types/jest": "^27.4.0",
+    "eslint": "^8.8.0",
+    "jest": "^27.4.7"
   }
 }

package/src/arr.js

@@ -1,48 +1,48 @@
-/**
- * Sorting array of alphanumerical strings naturally.
- * @link https://stackoverflow.com/questions/2802341/javascript-natural-sort-of-alphanumerical-strings
- *
- * @param {string[]} arr
- * @returns {string[]}
- */
-function naturalSort(arr) {
-  const collator = new Intl.Collator(undefined, {
-    numeric: true,
-    sensitivity: 'base',
-  });
-  return arr.sort(collator.compare);
-}
-
-/**
- * Filtering an array with Promise
- * @see https://stackoverflow.com/questions/33355528/filtering-an-array-with-a-function-that-returns-a-promise
- *
- * @template T
- * @param {T[]} arr - filtering target array.
- * @param {function(T, number, T[]): Promise<boolean>} cb - callback function for filtering. arguments is value, index, array.
- * @returns {Promise<T[]>}
- */
-async function filter(arr, cb) {
-  const fail = Symbol();
-  return (await Promise.all(arr.map(async (v, i, a) => (await cb(v, i, a)) ? v : fail))).filter(i => i !== fail);
-}
-
-/**
- * Split array into chunks
- * @see https://stackoverflow.com/questions/8495687/split-array-into-chunks#answer-8495740
- *
- * @template T
- * @param {T[]} arr
- * @param {number} size
- * @returns {T[][]}
- */
-function chunks(arr, size) {
-  size = size < 1 ? arr.length : size;
-  return Array(Math.ceil(arr.length / size)).fill().map((_, index) => index * size).map(begin => arr.slice(begin, begin + size));
-}
-
-module.exports = {
-  naturalSort,
-  filter,
-  chunks,
-};
+/**
+ * Sorting array of alphanumerical strings naturally.
+ * @see https://stackoverflow.com/questions/2802341/javascript-natural-sort-of-alphanumerical-strings
+ *
+ * @param {string[]} arr
+ * @returns {string[]}
+ */
+function naturalSort(arr) {
+  const collator = new Intl.Collator(undefined, {
+    numeric: true,
+    sensitivity: 'base',
+  });
+  return arr.sort(collator.compare);
+}
+
+/**
+ * Filtering an array with Promise
+ * @see https://stackoverflow.com/questions/33355528/filtering-an-array-with-a-function-that-returns-a-promise
+ *
+ * @template T
+ * @param {T[]} arr - filtering target array.
+ * @param {function(T, number, T[]): Promise<boolean>} cb - callback function for filtering. arguments is value, index, array.
+ * @returns {Promise<T[]>}
+ */
+async function filter(arr, cb) {
+  const fail = Symbol();
+  return (await Promise.all(arr.map(async (v, i, a) => (await cb(v, i, a)) ? v : fail))).filter(i => i !== fail);
+}
+
+/**
+ * Split array into chunks
+ * @see https://stackoverflow.com/questions/8495687/split-array-into-chunks#answer-8495740
+ *
+ * @template T
+ * @param {T[]} arr
+ * @param {number} size
+ * @returns {T[][]}
+ */
+function chunks(arr, size) {
+  size = size < 1 ? arr.length : size;
+  return Array(Math.ceil(arr.length / size)).fill().map((_, index) => index * size).map(begin => arr.slice(begin, begin + size));
+}
+
+module.exports = {
+  naturalSort,
+  filter,
+  chunks,
+};

package/src/date.js

@@ -1,77 +1,77 @@
-/**
- * Parsing the value to date. it's useful handling 'date'(not hours and minutes) purpose.
- *
- * @typedef ParsedDate
- * @property {Date} date
- * @property {number} year
- * @property {number} month
- * @property {number} day
- * @property {function(): string} toDateString e.g. '2019-12-25'
- *
- * @param {string|number|Date} value
- * @returns {ParsedDate}
- */
-function parseDate(value) {
-  const date = new Date(value);
-  const twoDigit = x => x.toString().padStart(2, 0);
-  return {
-    date,
-    year: date.getFullYear(),
-    month: date.getMonth() + 1,
-    day: date.getDate(),
-    toDateString: function () {
-      return `${this.year}-${twoDigit(this.month)}-${twoDigit(this.day)}`;
-    },
-  };
-}
-
-/**
- * Get array of date strings
- *
- * @param {string} value date string. e.g. '2020-01-01~2020-01-03'
- * @returns {string[]} e.g. ['2020-01-01', '2020-01-02', '2020-01-03']
- */
-function getDates(value) {
-  /** @type {function(string[]): Date[]} */
-  const sortedDates = dates => dates.map(d => new Date(d)).sort((a, b) => a - b);
-  /** @type {function(Date, number): Date} */
-  const addDays = (d, days) => {
-    const r = new Date(d);
-    r.setDate(r.getDate() + days);
-    return r;
-  }
-
-  if (/~/.test(value)) {
-    const [from, until] = sortedDates(value.split('~'));
-    const dates = [];
-    for (let i = 0; i <= diffDays(from, until); i++) {
-      dates.push(parseDate(addDays(from, i)).toDateString());
-    }
-    return dates;
-  } else {
-    return [value];
-  }
-}
-
-/**
- * difference between two dates.
- * @see https://stackoverflow.com/questions/3224834/get-difference-between-2-dates-in-javascript
- *
- * @param {string|number|Date} a
- * @param {string|number|Date} b
- * @returns {number}
- */
-function diffDays(a, b) {
-  const msPerDay = 1000 * 60 * 60 * 24;
-  const [utc1, utc2] = [a, b].map(x => {
-    const d = new Date(x);
-    return Date.UTC(d.getFullYear(), d.getMonth(), d.getDate());
-  });
-  return Math.floor((utc2 - utc1) / msPerDay);
-}
-
-module.exports = {
-  parseDate,
-  getDates,
-  diffDays,
-};
+/**
+ * Parsing the value to date. it's useful handling 'date'(not hours and minutes) purpose.
+ *
+ * @typedef ParsedDate
+ * @property {Date} date
+ * @property {number} year
+ * @property {number} month
+ * @property {number} day
+ * @property {function(): string} toDateString e.g. '2019-12-25'
+ *
+ * @param {string|number|Date} value
+ * @returns {ParsedDate}
+ */
+function parseDate(value) {
+  const date = new Date(value);
+  const twoDigit = x => x.toString().padStart(2, 0);
+  return {
+    date,
+    year: date.getFullYear(),
+    month: date.getMonth() + 1,
+    day: date.getDate(),
+    toDateString: function () {
+      return `${this.year}-${twoDigit(this.month)}-${twoDigit(this.day)}`;
+    },
+  };
+}
+
+/**
+ * Get array of date strings
+ *
+ * @param {string} value date string. e.g. '2020-01-01~2020-01-03'
+ * @returns {string[]} e.g. ['2020-01-01', '2020-01-02', '2020-01-03']
+ */
+function getDates(value) {
+  /** @type {function(string[]): Date[]} */
+  const sortedDates = dates => dates.map(d => new Date(d)).sort((a, b) => a - b);
+  /** @type {function(Date, number): Date} */
+  const addDays = (d, days) => {
+    const r = new Date(d);
+    r.setDate(r.getDate() + days);
+    return r;
+  }
+
+  if (/~/.test(value)) {
+    const [from, until] = sortedDates(value.split('~'));
+    const dates = [];
+    for (let i = 0; i <= diffDays(from, until); i++) {
+      dates.push(parseDate(addDays(from, i)).toDateString());
+    }
+    return dates;
+  } else {
+    return [value];
+  }
+}
+
+/**
+ * difference between two dates.
+ * @see https://stackoverflow.com/questions/3224834/get-difference-between-2-dates-in-javascript
+ *
+ * @param {string|number|Date} a
+ * @param {string|number|Date} b
+ * @returns {number}
+ */
+function diffDays(a, b) {
+  const msPerDay = 1000 * 60 * 60 * 24;
+  const [utc1, utc2] = [a, b].map(x => {
+    const d = new Date(x);
+    return Date.UTC(d.getFullYear(), d.getMonth(), d.getDate());
+  });
+  return Math.floor((utc2 - utc1) / msPerDay);
+}
+
+module.exports = {
+  parseDate,
+  getDates,
+  diffDays,
+};

package/src/file.js

@@ -12,7 +12,7 @@ const { pathExists } = require('fs-extra');
  *
  * @param {string} pattern
  * @param {GlobOptions} options
- * @returns {Promise.<Array<String>, Error>}
+ * @returns {Promise<string[], Error>}
  */
 function globPromise(pattern, options) {
   return new Promise((resolve, reject) => {

package/src/index.js

@@ -1,11 +1,11 @@
-const arrUtils = require('./arr');
-const dateUtils = require('./date');
-const fileUtils = require('./file');
-const strUtils = require('./str');
-
-module.exports = Object.assign({},
-  arrUtils,
-  dateUtils,
-  fileUtils,
-  strUtils,
-);
+const arrUtils = require('./arr');
+const dateUtils = require('./date');
+const fileUtils = require('./file');
+const strUtils = require('./str');
+
+module.exports = Object.assign({},
+  arrUtils,
+  dateUtils,
+  fileUtils,
+  strUtils,
+);

package/src/str.js

@@ -2,26 +2,29 @@
  * truncate string.
  *
  * @param {string} str
- * @param {number} length
- * @param {string} ellipsis
+ * @param {number} length default: 40
+ * @param {string} ellipsis default: '…'
  * @returns {string}
  */
 function truncate(str, length = 40, ellipsis = '…') {
   return str.length < length
     ? str
-    : str.substr(0, length - ellipsis.length) + ellipsis;
+    : str.substring(0, length - ellipsis.length) + ellipsis;
 }
 
 /**
  * Sanitize string for safe filename.
- * @link https://github.com/parshap/node-sanitize-filename#readme
+ * @see https://github.com/parshap/node-sanitize-filename#readme
+ * @see https://en.wikipedia.org/wiki/C0_and_C1_control_codes
  *
  * @param {string} str
  * @param {string} replacer default: `''`
  * @returns {string}
  */
 function sanitize(str, replacer = '') {
-  return str.replace(/(https|http)/g, '') // remove 'http'
+  // eslint-disable-next-line no-control-regex
+  return str.replace(/[\x00-\x1f\x80-\x9f]/g, replacer) // control codes
+    .replace(/(https|http)/g, '') // remove 'http'
     .replace(/\t|[ ]{2,}/g, ' ')          // two spaces or tab -> one space
     .replace(/[/:?<>\\*|"]/g, replacer)   // sanitize
     .trim();

package/test/utils.test.js

@@ -224,6 +224,7 @@ describe('#sanitize', () => {
     expect(sanitize(' he*llo?', ' ')).toBe('he llo');
     expect(sanitize(' he*llo/_<wo:rld')).toBe('hello_world');
     expect(sanitize('https://github.com/')).toBe('github.com');
+    expect(sanitize('string\btest', ' ')).toBe('string test');
   });
 });
 
@@ -231,6 +232,7 @@ describe('#truncate', () => {
   it('truncate string', () => {
     expect(truncate('1234567890', 6)).toBe('12345…');
     expect(truncate('1234567890', 8, '...')).toBe('12345...');
+    expect(truncate('a가나다라bcd', 3, '')).toBe('a가나');
   });
 });