Compare commits

..

14 Commits

Author SHA1 Message Date
77603ee736 4.1.3 2017-01-21 00:47:52 +01:00
353058ed73 switch to smartq 2017-01-21 00:47:48 +01:00
bf618512e2 4.1.2 2017-01-01 03:16:23 +01:00
b276c5639d add new ci file 2017-01-01 03:16:18 +01:00
779c62dcbb 4.1.1 2017-01-01 02:46:02 +01:00
3e1101c5e1 add ensureEmptyDir() and ensureEmptyDirSync() 2017-01-01 02:45:53 +01:00
395504127c 4.1.0 2016-10-27 18:55:22 +02:00
6dee92a3df remove gulp dependency 2016-10-27 18:55:18 +02:00
0ba3c1794e 4.0.24 2016-09-30 16:38:27 +02:00
0a810a3ac1 some style improvement 2016-09-30 16:38:24 +02:00
fc23f221eb 4.0.23 2016-09-30 16:16:15 +02:00
cfcd1f7aaf fix absolute pathing 2016-09-30 16:16:11 +02:00
2cb8c5117a 4.0.22 2016-09-29 14:17:49 +02:00
2c52dec8ea add removeMany and removeManySync 2016-09-29 14:17:46 +02:00
16 changed files with 385 additions and 309 deletions

View File

@ -3,6 +3,8 @@ image: hosttoday/ht-docker-node:npmts
stages: stages:
- test - test
- release - release
- trigger
- pages
testLEGACY: testLEGACY:
stage: test stage: test
@ -28,10 +30,30 @@ testSTABLE:
release: release:
stage: release stage: release
environment: npm_registry
script: script:
- npmci publish - npmci publish
only: only:
- tags - tags
tags: tags:
- docker - docker
trigger:
stage: trigger
script:
- npmci trigger
only:
- tags
tags:
- docker
pages:
image: hosttoday/ht-docker-node:npmpage
stage: pages
script:
- npmci command npmpage --publish gitlab
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public

View File

@ -1,6 +1,4 @@
/// <reference types="q" />
import 'typings-global'; import 'typings-global';
import plugins = require('./smartfile.plugins');
/** /**
* *
* @param filePath * @param filePath
@ -12,7 +10,7 @@ export declare let fileExistsSync: (filePath: any) => boolean;
* @param filePath * @param filePath
* @returns {any} * @returns {any}
*/ */
export declare let fileExists: (filePath: any) => plugins.q.Promise<{}>; export declare let fileExists: (filePath: any) => Promise<{}>;
/** /**
* Checks if given path points to an existing directory * Checks if given path points to an existing directory
*/ */
@ -24,7 +22,7 @@ export declare let isFile: (pathArg: any) => boolean;
/** /**
* copies a file from A to B on the local disk * copies a file from A to B on the local disk
*/ */
export declare let copy: (fromArg: string, toArg: string) => plugins.q.Promise<{}>; export declare let copy: (fromArg: string, toArg: string) => Promise<{}>;
/** /**
* copies a file SYNCHRONOUSLY from A to B on the local disk * copies a file SYNCHRONOUSLY from A to B on the local disk
*/ */
@ -32,11 +30,21 @@ export declare let copySync: (fromArg: string, toArg: string) => boolean;
/** /**
* ensures that a directory is in place * ensures that a directory is in place
*/ */
export declare let ensureDir: (dirPathArg: string) => plugins.q.Promise<{}>; export declare let ensureDir: (dirPathArg: string) => Promise<{}>;
/** /**
* ensures that a directory is in place * ensures that a directory is in place
*/ */
export declare let ensureDirSync: (dirPathArg: string) => void; export declare let ensureDirSync: (dirPathArg: string) => void;
/**
* ensure an empty directory
* @executes ASYNC
*/
export declare let ensureEmptyDir: (dirPathArg: string) => Promise<{}>;
/**
* ensure an empty directory
* @executes SYNC
*/
export declare let ensureEmptyDirSync: (dirPathArg: string) => void;
/** /**
* ensures that a file is on disk * ensures that a file is on disk
* @param filePath the filePath to ensureDir * @param filePath the filePath to ensureDir
@ -44,7 +52,7 @@ export declare let ensureDirSync: (dirPathArg: string) => void;
* @returns Promise<void> * @returns Promise<void>
* @exec ASYNC * @exec ASYNC
*/ */
export declare let ensureFile: (filePathArg: any, initFileStringArg: any) => plugins.q.Promise<void>; export declare let ensureFile: (filePathArg: any, initFileStringArg: any) => Promise<void>;
/** /**
* ensures that a file is on disk * ensures that a file is on disk
* @param filePath the filePath to ensureDir * @param filePath the filePath to ensureDir
@ -56,18 +64,19 @@ export declare let ensureFileSync: (filePathArg: string, initFileStringArg: stri
/** /**
* removes a file or folder from local disk * removes a file or folder from local disk
*/ */
export declare let remove: (pathArg: string) => plugins.q.Promise<{}>; export declare let remove: (pathArg: string) => Promise<void>;
/** /**
* removes a file SYNCHRONOUSLY from local disk * removes a file SYNCHRONOUSLY from local disk
*/ */
export declare let removeSync: (pathArg: string) => boolean; export declare let removeSync: (pathArg: string) => boolean;
/** /**
* * removes an array of filePaths from disk
* @param filePathArg
* @returns {*}
*/ */
export declare let toGulpStreamSync: (filePathArg: string) => any; export declare let removeMany: (filePathArrayArg: string[]) => Promise<void[]>;
export declare let toGulpDestSync: (folderPathArg: string) => any; /**
* like removeFilePathArray but SYNCHRONOUSLY
*/
export declare let removeManySync: (filePathArrayArg: string[]) => void;
/** /**
* *
* @param filePathArg * @param filePathArg
@ -98,7 +107,7 @@ export declare let requireReload: (path: string) => any;
* lists Folders in a directory on local disk * lists Folders in a directory on local disk
* @returns Promise * @returns Promise
*/ */
export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => plugins.q.Promise<{}>; export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
/** /**
* lists Folders SYNCHRONOUSLY in a directory on local disk * lists Folders SYNCHRONOUSLY in a directory on local disk
* @returns an array with the folder names as strings * @returns an array with the folder names as strings
@ -108,7 +117,7 @@ export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => s
* lists Files in a directory on local disk * lists Files in a directory on local disk
* @returns Promise * @returns Promise
*/ */
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => plugins.q.Promise<{}>; export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
/** /**
* lists Files SYNCHRONOUSLY in a directory on local disk * lists Files SYNCHRONOUSLY in a directory on local disk
* @returns an array with the folder names as strings * @returns an array with the folder names as strings
@ -118,7 +127,7 @@ export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => str
* lists all items (folders AND files) in a directory on local disk * lists all items (folders AND files) in a directory on local disk
* @returns Promise<string[]> * @returns Promise<string[]>
*/ */
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => plugins.q.Promise<string[]>; export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => Promise<string[]>;
/** /**
* lists all items (folders AND files) in a directory on local disk * lists all items (folders AND files) in a directory on local disk
* @returns an array with the folder names as strings * @returns an array with the folder names as strings
@ -127,6 +136,7 @@ export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => plug
export declare let listAllItemsSync: (pathArg: string, regexFilter?: RegExp) => string[]; export declare let listAllItemsSync: (pathArg: string, regexFilter?: RegExp) => string[];
/** /**
* lists a file tree using a miniMatch filter * lists a file tree using a miniMatch filter
* note: if the miniMatch Filter is an absolute path, the cwdArg will be omitted
* @returns Promise<string[]> string array with the absolute paths of all matching files * @returns Promise<string[]> string array with the absolute paths of all matching files
*/ */
export declare let listFileTree: (dirPath: string, miniMatchFilter: string) => plugins.q.Promise<string[]>; export declare let listFileTree: (dirPathArg: string, miniMatchFilter: string) => Promise<string[]>;

64
dist/smartfile.fs.js vendored

File diff suppressed because one or more lines are too long

View File

@ -1,7 +1,10 @@
/// <reference types="vinyl" /> /// <reference types="node" />
/// <reference types="q" />
import 'typings-global'; import 'typings-global';
import plugins = require('./smartfile.plugins'); export interface IVinylFile {
contents: Buffer;
base: string;
path: string;
}
/** /**
* allows you to create a gulp stream * allows you to create a gulp stream
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles * from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
@ -9,7 +12,7 @@ import plugins = require('./smartfile.plugins');
* @returns stream.Readable * @returns stream.Readable
* @TODO: make it async; * @TODO: make it async;
*/ */
export declare let toGulpStream: (fileArg: string | string[] | plugins.vinyl | plugins.vinyl[], baseArg?: string) => any; export declare let toGulpStream: (fileArg: string | string[] | IVinylFile | IVinylFile[], baseArg?: string) => any;
/** /**
* converts file to Object * converts file to Object
* @param fileStringArg * @param fileStringArg
@ -26,7 +29,7 @@ export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
filename?: string; filename?: string;
base?: string; base?: string;
relPath?: string; relPath?: string;
}) => plugins.vinyl; }) => any;
/** /**
* takes a string array and some options and returns a vinylfile array * takes a string array and some options and returns a vinylfile array
* @param arrayArg * @param arrayArg
@ -40,12 +43,12 @@ export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
/** /**
* takes a vinylFile object and converts it to String * takes a vinylFile object and converts it to String
*/ */
export declare let toStringSync: (fileArg: plugins.vinyl) => any; export declare let vinylToStringSync: (fileArg: IVinylFile) => string;
/** /**
* writes string or vinyl file to disk. * writes string or vinyl file to disk.
* @param fileArg * @param fileArg
* @param fileNameArg * @param fileNameArg
* @param fileBaseArg * @param fileBaseArg
*/ */
export declare let toFs: (fileContentArg: string | plugins.vinyl, filePathArg: any) => plugins.q.Promise<{}>; export declare let toFs: (fileContentArg: string | IVinylFile, filePathArg: any) => Promise<{}>;
export declare let toFsSync: (fileArg: any, filePathArg: string) => void; export declare let toFsSync: (fileArg: any, filePathArg: string) => void;

File diff suppressed because one or more lines are too long

View File

@ -2,15 +2,11 @@ import 'typings-global';
export import beautylog = require('beautylog'); export import beautylog = require('beautylog');
export import fs = require('fs'); export import fs = require('fs');
export import fsExtra = require('fs-extra'); export import fsExtra = require('fs-extra');
export declare let gulp: any;
export declare let glob: any; export declare let glob: any;
export declare let g: {
remoteSrc: any;
};
export import path = require('path'); export import path = require('path');
export import q = require('q'); export import q = require('smartq');
export import vinyl = require('vinyl');
export declare let vinylFile: any;
export declare let yaml: any;
export declare let request: any; export declare let request: any;
export declare let requireReload: any; export declare let requireReload: any;
export import smartpath = require('smartpath');
export declare let vinylFile: any;
export declare let yaml: any;

View File

@ -3,16 +3,12 @@ require("typings-global");
exports.beautylog = require("beautylog"); exports.beautylog = require("beautylog");
exports.fs = require("fs"); exports.fs = require("fs");
exports.fsExtra = require("fs-extra"); exports.fsExtra = require("fs-extra");
exports.gulp = require('gulp');
exports.glob = require('glob'); exports.glob = require('glob');
exports.g = {
remoteSrc: require('gulp-remote-src')
};
exports.path = require("path"); exports.path = require("path");
exports.q = require("q"); exports.q = require("smartq");
exports.vinyl = require("vinyl");
exports.vinylFile = require('vinyl-file');
exports.yaml = require('js-yaml');
exports.request = require('request'); exports.request = require('request');
exports.requireReload = require('require-reload'); exports.requireReload = require('require-reload');
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHlDQUE4QztBQUM5QywyQkFBZ0M7QUFDaEMsc0NBQTJDO0FBQ2hDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUN0QixRQUFBLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUE7QUFDdEIsUUFBQSxDQUFDLEdBQUc7SUFDWCxTQUFTLEVBQUUsT0FBTyxDQUFDLGlCQUFpQixDQUFDO0NBQ3hDLENBQUE7QUFDRCwrQkFBb0M7QUFDcEMseUJBQThCO0FBQzlCLGlDQUFzQztBQUMzQixRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBQ3pCLFFBQUEsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUM1QixRQUFBLGFBQWEsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQSJ9 exports.smartpath = require("smartpath");
exports.vinylFile = require('vinyl-file');
exports.yaml = require('js-yaml');
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHlDQUE4QztBQUM5QywyQkFBZ0M7QUFDaEMsc0NBQTJDO0FBQ2hDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUNqQywrQkFBb0M7QUFDcEMsOEJBQW1DO0FBQ3hCLFFBQUEsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUM1QixRQUFBLGFBQWEsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQTtBQUNwRCx5Q0FBOEM7QUFDbkMsUUFBQSxTQUFTLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFBO0FBQ2pDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQSJ9

View File

@ -1,22 +1,14 @@
/// <reference types="q" />
import 'typings-global'; import 'typings-global';
import plugins = require('./smartfile.plugins'); export declare let toFs: (from: string, toPath: string) => Promise<{}>;
export declare let toFs: (from: string, toPath: string) => plugins.q.Promise<{}>;
/**
*
* @param filePathArg
* @returns {*}
*/
export declare let toGulpStreamSync: (filePathArg: string, baseArg: string) => any;
/** /**
* *
* @param fromArg * @param fromArg
* @returns {any} * @returns {any}
*/ */
export declare let toObject: (fromArg: string) => plugins.q.Promise<{}>; export declare let toObject: (fromArg: string) => Promise<{}>;
/** /**
* *
* @param fromArg * @param fromArg
* @returns {any} * @returns {any}
*/ */
export declare let toString: (fromArg: string) => plugins.q.Promise<{}>; export declare let toString: (fromArg: string) => Promise<{}>;

View File

@ -10,17 +10,6 @@ exports.toFs = function (from, toPath) {
}); });
return done.promise; return done.promise;
}; };
/**
*
* @param filePathArg
* @returns {*}
*/
exports.toGulpStreamSync = function (filePathArg, baseArg) {
let stream = plugins.g.remoteSrc(filePathArg, {
base: baseArg
});
return stream;
};
/** /**
* *
* @param fromArg * @param fromArg
@ -61,4 +50,4 @@ exports.toString = (fromArg) => {
}); });
return done.promise; return done.promise;
}; };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQ0FBK0M7QUFDL0MsZ0VBQWdFO0FBRXJELFFBQUEsSUFBSSxHQUFHLFVBQVMsSUFBWSxFQUFDLE1BQWM7SUFDbEQsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7SUFDbEYsTUFBTSxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUM7UUFDZixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7QUFDdkIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsZ0JBQWdCLEdBQUcsVUFBUyxXQUFtQixFQUFDLE9BQWU7SUFDdEUsSUFBSSxNQUFNLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsV0FBVyxFQUFFO1FBQzFDLElBQUksRUFBRSxPQUFPO0tBQ2hCLENBQUMsQ0FBQTtJQUNGLE1BQU0sQ0FBQyxNQUFNLENBQUE7QUFDakIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZTtJQUMxQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxVQUFVLEtBQUssRUFBRSxRQUFRLEVBQUUsVUFBVTtRQUM5RCxJQUFJLFlBQVksQ0FBQTtRQUNoQixFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsWUFBWSxHQUFHLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxVQUFVLEVBQUMsb0JBQW9CLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUE7WUFDakcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM5QixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsR0FBRyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3hELFlBQVksR0FBRyxTQUFTLENBQUE7WUFDeEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM3QixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUE7QUFFRDs7OztHQUlHO0FBQ1EsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUFlO0lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDNUIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFVBQVUsS0FBSyxFQUFFLFFBQVEsRUFBRSxVQUFVO1FBQzlELEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQzVCLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3BFLFVBQVUsR0FBRyxTQUFTLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUMzQixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUEifQ== //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQ0FBK0M7QUFDL0MsZ0VBQWdFO0FBRXJELFFBQUEsSUFBSSxHQUFHLFVBQVMsSUFBWSxFQUFDLE1BQWM7SUFDbEQsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7SUFDbEYsTUFBTSxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUM7UUFDZixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7QUFDdkIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZTtJQUMxQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxVQUFVLEtBQUssRUFBRSxRQUFRLEVBQUUsVUFBVTtRQUM5RCxJQUFJLFlBQVksQ0FBQTtRQUNoQixFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsWUFBWSxHQUFHLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxVQUFVLEVBQUMsb0JBQW9CLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUE7WUFDakcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM5QixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsR0FBRyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3hELFlBQVksR0FBRyxTQUFTLENBQUE7WUFDeEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM3QixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUE7QUFFRDs7OztHQUlHO0FBQ1EsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUFlO0lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDNUIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFVBQVUsS0FBSyxFQUFFLFFBQVEsRUFBRSxVQUFVO1FBQzlELEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQzVCLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3BFLFVBQVUsR0FBRyxTQUFTLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUMzQixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUEifQ==

View File

@ -1,6 +1,6 @@
{ {
"name": "smartfile", "name": "smartfile",
"version": "4.0.21", "version": "4.1.3",
"description": "offers smart ways to work with files in nodejs", "description": "offers smart ways to work with files in nodejs",
"main": "dist/index.js", "main": "dist/index.js",
"typings": "dist/index.d.ts", "typings": "dist/index.d.ts",
@ -27,26 +27,23 @@
"homepage": "https://gitlab.com/pushrocks/smartfile", "homepage": "https://gitlab.com/pushrocks/smartfile",
"dependencies": { "dependencies": {
"@types/fs-extra": "0.x.x", "@types/fs-extra": "0.x.x",
"@types/q": "0.x.x", "@types/vinyl": "^2.0.0",
"@types/vinyl": "^1.1.29", "beautylog": "^6.0.0",
"beautylog": "^5.0.23", "fs-extra": "^2.0.0",
"fs-extra": "^0.30.0", "glob": "^7.1.1",
"glob": "^7.1.0", "js-yaml": "^3.7.0",
"gulp": "^3.9.1", "request": "^2.79.0",
"gulp-remote-src": "^0.4.1",
"js-yaml": "^3.6.1",
"q": "^1.4.1",
"request": "^2.75.0",
"require-reload": "0.2.2", "require-reload": "0.2.2",
"smartpath": "^3.2.7",
"smartq": "^1.0.4",
"typings-global": "^1.0.14", "typings-global": "^1.0.14",
"vinyl": "^1.2.0", "vinyl": "^2.0.1",
"vinyl-file": "^2.0.0" "vinyl-file": "^3.0.0"
}, },
"devDependencies": { "devDependencies": {
"@types/should": "^8.1.30", "gulp-function": "^2.2.3",
"gulp-function": "^1.3.6", "npmts-g": "^6.0.0",
"npmts-g": "^5.2.8", "smartchai": "^1.0.1",
"should": "^11.1.0",
"typings-test": "^1.0.3" "typings-test": "^1.0.3"
} }
} }

File diff suppressed because one or more lines are too long

View File

@ -1,57 +1,57 @@
import 'typings-test' import 'typings-test'
import * as smartfile from '../dist/index' import * as smartfile from '../dist/index'
import beautylog = require('beautylog') import beautylog = require('beautylog')
let gulp = require('gulp')
let gFunction = require('gulp-function')
import path = require('path') import path = require('path')
import * as should from 'should'
let vinyl = require('vinyl')
describe('smartfile'.yellow, function () { import { expect } from 'smartchai'
describe('.fs'.yellow, function () {
describe('.fileExistsSync'.yellow, function () { import * as vinyl from 'vinyl'
describe('smartfile', function () {
describe('.fs', function () {
describe('.fileExistsSync', function () {
it('should return an accurate boolean', function () { it('should return an accurate boolean', function () {
should(smartfile.fs.fileExistsSync('./test/mytest.json')).be.true() expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true
should(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false() expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false
}) })
}) })
describe('.fileExists'.yellow, function () { describe('.fileExists', function () {
it('should return a working promise', function () { it('should return a working promise', function () {
should(smartfile.fs.fileExists('./test/mytest.json')).be.Promise() expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.a('promise')
should(smartfile.fs.fileExists('./test/mytest.json')).be.fulfilled() expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.fulfilled
should(smartfile.fs.fileExists('./test/notthere.json')).not.be.fulfilled() expect(smartfile.fs.fileExists('./test/notthere.json')).to.not.be.fulfilled
}) })
}) })
describe('.listFoldersSync()', function () { describe('.listFoldersSync()', function () {
it('should get the file type from a string', function () { it('should get the file type from a string', function () {
should(smartfile.fs.listFoldersSync('./test/')).containDeep(['testfolder']) expect(smartfile.fs.listFoldersSync('./test/')).to.deep.include('testfolder')
should(smartfile.fs.listFoldersSync('./test/')).not.containDeep(['notExistentFolder']) expect(smartfile.fs.listFoldersSync('./test/')).to.not.deep.include('notExistentFolder')
}) })
}) })
describe('.listFolders()', function () { describe('.listFolders()', function () {
it('should get the file type from a string', function (done) { it('should get the file type from a string', function (done) {
smartfile.fs.listFolders('./test/') smartfile.fs.listFolders('./test/')
.then(function (folderArrayArg) { .then(function (folderArrayArg) {
should(folderArrayArg).containDeep(['testfolder']) expect(folderArrayArg).to.deep.include('testfolder')
should(folderArrayArg).not.containDeep(['notExistentFolder']) expect(folderArrayArg).to.not.deep.include('notExistentFolder')
done() done()
}) })
}) })
}) })
describe('.listFilesSync()', function () { describe('.listFilesSync()', function () {
it('should get the file type from a string', function () { it('should get the file type from a string', function () {
should(smartfile.fs.listFilesSync('./test/')).containDeep(['mytest.json']) expect(smartfile.fs.listFilesSync('./test/')).to.deep.include('mytest.json')
should(smartfile.fs.listFilesSync('./test/')).not.containDeep(['notExistentFile']) expect(smartfile.fs.listFilesSync('./test/')).to.not.deep.include('notExistentFile')
should(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).containDeep(['mytest.json']) expect(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).to.deep.include('mytest.json')
should(smartfile.fs.listFilesSync('./test/', /mytests.json/)).not.containDeep(['mytest.json']) expect(smartfile.fs.listFilesSync('./test/', /mytests.json/)).to.not.deep.include('mytest.json')
}) })
}) })
describe('.listFiles()', function () { describe('.listFiles()', function () {
it('should get the file type from a string', function (done) { it('should get the file type from a string', function (done) {
smartfile.fs.listFiles('./test/') smartfile.fs.listFiles('./test/')
.then(function (folderArrayArg) { .then(function (folderArrayArg) {
should(folderArrayArg).containDeep(['mytest.json']) expect(folderArrayArg).to.deep.include('mytest.json')
should(folderArrayArg).not.containDeep(['notExistentFile']) expect(folderArrayArg).to.not.deep.include('notExistentFile')
done() done()
}) })
}) })
@ -60,13 +60,13 @@ describe('smartfile'.yellow, function () {
it('should get a file tree', function (done) { it('should get a file tree', function (done) {
smartfile.fs.listFileTree(path.resolve('./test/'), '**/*.txt') smartfile.fs.listFileTree(path.resolve('./test/'), '**/*.txt')
.then(function (folderArrayArg) { .then(function (folderArrayArg) {
should(folderArrayArg).containDeep(['testfolder/testfile1.txt']) expect(folderArrayArg).to.deep.include('testfolder/testfile1.txt')
should(folderArrayArg).not.containDeep(['mytest.json']) expect(folderArrayArg).to.not.deep.include('mytest.json')
done() done()
}) })
}) })
}) })
describe('.copy()'.yellow, function () { describe('.copy()', function () {
it('should copy a directory', function () { it('should copy a directory', function () {
smartfile.fs.copy('./test/testfolder/', './test/temp/') smartfile.fs.copy('./test/testfolder/', './test/temp/')
}) })
@ -81,8 +81,25 @@ describe('smartfile'.yellow, function () {
it('should remove an entire directory', function () { it('should remove an entire directory', function () {
}) })
it('should remove single files', function () { it('smartfile.fs.remove -> should remove single files', function (done) {
smartfile.fs.remove('./test/temp/mytestRenamed.yaml')
.then(() => { done() })
})
it('smartfile.fs.removeSync -> should remove single files synchronouly',function() {
smartfile.fs.removeSync('./test/temp/testfile1.txt')
expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false
})
it('smartfile.fs.removeMany -> should remove and array of files',function(done) {
smartfile.fs.removeMany(['./test/temp/testfile1.txt','./test/temp/testfile2.txt']).then(() => {
expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false
expect(smartfile.fs.fileExistsSync('./test/temp/testfile2.txt')).to.be.false
done()
})
})
it('smartfile.fs.removeManySync -> should remove and array of single files synchronouly',function() {
smartfile.fs.removeManySync(['./test/temp/testfile1.txt','./test/temp/testfile2.txt'])
expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false
expect(smartfile.fs.fileExistsSync('./test/temp/testfile2.txt')).to.be.false
}) })
}) })
}) })
@ -90,48 +107,39 @@ describe('smartfile'.yellow, function () {
describe('.interpreter', function () { describe('.interpreter', function () {
describe('.filetype()', function () { describe('.filetype()', function () {
it('should get the file type from a string', function () { it('should get the file type from a string', function () {
should(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json') expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json')
}) })
}) })
}) })
describe('.fs'.yellow, function () { describe('.fs', function () {
describe('toGulpStreamSync() and toGulpDestSync', function () { describe('.toObjectSync()', function () {
it('should produce a gulp stream', function (done) { it('should read an ' + '.yaml' + ' file to an object', function () {
smartfile.fs.toGulpStreamSync('./test/my*')
.pipe(smartfile.fs.toGulpDestSync('./test/temp/'))
.pipe(gFunction(done, 'atEnd'))
})
})
describe('.toObjectSync()'.yellow, function () {
it('should read an ' + '.yaml'.blue + ' file to an object', function () {
let testData = smartfile.fs.toObjectSync('./test/mytest.yaml') let testData = smartfile.fs.toObjectSync('./test/mytest.yaml')
should(testData).have.property('key1', 'this works') expect(testData).have.property('key1', 'this works')
should(testData).have.property('key2', 'this works too') expect(testData).have.property('key2', 'this works too')
}) })
it('should state unknown file type for unknown file types', function () { it('should state unknown file type for unknown file types', function () {
let testData = smartfile.fs.toObjectSync('./test/mytest.txt') let testData = smartfile.fs.toObjectSync('./test/mytest.txt')
}) })
it('should read an ' + '.json'.blue + ' file to an object', function () { it('should read an ' + '.json' + ' file to an object', function () {
let testData = smartfile.fs.toObjectSync('./test/mytest.json') let testData = smartfile.fs.toObjectSync('./test/mytest.json')
should(testData).have.property('key1', 'this works') expect(testData).have.property('key1', 'this works')
should(testData).have.property('key2', 'this works too') expect(testData).have.property('key2', 'this works too')
}) })
}) })
describe('.toStringSync()'.yellow, function () { describe('.toStringSync()', function () {
it('should read a file to a string', function () { it('should read a file to a string', function () {
should.equal( expect(smartfile.fs.toStringSync('./test/mytest.txt'))
smartfile.fs.toStringSync('./test/mytest.txt'), .to.equal('Some TestString &&%$')
'Some TestString &&%$'
)
}) })
}) })
describe('.toVinylSync'.yellow, function () { describe('.toVinylSync', function () {
it('should read an ' + '.json OR .yaml'.blue + ' file to an ' + 'vinyl file object'.cyan, function () { it('should read an ' + '.json OR .yaml' + ' file to an ' + 'vinyl file object', function () {
let testData = smartfile.fs.toVinylSync('./test/mytest.json') let testData = smartfile.fs.toVinylSync('./test/mytest.json')
should(vinyl.isVinyl(testData)).be.true() expect(vinyl.isVinyl(testData)).to.be.true
}) })
}) })
}) })
@ -141,14 +149,13 @@ describe('smartfile'.yellow, function () {
it('should produce a valid gulp stream', function () { it('should produce a valid gulp stream', function () {
let localArray = ['test1', 'test2', 'test3'] let localArray = ['test1', 'test2', 'test3']
smartfile.memory.toGulpStream(localArray) smartfile.memory.toGulpStream(localArray)
.pipe(gulp.dest('./test/temp/'))
}) })
}) })
describe('toVinylFileSync()', function () { describe('toVinylFileSync()', function () {
it('should produce a vinylFile', function () { it('should produce a vinylFile', function () {
let localString = 'myString' let localString = 'myString'
let localOptions = { filename: 'vinylfile2', base: '/someDir' } let localOptions = { filename: 'vinylfile2', base: '/someDir' }
should(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).be.true() expect(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).to.be.true
}) })
}) })
describe('toVinylArraySync()', function () { describe('toVinylArraySync()', function () {
@ -156,21 +163,21 @@ describe('smartfile'.yellow, function () {
let localStringArray = ['string1', 'string2', 'string3'] let localStringArray = ['string1', 'string2', 'string3']
let localOptions = { filename: 'vinylfile2', base: '/someDir' } let localOptions = { filename: 'vinylfile2', base: '/someDir' }
let testResult = smartfile.memory.toVinylArraySync(localStringArray, localOptions) let testResult = smartfile.memory.toVinylArraySync(localStringArray, localOptions)
should(testResult).be.Array() expect(testResult).to.be.a('array')
should(testResult.length === 3).be.true() expect(testResult.length === 3).to.be.true
for (let myKey in testResult) { for (let myKey in testResult) {
should(testResult[myKey] instanceof vinyl).be.true() expect(testResult[myKey] instanceof vinyl).to.be.true
} }
}) })
}) })
describe('toStringSync()', function () { describe('vinylToStringSync()', function () {
it('should produce a String from vinyl file', function () { it('should produce a String from vinyl file', function () {
let localString = smartfile.memory.toStringSync(new vinyl({ let localString = smartfile.memory.vinylToStringSync(new vinyl({
base: '/', base: '/',
path: '/test.txt', path: '/test.txt',
contents: new Buffer('myString') contents: new Buffer('myString')
})) }))
should(localString).equal('myString') expect(localString).equal('myString')
}) })
}) })
describe('toFs()', function () { describe('toFs()', function () {
@ -194,33 +201,27 @@ describe('smartfile'.yellow, function () {
}) })
describe('.remote', function () { describe('.remote', function () {
describe('toGulpStreamSync()', function () {
it('should produce a gulp stream', function (done) {
this.timeout(5000)
smartfile.remote.toGulpStreamSync(
'mytest.txt', 'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/'
).pipe(smartfile.fs.toGulpDestSync('./test/temp/'))
.pipe(gFunction(done, 'atEnd'))
})
})
describe('.toString()', function () { describe('.toString()', function () {
it('should load a remote file to a variable', function (done) { it('should load a remote file to a variable', function (done) {
this.timeout(5000) this.timeout(5000)
smartfile.remote.toString( smartfile.remote.toString(
'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt' 'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt'
).then(function (responseString) { ).then(function (responseString) {
should.equal(responseString, 'Some TestString &&%$') expect(responseString).to.equal('Some TestString &&%$')
done() done()
}) })
}) })
it('should reject a Promise when the link is false', function (done) { it('should reject a Promise when the link is false', function (done) {
this.timeout(10000) this.timeout(10000)
smartfile.remote.toString('https://push.rocks/doesnotexist.txt') smartfile.remote.toString('https://push.rocks/doesnotexist.txt')
.then(function () { .then(
function () {
throw new Error('this test should not be resolved') throw new Error('this test should not be resolved')
}, function () { },
function () {
done() done()
}) }
)
}) })
}) })
}) })

View File

@ -30,7 +30,7 @@ export let fileExistsSync = function(filePath): boolean {
*/ */
export let fileExists = function(filePath){ export let fileExists = function(filePath){
let done = plugins.q.defer() let done = plugins.q.defer()
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) { plugins.fs.access(filePath, 4, function (err) {
err ? done.reject(err) : done.resolve() err ? done.reject(err) : done.resolve()
}) })
return done.promise return done.promise
@ -89,6 +89,27 @@ export let ensureDirSync = (dirPathArg: string) => {
plugins.fsExtra.ensureDirSync(dirPathArg) plugins.fsExtra.ensureDirSync(dirPathArg)
} }
/**
* ensure an empty directory
* @executes ASYNC
*/
export let ensureEmptyDir = (dirPathArg: string) => {
let done = plugins.q.defer()
plugins.fsExtra.ensureDir(dirPathArg,() => {
plugins.fsExtra.emptyDir(dirPathArg, done.resolve)
})
return done.promise
}
/**
* ensure an empty directory
* @executes SYNC
*/
export let ensureEmptyDirSync = (dirPathArg: string) => {
plugins.fsExtra.ensureDirSync(dirPathArg)
plugins.fsExtra.emptyDirSync(dirPathArg)
}
/** /**
* ensures that a file is on disk * ensures that a file is on disk
* @param filePath the filePath to ensureDir * @param filePath the filePath to ensureDir
@ -96,7 +117,7 @@ export let ensureDirSync = (dirPathArg: string) => {
* @returns Promise<void> * @returns Promise<void>
* @exec ASYNC * @exec ASYNC
*/ */
export let ensureFile = (filePathArg, initFileStringArg): plugins.q.Promise<void> => { export let ensureFile = (filePathArg, initFileStringArg): Promise<void> => {
let done = plugins.q.defer<void>() let done = plugins.q.defer<void>()
ensureFileSync(filePathArg, initFileStringArg) ensureFileSync(filePathArg, initFileStringArg)
done.resolve() done.resolve()
@ -121,8 +142,8 @@ export let ensureFileSync = (filePathArg: string, initFileStringArg: string): vo
/** /**
* removes a file or folder from local disk * removes a file or folder from local disk
*/ */
export let remove = function(pathArg: string){ export let remove = function(pathArg: string): Promise<void> {
let done = plugins.q.defer() let done = plugins.q.defer<void>()
plugins.fsExtra.remove(pathArg,function(){ plugins.fsExtra.remove(pathArg,function(){
done.resolve() done.resolve()
}) })
@ -137,24 +158,30 @@ export let removeSync = function(pathArg: string): boolean{
return true return true
} }
/**
* removes an array of filePaths from disk
*/
export let removeMany = function(filePathArrayArg: string[]){
let promiseArray: Promise<void>[] = []
for (let filePath of filePathArrayArg) {
promiseArray.push(remove(filePath))
}
return Promise.all(promiseArray)
}
/**
* like removeFilePathArray but SYNCHRONOUSLY
*/
export let removeManySync = function(filePathArrayArg: string[]): void {
for (let filePath of filePathArrayArg) {
removeSync(filePath)
}
}
/*=============================================================== /*===============================================================
============================ Write/Read ========================= ============================ Write/Read =========================
===============================================================*/ ===============================================================*/
/**
*
* @param filePathArg
* @returns {*}
*/
export let toGulpStreamSync = function(filePathArg: string){
let stream = plugins.gulp.src(filePathArg)
return stream
}
export let toGulpDestSync = function(folderPathArg: string){
return plugins.gulp.dest(folderPathArg)
}
/** /**
* *
* @param filePathArg * @param filePathArg
@ -270,7 +297,7 @@ export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): stri
* lists all items (folders AND files) in a directory on local disk * lists all items (folders AND files) in a directory on local disk
* @returns Promise<string[]> * @returns Promise<string[]>
*/ */
export let listAllItems = function(pathArg: string, regexFilter?: RegExp): plugins.q.Promise<string[]> { export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
let done = plugins.q.defer<string[]>() let done = plugins.q.defer<string[]>()
let allItmesArray = plugins.fsExtra.readdirSync(pathArg) let allItmesArray = plugins.fsExtra.readdirSync(pathArg)
if (regexFilter) { if (regexFilter) {
@ -301,10 +328,20 @@ export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): s
/** /**
* lists a file tree using a miniMatch filter * lists a file tree using a miniMatch filter
* note: if the miniMatch Filter is an absolute path, the cwdArg will be omitted
* @returns Promise<string[]> string array with the absolute paths of all matching files * @returns Promise<string[]> string array with the absolute paths of all matching files
*/ */
export let listFileTree = (dirPath: string, miniMatchFilter: string): plugins.q.Promise<string[]> => { export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise<string[]> => {
let done = plugins.q.defer<string[]>() let done = plugins.q.defer<string[]>()
// handle absolute miniMatchFilter
let dirPath: string
if (plugins.path.isAbsolute(miniMatchFilter)) {
dirPath = '/'
} else {
dirPath = dirPathArg
}
let options = { let options = {
cwd: dirPath cwd: dirPath
} }

View File

@ -2,9 +2,15 @@ import 'typings-global'
import plugins = require('./smartfile.plugins') import plugins = require('./smartfile.plugins')
import SmartfileInterpreter = require('./smartfile.interpreter') import SmartfileInterpreter = require('./smartfile.interpreter')
import vinyl = require('vinyl') let vinyl = require('vinyl')
let Readable = require('stream').Readable
export interface IVinylFile {
contents: Buffer
base: string
path: string,
}
let Readable = require('stream').Readable
/** /**
* allows you to create a gulp stream * allows you to create a gulp stream
@ -13,10 +19,10 @@ let Readable = require('stream').Readable
* @returns stream.Readable * @returns stream.Readable
* @TODO: make it async; * @TODO: make it async;
*/ */
export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugins.vinyl[],baseArg: string = '/'){ export let toGulpStream = function(fileArg: string|string[]|IVinylFile|IVinylFile[],baseArg: string = '/'){
let fileArray = [] let fileArray = []
if (typeof fileArg === 'string' || fileArg instanceof plugins.vinyl) { // make sure we work with an array later on if (typeof fileArg === 'string' || vinyl.isVinyl(fileArg)) { // make sure we work with an array later on
fileArray.push(fileArg) fileArray.push(fileArg)
} else if (Array.isArray(fileArg)) { } else if (Array.isArray(fileArg)) {
fileArray = fileArg fileArray = fileArg
@ -24,11 +30,11 @@ export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugin
throw new Error('fileArg has unknown format') throw new Error('fileArg has unknown format')
} }
let vinylFileArray: plugins.vinyl[] = [] // we want to have an array of vinylFiles let vinylFileArray: IVinylFile[] = [] // we want to have an array of vinylFiles
for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
let file = fileArray[fileIndexArg] let file = fileArray[fileIndexArg]
file instanceof plugins.vinyl ? file instanceof vinyl ?
vinylFileArray.push(file) : vinylFileArray.push(file) :
vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg})) vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
}; };
@ -57,25 +63,32 @@ export let toObject = function(fileStringArg: string,fileTypeArg: string){
* @param fileArg * @param fileArg
* @param optionsArg * @param optionsArg
*/ */
export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}){ export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}) {
optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'} optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile' optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
optionsArg.base ? void(0) : optionsArg.base = '/' optionsArg.base ? void(0) : optionsArg.base = '/'
optionsArg.relPath ? void('0') : optionsArg.relPath = '' optionsArg.relPath ? void('0') : optionsArg.relPath = ''
let vinylFile = new plugins.vinyl({ let vinylFile = new vinyl({
base: optionsArg.base, base: optionsArg.base,
path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename), path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
contents: new Buffer(fileArg) contents: new Buffer(fileArg)
}) })
return vinylFile return vinylFile
}; }
/** /**
* takes a string array and some options and returns a vinylfile array * takes a string array and some options and returns a vinylfile array
* @param arrayArg * @param arrayArg
* @param optionsArg * @param optionsArg
*/ */
export let toVinylArraySync = function(arrayArg: string[],optionsArg?: {filename?: string,base?: string,relPath?: string}){ export let toVinylArraySync = function(
arrayArg: string[],
optionsArg?: {
filename?: string,
base?: string,
relPath?: string
}
){
let vinylArray = [] let vinylArray = []
for (let stringIndexArg in arrayArg) { for (let stringIndexArg in arrayArg) {
let myString = arrayArg[stringIndexArg] let myString = arrayArg[stringIndexArg]
@ -84,14 +97,12 @@ export let toVinylArraySync = function(arrayArg: string[],optionsArg?: {filename
return vinylArray return vinylArray
} }
/** /**
* takes a vinylFile object and converts it to String * takes a vinylFile object and converts it to String
*/ */
export let toStringSync = function(fileArg: plugins.vinyl){ export let vinylToStringSync = function(fileArg: IVinylFile): string {
return fileArg.contents.toString('utf8') return fileArg.contents.toString('utf8')
}; }
/** /**
* writes string or vinyl file to disk. * writes string or vinyl file to disk.
@ -99,7 +110,7 @@ export let toStringSync = function(fileArg: plugins.vinyl){
* @param fileNameArg * @param fileNameArg
* @param fileBaseArg * @param fileBaseArg
*/ */
export let toFs = function(fileContentArg: string|vinyl,filePathArg){ export let toFs = function(fileContentArg: string|IVinylFile,filePathArg){
let done = plugins.q.defer() let done = plugins.q.defer()
// function checks to abort if needed // function checks to abort if needed
@ -109,9 +120,10 @@ export let toFs = function(fileContentArg: string|vinyl,filePathArg){
// prepare actual write action // prepare actual write action
let fileString: string let fileString: string
let filePath: string = filePathArg; let filePath: string = filePathArg
if (fileContentArg instanceof plugins.vinyl) { if (vinyl.isVinyl(fileContentArg)) {
fileString = toStringSync(fileContentArg) let fileContentArg2: any = fileContentArg
fileString = vinylToStringSync(fileContentArg2)
} else if (typeof fileContentArg === 'string') { } else if (typeof fileContentArg === 'string') {
fileString = fileContentArg fileString = fileContentArg
} }
@ -129,11 +141,10 @@ export let toFsSync = function(fileArg,filePathArg: string){
let fileString: string let fileString: string
let filePath: string = filePathArg let filePath: string = filePathArg
if (fileArg instanceof plugins.vinyl) { if (typeof fileArg !== 'string') {
fileString = toStringSync(fileArg) fileString = vinylToStringSync(fileArg)
} else if (typeof fileArg === 'string') { } else if (typeof fileArg === 'string') {
fileString = fileArg fileString = fileArg
} }
plugins.fsExtra.writeFileSync(filePath,fileString,'utf8') plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
} }

View File

@ -2,15 +2,11 @@ import 'typings-global'
export import beautylog = require('beautylog') export import beautylog = require('beautylog')
export import fs = require('fs') export import fs = require('fs')
export import fsExtra = require('fs-extra') export import fsExtra = require('fs-extra')
export let gulp = require('gulp')
export let glob = require('glob') export let glob = require('glob')
export let g = {
remoteSrc: require('gulp-remote-src')
}
export import path = require('path') export import path = require('path')
export import q = require('q') export import q = require('smartq')
export import vinyl = require('vinyl')
export let vinylFile = require('vinyl-file')
export let yaml = require('js-yaml')
export let request = require('request') export let request = require('request')
export let requireReload = require('require-reload') export let requireReload = require('require-reload')
export import smartpath = require('smartpath')
export let vinylFile = require('vinyl-file')
export let yaml = require('js-yaml')

View File

@ -11,18 +11,6 @@ export let toFs = function(from: string,toPath: string) {
return done.promise return done.promise
} }
/**
*
* @param filePathArg
* @returns {*}
*/
export let toGulpStreamSync = function(filePathArg: string,baseArg: string){
let stream = plugins.g.remoteSrc(filePathArg, {
base: baseArg
})
return stream
}
/** /**
* *
* @param fromArg * @param fromArg