Compare commits
17 Commits
Author | SHA1 | Date | |
---|---|---|---|
ff2e34696a | |||
23188dfe3f | |||
38f10e0d04 | |||
2e2b8351f8 | |||
8c386ee91c | |||
9828689f31 | |||
8205da5284 | |||
2fc132ab20 | |||
e948d08f2e | |||
4362e94a88 | |||
fea9675b2a | |||
4522907af3 | |||
163eb5a70c | |||
fa5371a6bd | |||
5ff7f8c3ac | |||
0c49bbd4b2 | |||
f2e2a22a57 |
36
.gitlab-ci.yml
Normal file
36
.gitlab-ci.yml
Normal file
@ -0,0 +1,36 @@
|
||||
image: hosttoday/ht-docker-node:npmts
|
||||
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test legacy
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
@ -2,13 +2,12 @@
|
||||
make files easily accessible for processing in javascript.
|
||||
|
||||
## Status
|
||||
[](https://travis-ci.org/pushrocks/smartfile)
|
||||
[](https://ci.appveyor.com/project/philkunz/smartfile/branch/master)
|
||||
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
||||
[](https://david-dm.org/pushrocks/smartfile)
|
||||
[](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/smartfile)
|
||||
[](https://codecov.io/github/pushrocks/smartfile?branch=master)
|
||||
|
||||
## Supported file types:
|
||||
* .yml .yaml
|
||||
* .json
|
||||
## Usage
|
||||
smartfile is an approach of being one tool to handle files in diverse environments.
|
||||
It can fetch files from remote locations, work with local disks and do pure memory operations.
|
65
dist/smartfile.fs.d.ts
vendored
65
dist/smartfile.fs.d.ts
vendored
@ -1,4 +1,32 @@
|
||||
import "typings-global";
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export declare let fileExistsSync: (filePath: any) => boolean;
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let fileExists: (filePath: any) => any;
|
||||
/**
|
||||
* Checks if given path points to an existing directory
|
||||
*/
|
||||
export declare let isDirectory: (pathArg: any) => boolean;
|
||||
/**
|
||||
* Checks if a given path points to an existing file
|
||||
*/
|
||||
export declare let isFile: (pathArg: any) => boolean;
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export declare let ensureDir: (dirPathArg: string) => any;
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export declare let ensureDirSync: (dirPathArg: string) => void;
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
@ -15,10 +43,6 @@ export declare let remove: (pathArg: string) => any;
|
||||
* removes a file SYNCHRONOUSLY from local disk
|
||||
*/
|
||||
export declare let removeSync: (pathArg: string) => boolean;
|
||||
export declare let toFS: (options: {
|
||||
from: string;
|
||||
toPath: string;
|
||||
}, cb?: any) => void;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
@ -54,23 +78,32 @@ export declare let toVinylSync: (filePathArg: any, options?: {}) => any;
|
||||
export declare let requireReload: (path: string) => any;
|
||||
/**
|
||||
* lists Folders in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let listFolders: (pathArg: string) => any;
|
||||
export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => any;
|
||||
/**
|
||||
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export declare let listFoldersSync: (pathArg: any) => any;
|
||||
export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
* lists Files in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let fileExistsSync: (filePath: any) => boolean;
|
||||
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => any;
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export declare let fileExists: (filePath: any) => any;
|
||||
export declare let isDirectory: (pathArg: any) => boolean;
|
||||
export declare let isFile: (pathArg: any) => boolean;
|
||||
export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => any;
|
||||
/**
|
||||
* lists all items (folders AND files) SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export declare let listAllItemsSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||
export declare let listFileTree: (dirPath: string, miniMatchFilter: string) => any;
|
||||
|
185
dist/smartfile.fs.js
vendored
185
dist/smartfile.fs.js
vendored
File diff suppressed because one or more lines are too long
17
dist/smartfile.memory.d.ts
vendored
17
dist/smartfile.memory.d.ts
vendored
@ -1,5 +1,4 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./smartfile.plugins");
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
|
||||
@ -7,7 +6,7 @@ import plugins = require("./smartfile.plugins");
|
||||
* @returns stream.Readable
|
||||
* @TODO: make it async;
|
||||
*/
|
||||
export declare let toGulpStream: (fileArg: string | string[] | plugins.vinyl | plugins.vinyl[], baseArg?: string) => any;
|
||||
export declare let toGulpStream: (fileArg: any, baseArg?: string) => any;
|
||||
/**
|
||||
* converts file to Object
|
||||
* @param fileStringArg
|
||||
@ -24,7 +23,7 @@ export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
|
||||
filename?: string;
|
||||
base?: string;
|
||||
relPath?: string;
|
||||
}) => plugins.vinyl;
|
||||
}) => any;
|
||||
/**
|
||||
* takes a string array and some options and returns a vinylfile array
|
||||
* @param arrayArg
|
||||
@ -38,18 +37,12 @@ export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
|
||||
/**
|
||||
* takes a vinylFile object and converts it to String
|
||||
*/
|
||||
export declare let toStringSync: (fileArg: plugins.vinyl) => string;
|
||||
export declare let toStringSync: (fileArg: any) => any;
|
||||
/**
|
||||
* writes string or vinyl file to disk.
|
||||
* @param fileArg
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export declare let toFs: (fileArg: any, optionsArg: {
|
||||
fileName: string;
|
||||
filePath: string;
|
||||
}) => any;
|
||||
export declare let toFsSync: (fileArg: any, optionsArg: {
|
||||
fileName: string;
|
||||
filePath: string;
|
||||
}) => void;
|
||||
export declare let toFs: (fileContentArg: any, filePathArg: any) => any;
|
||||
export declare let toFsSync: (fileArg: any, filePathArg: string) => void;
|
||||
|
30
dist/smartfile.memory.js
vendored
30
dist/smartfile.memory.js
vendored
File diff suppressed because one or more lines are too long
7
dist/smartfile.plugins.d.ts
vendored
7
dist/smartfile.plugins.d.ts
vendored
@ -1,13 +1,14 @@
|
||||
import "typings-global";
|
||||
export declare let beautylog: any;
|
||||
export import beautylog = require("beautylog");
|
||||
export declare let fs: any;
|
||||
export declare let gulp: any;
|
||||
export declare let glob: any;
|
||||
export declare let g: {
|
||||
remoteSrc: any;
|
||||
};
|
||||
export import path = require("path");
|
||||
export declare let path: any;
|
||||
export declare let q: any;
|
||||
export import vinyl = require("vinyl");
|
||||
export declare let vinyl: any;
|
||||
export declare let vinylFile: any;
|
||||
export declare let yaml: any;
|
||||
export declare let request: any;
|
||||
|
3
dist/smartfile.plugins.js
vendored
3
dist/smartfile.plugins.js
vendored
@ -3,6 +3,7 @@ require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.fs = require("fs-extra");
|
||||
exports.gulp = require("gulp");
|
||||
exports.glob = require("glob");
|
||||
exports.g = {
|
||||
remoteSrc: require("gulp-remote-src")
|
||||
};
|
||||
@ -14,4 +15,4 @@ exports.yaml = require("js-yaml");
|
||||
exports.request = require("request");
|
||||
exports.requireReload = require("require-reload");
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDYixpQkFBUyxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUNqQyxVQUFFLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0FBQ3pCLFlBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDdkIsU0FBQyxHQUFHO0lBQ1gsU0FBUyxFQUFFLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQztDQUN4QyxDQUFDO0FBQ1ksWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQzFCLFNBQUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDZCxhQUFLLFdBQVcsT0FBTyxDQUFDLENBQUM7QUFDNUIsaUJBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDbEMsWUFBSSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUMxQixlQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzdCLHFCQUFhLEdBQUcsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUMiLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgXCJ0eXBpbmdzLWdsb2JhbFwiO1xuZXhwb3J0IGxldCBiZWF1dHlsb2cgPSByZXF1aXJlKFwiYmVhdXR5bG9nXCIpO1xuZXhwb3J0IGxldCBmcyA9IHJlcXVpcmUoXCJmcy1leHRyYVwiKTtcbmV4cG9ydCBsZXQgZ3VscCA9IHJlcXVpcmUoXCJndWxwXCIpO1xuZXhwb3J0IGxldCBnID0ge1xuICAgIHJlbW90ZVNyYzogcmVxdWlyZShcImd1bHAtcmVtb3RlLXNyY1wiKVxufTtcbmV4cG9ydCBpbXBvcnQgcGF0aCA9IHJlcXVpcmUoXCJwYXRoXCIpO1xuZXhwb3J0IGxldCBxID0gcmVxdWlyZShcInFcIik7XG5leHBvcnQgaW1wb3J0IHZpbnlsID0gcmVxdWlyZShcInZpbnlsXCIpO1xuZXhwb3J0IGxldCB2aW55bEZpbGUgPSByZXF1aXJlKFwidmlueWwtZmlsZVwiKTtcbmV4cG9ydCBsZXQgeWFtbCA9IHJlcXVpcmUoXCJqcy15YW1sXCIpO1xuZXhwb3J0IGxldCByZXF1ZXN0ID0gcmVxdWlyZShcInJlcXVlc3RcIik7XG5leHBvcnQgbGV0IHJlcXVpcmVSZWxvYWQgPSByZXF1aXJlKFwicmVxdWlyZS1yZWxvYWRcIik7XG4iXX0=
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDVixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ3BDLFVBQUUsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7QUFDekIsWUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUN2QixZQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLFNBQUMsR0FBRztJQUNYLFNBQVMsRUFBRSxPQUFPLENBQUMsaUJBQWlCLENBQUM7Q0FDeEMsQ0FBQztBQUNTLFlBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDdkIsU0FBQyxHQUFHLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUNqQixhQUFLLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBQ3pCLGlCQUFTLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ2xDLFlBQUksR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDMUIsZUFBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUM3QixxQkFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDIiwiZmlsZSI6InNtYXJ0ZmlsZS5wbHVnaW5zLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIjtcbmV4cG9ydCBpbXBvcnQgYmVhdXR5bG9nID0gcmVxdWlyZShcImJlYXV0eWxvZ1wiKTtcbmV4cG9ydCBsZXQgZnMgPSByZXF1aXJlKFwiZnMtZXh0cmFcIik7XG5leHBvcnQgbGV0IGd1bHAgPSByZXF1aXJlKFwiZ3VscFwiKTtcbmV4cG9ydCBsZXQgZ2xvYiA9IHJlcXVpcmUoXCJnbG9iXCIpO1xuZXhwb3J0IGxldCBnID0ge1xuICAgIHJlbW90ZVNyYzogcmVxdWlyZShcImd1bHAtcmVtb3RlLXNyY1wiKVxufTtcbmV4cG9ydCBsZXQgcGF0aCA9IHJlcXVpcmUoXCJwYXRoXCIpO1xuZXhwb3J0IGxldCBxID0gcmVxdWlyZShcInFcIik7XG5leHBvcnQgbGV0IHZpbnlsID0gcmVxdWlyZShcInZpbnlsXCIpO1xuZXhwb3J0IGxldCB2aW55bEZpbGUgPSByZXF1aXJlKFwidmlueWwtZmlsZVwiKTtcbmV4cG9ydCBsZXQgeWFtbCA9IHJlcXVpcmUoXCJqcy15YW1sXCIpO1xuZXhwb3J0IGxldCByZXF1ZXN0ID0gcmVxdWlyZShcInJlcXVlc3RcIik7XG5leHBvcnQgbGV0IHJlcXVpcmVSZWxvYWQgPSByZXF1aXJlKFwicmVxdWlyZS1yZWxvYWRcIik7XG4iXX0=
|
||||
|
@ -1,5 +1,5 @@
|
||||
{
|
||||
"mode":"default",
|
||||
"codecov":true,
|
||||
"coverageTreshold":80
|
||||
"coverageTreshold":70
|
||||
}
|
13
package.json
13
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "smartfile",
|
||||
"version": "4.0.1",
|
||||
"version": "4.0.9",
|
||||
"description": "offers smart ways to work with files in nodejs",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
@ -13,7 +13,7 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/pushrocks/smartfile.git"
|
||||
"url": "https://gitlab.com/pushrocks/smartfile.git"
|
||||
},
|
||||
"keywords": [
|
||||
"filesystem",
|
||||
@ -22,19 +22,22 @@
|
||||
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/pushrocks/smartfile/issues"
|
||||
"url": "https://gitlab.com/pushrocks/smartfile/issues"
|
||||
},
|
||||
"homepage": "https://github.com/pushrocks/smartfile",
|
||||
"homepage": "https://gitlab.com/pushrocks/smartfile",
|
||||
"dependencies": {
|
||||
"@types/glob": "^5.0.22-alpha",
|
||||
"@types/gulp": "^3.8.22-alpha",
|
||||
"beautylog": "^5.0.12",
|
||||
"fs-extra": "^0.30.0",
|
||||
"glob": "^7.0.5",
|
||||
"gulp": "^3.9.1",
|
||||
"gulp-remote-src": "^0.4.1",
|
||||
"js-yaml": "^3.6.1",
|
||||
"q": "^1.4.1",
|
||||
"request": "^2.72.0",
|
||||
"require-reload": "0.2.2",
|
||||
"typings-global": "^1.0.3",
|
||||
"typings-global": "^1.0.5",
|
||||
"vinyl": "^1.1.1",
|
||||
"vinyl-file": "^2.0.0"
|
||||
},
|
||||
|
41
test/test.js
41
test/test.js
File diff suppressed because one or more lines are too long
42
test/test.ts
42
test/test.ts
@ -3,12 +3,11 @@ import * as smartfile from "../dist/index";
|
||||
let beautylog = require("beautylog");
|
||||
let gulp = require("gulp");
|
||||
let gFunction = require("gulp-function");
|
||||
import path = require("path");
|
||||
import should = require("should");
|
||||
let vinyl = require("vinyl");
|
||||
|
||||
describe("smartfile".yellow,function(){
|
||||
|
||||
|
||||
describe(".fs".yellow,function(){
|
||||
describe(".fileExistsSync".yellow,function(){
|
||||
it("should return an accurate boolean",function(){
|
||||
@ -39,6 +38,34 @@ describe("smartfile".yellow,function(){
|
||||
});
|
||||
});
|
||||
});
|
||||
describe(".listFilesSync()",function(){
|
||||
it("should get the file type from a string",function(){
|
||||
smartfile.fs.listFilesSync("./test/").should.containDeep([ "mytest.json"]);
|
||||
smartfile.fs.listFilesSync("./test/").should.not.containDeep([ "notExistentFile"]);
|
||||
smartfile.fs.listFilesSync("./test/",/mytest\.json/).should.containDeep([ "mytest.json"]);
|
||||
smartfile.fs.listFilesSync("./test/",/mytests.json/).should.not.containDeep([ "mytest.json"]);
|
||||
});
|
||||
});
|
||||
describe(".listFiles()",function(){
|
||||
it("should get the file type from a string",function(done){
|
||||
smartfile.fs.listFiles("./test/")
|
||||
.then(function(folderArrayArg){
|
||||
folderArrayArg.should.containDeep([ "mytest.json"]);
|
||||
folderArrayArg.should.not.containDeep([ "notExistentFile"]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
describe(".listFileTree()",function(){
|
||||
it("should get a file tree",function(done){
|
||||
smartfile.fs.listFileTree(path.resolve("./test/"),"**/*.txt")
|
||||
.then(function(folderArrayArg){
|
||||
folderArrayArg.should.containDeep([ "testfolder/testfile1.txt"]);
|
||||
folderArrayArg.should.not.containDeep([ "mytest.json"]);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
describe(".copy()".yellow,function(){
|
||||
it("should copy a directory",function(){
|
||||
smartfile.fs.copy("./test/testfolder/","./test/temp/")
|
||||
@ -153,10 +180,7 @@ describe("smartfile".yellow,function(){
|
||||
let localString = "myString";
|
||||
smartfile.memory.toFs(
|
||||
localString,
|
||||
{
|
||||
fileName:"./test/temp/testMemToFs.txt",
|
||||
filePath:process.cwd()
|
||||
}
|
||||
path.join(process.cwd(),"./test/temp/testMemToFs.txt")
|
||||
).then(done);
|
||||
});
|
||||
});
|
||||
@ -164,10 +188,8 @@ describe("smartfile".yellow,function(){
|
||||
it("should write a file to disk and return true if successfull",function(){
|
||||
let localString = "myString";
|
||||
smartfile.memory.toFsSync(
|
||||
localString,{
|
||||
fileName:"./test/temp/testMemToFsSync.txt",
|
||||
filePath:process.cwd()
|
||||
}
|
||||
localString,
|
||||
path.join(process.cwd(),"./test/temp/testMemToFsSync.txt")
|
||||
);
|
||||
});
|
||||
});
|
||||
|
@ -3,10 +3,74 @@ import "typings-global";
|
||||
import plugins = require("./smartfile.plugins");
|
||||
import SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
|
||||
/*===============================================================
|
||||
============================ Checks =============================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export let fileExistsSync = function(filePath):boolean {
|
||||
let fileExistsBool:boolean = false;
|
||||
try {
|
||||
plugins.fs.readFileSync(filePath);
|
||||
fileExistsBool = true
|
||||
}
|
||||
catch(err){
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
export let fileExists = function(filePath){
|
||||
let done = plugins.q.defer();
|
||||
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||
err ? done.reject() : done.resolve();
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* Checks if given path points to an existing directory
|
||||
*/
|
||||
export let isDirectory = function(pathArg):boolean{
|
||||
return plugins.fs.statSync(pathArg).isDirectory();
|
||||
};
|
||||
|
||||
/**
|
||||
* Checks if a given path points to an existing file
|
||||
*/
|
||||
export let isFile = function(pathArg):boolean{
|
||||
return plugins.fs.statSync(pathArg).isFile();
|
||||
};
|
||||
|
||||
/*===============================================================
|
||||
============================ FS ACTIONS =========================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export let ensureDir = (dirPathArg:string) => {
|
||||
let done = plugins.q.defer();
|
||||
plugins.fs.ensureDir(dirPathArg,done.resolve);
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export let ensureDirSync = (dirPathArg:string) => {
|
||||
plugins.fs.ensureDirSync(dirPathArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
@ -50,11 +114,6 @@ export let removeSync = function(pathArg:string):boolean{
|
||||
============================ Write/Read =========================
|
||||
===============================================================*/
|
||||
|
||||
|
||||
export let toFS = function(options:{from:string,toPath:string}, cb=undefined){
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
@ -114,59 +173,116 @@ export let requireReload = function(path:string){
|
||||
|
||||
/**
|
||||
* lists Folders in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listFolders = function(pathArg:string){
|
||||
export let listFolders = function(pathArg:string,regexFilter?:RegExp){
|
||||
let done = plugins.q.defer();
|
||||
let folderArray = plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory();
|
||||
});
|
||||
if(regexFilter){
|
||||
folderArray = folderArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
}
|
||||
done.resolve(folderArray);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export let listFoldersSync = function(pathArg){
|
||||
return plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
export let listFoldersSync = function(pathArg:string,regexFilter?:RegExp):string[]{
|
||||
let folderArray = plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory();
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export let fileExistsSync = function(filePath):boolean {
|
||||
let fileExistsBool:boolean = false;
|
||||
try {
|
||||
plugins.fs.readFileSync(filePath);
|
||||
fileExistsBool = true
|
||||
}
|
||||
catch(err){
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
export let fileExists = function(filePath){
|
||||
let done = plugins.q.defer();
|
||||
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||
err ? done.reject() : done.resolve();
|
||||
if(regexFilter){
|
||||
folderArray = folderArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
};
|
||||
return folderArray;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* lists Files in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listFiles = function(pathArg:string, regexFilter?:RegExp){
|
||||
let done = plugins.q.defer();
|
||||
let fileArray = plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||
});
|
||||
if(regexFilter){
|
||||
fileArray = fileArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
};
|
||||
done.resolve(fileArray);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
export let isDirectory = function(pathArg):boolean{
|
||||
return plugins.fs.statSync(pathArg).isDirectory();
|
||||
/**
|
||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export let listFilesSync = function(pathArg:string, regexFilter?:RegExp):string[]{
|
||||
let fileArray = plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||
});
|
||||
if(regexFilter){
|
||||
fileArray = fileArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
};
|
||||
return fileArray;
|
||||
};
|
||||
|
||||
export let isFile = function(pathArg):boolean{
|
||||
return plugins.fs.statSync(pathArg).isFile();
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listAllItems = function(pathArg:string, regexFilter?:RegExp){
|
||||
let done = plugins.q.defer();
|
||||
let allItmesArray = plugins.fs.readdirSync(pathArg);
|
||||
if(regexFilter){
|
||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
};
|
||||
done.resolve(allItmesArray);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* lists all items (folders AND files) SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export let listAllItemsSync = function(pathArg:string, regexFilter?:RegExp):string[]{
|
||||
let allItmesArray = plugins.fs.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||
});
|
||||
if(regexFilter){
|
||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
};
|
||||
return allItmesArray;
|
||||
};
|
||||
|
||||
export let listFileTree = (dirPath:string, miniMatchFilter:string) => {
|
||||
let done = plugins.q.defer();
|
||||
let options = {
|
||||
cwd:dirPath
|
||||
}
|
||||
plugins.glob(miniMatchFilter,options,(err,files:string[]) => {
|
||||
if(err){
|
||||
console.log(err);
|
||||
done.reject();
|
||||
};
|
||||
done.resolve(files);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
@ -2,6 +2,7 @@ import "typings-global";
|
||||
|
||||
import plugins = require("./smartfile.plugins");
|
||||
import SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
import vinyl = require("vinyl");
|
||||
let Readable = require("stream").Readable;
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
@ -96,33 +97,31 @@ export let toStringSync = function(fileArg:plugins.vinyl){
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export let toFs = function(fileArg,optionsArg:{fileName:string,filePath:string}){
|
||||
export let toFs = function(fileContentArg:string|vinyl,filePathArg){
|
||||
let done = plugins.q.defer();
|
||||
|
||||
//function checks to abort if needed
|
||||
if (!fileArg || !optionsArg || !(typeof optionsArg.fileName === "string"))
|
||||
throw new Error("expected a valid arguments");
|
||||
if (!(typeof optionsArg.filePath === "string")) optionsArg.filePath = "/";
|
||||
if (!fileContentArg || !filePathArg) throw new Error("expected valid arguments");
|
||||
|
||||
let filePath:string = plugins.path.join(optionsArg.filePath,optionsArg.fileName);
|
||||
// prepare actual write action
|
||||
let fileString:string;
|
||||
if (fileArg instanceof plugins.vinyl){
|
||||
fileString = toStringSync(fileArg);
|
||||
} else if (typeof fileArg === "string") {
|
||||
fileString = fileArg;
|
||||
let filePath:string = filePathArg;
|
||||
if (fileContentArg instanceof plugins.vinyl){
|
||||
fileString = toStringSync(fileContentArg);
|
||||
} else if (typeof fileContentArg === "string") {
|
||||
fileString = fileContentArg;
|
||||
}
|
||||
plugins.fs.writeFile(filePath,fileString,"utf8",done.resolve);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
export let toFsSync = function(fileArg,optionsArg:{fileName:string,filePath:string}){
|
||||
export let toFsSync = function(fileArg,filePathArg:string){
|
||||
//function checks to abort if needed
|
||||
if (!fileArg || !optionsArg || !(typeof optionsArg.fileName === "string"))
|
||||
throw new Error("expected a valid arguments");
|
||||
if (!(typeof optionsArg.filePath === "string")) optionsArg.filePath = "/";
|
||||
if (!fileArg || !filePathArg) throw new Error("expected a valid arguments");
|
||||
|
||||
let filePath = plugins.path.join(optionsArg.filePath,optionsArg.fileName);
|
||||
// prepare actual write action
|
||||
let fileString:string;
|
||||
let filePath:string = filePathArg;
|
||||
|
||||
if (fileArg instanceof plugins.vinyl){
|
||||
fileString = toStringSync(fileArg);
|
||||
|
@ -1,13 +1,14 @@
|
||||
import "typings-global";
|
||||
export let beautylog = require("beautylog");
|
||||
export import beautylog = require("beautylog");
|
||||
export let fs = require("fs-extra");
|
||||
export let gulp = require("gulp");
|
||||
export let glob = require("glob");
|
||||
export let g = {
|
||||
remoteSrc: require("gulp-remote-src")
|
||||
};
|
||||
export import path = require("path");
|
||||
export let path = require("path");
|
||||
export let q = require("q");
|
||||
export import vinyl = require("vinyl");
|
||||
export let vinyl = require("vinyl");
|
||||
export let vinylFile = require("vinyl-file");
|
||||
export let yaml = require("js-yaml");
|
||||
export let request = require("request");
|
||||
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"globalDependencies": {
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts",
|
||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
||||
"node": "registry:dt/node",
|
||||
"should": "registry:dt/should"
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user