Compare commits

..

50 Commits

Author SHA1 Message Date
f753c2c491 4.1.5 2017-02-05 15:47:48 +01:00
4ecb817bac update README 2017-02-05 15:47:08 +01:00
909fcd6e2a improve README 2017-02-03 15:14:30 +01:00
d1538f939d 4.1.4 2017-01-21 12:11:46 +01:00
3fef2a4ab9 remove beautylog dependency 2017-01-21 12:11:22 +01:00
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
1fdd492eff 4.0.21 2016-09-24 21:42:49 +02:00
38354d2944 add ensureFile and ensureFileSync 2016-09-24 21:42:45 +02:00
760913bad3 4.0.20 2016-09-20 17:56:52 +02:00
f7b8fe5498 now adhering to standard js 2016-09-20 17:56:49 +02:00
37fbf9a409 update 2016-09-20 12:20:46 +02:00
49aba4c85f 4.0.19 2016-09-18 20:09:32 +02:00
37d81fa4c6 improve README 2016-09-18 20:09:17 +02:00
0256166c2f 4.0.18 2016-09-18 12:26:59 +02:00
bef2bd6b3a add vinyl typings 2016-09-18 12:26:43 +02:00
759e1655da 4.0.17 2016-09-17 23:11:58 +02:00
d732d1ba97 4.0.16 2016-09-17 23:11:44 +02:00
eeab2cf0cd 4.0.15 2016-09-02 16:31:50 +02:00
ab76cae75e update 2016-09-02 16:31:39 +02:00
f39daca6aa 4.0.13 2016-08-03 12:25:37 +02:00
e70db71ec4 update type versions 2016-08-03 12:25:15 +02:00
50ef41d5d4 add npm_registry environment 2016-07-20 02:34:14 +02:00
2a417ba18f add npmdocker section to npmextra.json 2016-07-20 02:32:02 +02:00
3516189940 update test js 2016-07-20 02:27:05 +02:00
10e3628a89 4.0.12 2016-07-19 20:28:33 +02:00
86eafe4568 update typings 2016-07-19 20:28:28 +02:00
fddde78b92 4.0.11 2016-07-17 17:36:43 +02:00
2a365b04a6 switched to npmextra for npmts config 2016-07-17 17:36:38 +02:00
df1d82cb7c switched to ES6 and updated deps 2016-07-17 17:34:15 +02:00
d20742f881 fix some things 2016-07-01 06:07:58 +02:00
db2a0c2992 4.0.10 2016-07-01 05:14:37 +02:00
7d806f313b remove @types/gulp 2016-07-01 05:14:16 +02:00
ff2e34696a 4.0.9 2016-07-01 01:38:57 +02:00
23188dfe3f now has fileTree function 2016-07-01 01:37:48 +02:00
38f10e0d04 4.0.8 2016-06-28 10:00:03 +02:00
2e2b8351f8 fix regex filter 2016-06-28 09:59:59 +02:00
8c386ee91c remove tyings.json 2016-06-28 08:48:47 +02:00
33 changed files with 1191 additions and 952 deletions

9
.gitignore vendored
View File

@ -1,12 +1,7 @@
node_modules/ node_modules/
.settings/
.idea/
coverage/ coverage/
docs/ pages/
public/
ts/*.js
ts/*.js.map
ts/typings/
test/temp/ test/temp/

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
@ -33,4 +35,25 @@ release:
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,15 +0,0 @@
language: node_js
node_js:
- 4
- stable
deploy:
provider: npm
email: npm@lossless.digital
api_key:
secure: wIOQHE7Jbck2j5lcv1Rc8T9/1wbHNGLxqJ6pttNZ+hG1+w77TYnjNYuGtM2xQCXitXSFDoogU8MpiYieOQHYypFgJ6Ns8MTeKIzNJSnlOWdCSN/lVptscT8pyC6qD4IBAyi8m5F2HoGQR+IzcdDBPjXLaPbH7jn8hc9rNY+LNktmYOXfOr37P40pxYrf16GLwrkjQIK8pbkdIbNA0D0k3apTGqw+HsneN2D/O/zAYaB3ojm40ttgPAGYF5PO5t6uqIbPFgIPkMWsO1HbV6I+vOAuIf0KYUqnR/YZd5yFcxFt3c+bfyc8/LP4vy5FyKMLXHe4IXIjXPYetOSiVHgMMYaxawU51OqwIKO+87FJ1TdaVmacMFO0wagl2QS0ceQBn8KBUhljHu/fDInK82uy15Iddk44EhnTx1MIxxgH5WMM6aQB2vuqnViPghs4nA0Y/Dz2U69267fhvmZvEWWUndz058EksHdZsIt5WCqQErI/dWLXMGom94CuZv6nkoVHCw8CO5dqVvfqUFL7Qyw59kRbiUPItFVoiV8ptLUX9tnQ5xBukNRkFX34ViM9YvBRlGt5e//f+cWjUpXFvbrwkqusXArplpxIaUSsQKh7XaMB5DcZ5jDDdjKzIMDf6QWsMTU1rjfQS5ZS3eV5LPy0UlfpDGK28oK2/o8fM+yydVk=
on:
tags: true
repo: pushrocks/smartfile
notifications:
slack:
secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

View File

@ -1,13 +1,38 @@
# smartfile # smartfile
make files easily accessible for processing in javascript. make files easily accessible for processing in javascript.
## Status ## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfile)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfile)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfile/)
## Status for master
[![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfile/commits/master) [![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartfile/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
[![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile) [![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile) [![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile)
[![codecov.io](https://codecov.io/github/pushrocks/smartfile/coverage.svg?branch=master)](https://codecov.io/github/pushrocks/smartfile?branch=master) [![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage ## Usage
smartfile is an approach of being one tool to handle files in diverse environments. 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.
### Smartfile Sections
smartfile thinks in sections:
section | description
--- | ---
fs | (object) gets data from fs to somewhere
memory | gets data from memory to somewhere
remote | gets data from remote locations to somewhere
interpreter | (object) handles yaml and json
smartfile | (class) a virtual representation of a file, alternative to vinyl file format
For further information read the linked docs at the top of this README.
> MIT licensed | **©** 2016 - 2017 [Lossless GmbH](https://lossless.gmbh)
[![npm](https://pushrocks.gitlab.io/assets/repo-header.svg)](https://push.rocks)

View File

@ -1,10 +0,0 @@
environment:
nodejs_version: "4"
install:
- ps: Install-Product node $env:nodejs_version
- npm install
test_script:
- node --version
- npm --version
- npm test
build: off

12
dist/index.d.ts vendored
View File

@ -1,9 +1,9 @@
import "typings-global"; import 'typings-global';
import * as SmartfileFs from "./smartfile.fs"; import * as SmartfileFs from './smartfile.fs';
import * as SmartfileInterpreter from "./smartfile.interpreter"; import * as SmartfileInterpreter from './smartfile.interpreter';
import * as SmartfileMemory from "./smartfile.memory"; import * as SmartfileMemory from './smartfile.memory';
import * as SmartfileRemote from "./smartfile.remote"; import * as SmartfileRemote from './smartfile.remote';
export { Smartfile } from "./smartfile.classes.smartfile"; export { Smartfile } from './smartfile.classes.smartfile';
export declare let fs: typeof SmartfileFs; export declare let fs: typeof SmartfileFs;
export declare let interpreter: typeof SmartfileInterpreter; export declare let interpreter: typeof SmartfileInterpreter;
export declare let memory: typeof SmartfileMemory; export declare let memory: typeof SmartfileMemory;

11
dist/index.js vendored
View File

@ -1,9 +1,9 @@
"use strict"; "use strict";
require("typings-global"); require("typings-global");
var SmartfileFs = require("./smartfile.fs"); const SmartfileFs = require("./smartfile.fs");
var SmartfileInterpreter = require("./smartfile.interpreter"); const SmartfileInterpreter = require("./smartfile.interpreter");
var SmartfileMemory = require("./smartfile.memory"); const SmartfileMemory = require("./smartfile.memory");
var SmartfileRemote = require("./smartfile.remote"); const SmartfileRemote = require("./smartfile.remote");
var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile"); var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
exports.Smartfile = smartfile_classes_smartfile_1.Smartfile; exports.Smartfile = smartfile_classes_smartfile_1.Smartfile;
exports.fs = SmartfileFs; exports.fs = SmartfileFs;
@ -11,5 +11,4 @@ exports.interpreter = SmartfileInterpreter;
exports.memory = SmartfileMemory; exports.memory = SmartfileMemory;
exports.remote = SmartfileRemote; exports.remote = SmartfileRemote;
exports.requireReload = SmartfileFs.requireReload; exports.requireReload = SmartfileFs.requireReload;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBR3ZCLDhDQUE2QztBQUM3QyxnRUFBK0Q7QUFDL0Qsc0RBQXFEO0FBQ3JELHNEQUFxRDtBQUVyRCw2RUFBdUQ7QUFBL0Msa0RBQUEsU0FBUyxDQUFBO0FBRU4sUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFBO0FBQ2hCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFBO0FBQ2xDLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQTtBQUN4QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUE7QUFDeEIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQSJ9
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFHeEIsSUFBWSxXQUFXLFdBQU0sZ0JBQWdCLENBQUMsQ0FBQTtBQUM5QyxJQUFZLG9CQUFvQixXQUFNLHlCQUN0QyxDQUFDLENBRDhEO0FBQy9ELElBQVksZUFBZSxXQUFNLG9CQUFvQixDQUFDLENBQUE7QUFDdEQsSUFBWSxlQUFlLFdBQU0sb0JBQW9CLENBQUMsQ0FBQTtBQUV0RCw0Q0FBd0IsK0JBQStCLENBQUM7QUFBaEQsNERBQWdEO0FBRTdDLFVBQUUsR0FBRyxXQUFXLENBQUM7QUFDakIsbUJBQVcsR0FBRyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFNLEdBQUcsZUFBZSxDQUFDO0FBQ3pCLGNBQU0sR0FBRyxlQUFlLENBQUM7QUFDekIscUJBQWEsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIjtcblxuaW1wb3J0ICogYXMgcGx1Z2lucyBmcm9tIFwiLi9zbWFydGZpbGUucGx1Z2luc1wiO1xuaW1wb3J0ICogYXMgU21hcnRmaWxlRnMgZnJvbSBcIi4vc21hcnRmaWxlLmZzXCI7XG5pbXBvcnQgKiBhcyBTbWFydGZpbGVJbnRlcnByZXRlciBmcm9tIFwiLi9zbWFydGZpbGUuaW50ZXJwcmV0ZXJcIiBcbmltcG9ydCAqIGFzIFNtYXJ0ZmlsZU1lbW9yeSBmcm9tIFwiLi9zbWFydGZpbGUubWVtb3J5XCI7XG5pbXBvcnQgKiBhcyBTbWFydGZpbGVSZW1vdGUgZnJvbSBcIi4vc21hcnRmaWxlLnJlbW90ZVwiO1xuXG5leHBvcnQge1NtYXJ0ZmlsZX0gZnJvbSBcIi4vc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlXCI7XG5cbmV4cG9ydCBsZXQgZnMgPSBTbWFydGZpbGVGcztcbmV4cG9ydCBsZXQgaW50ZXJwcmV0ZXIgPSBTbWFydGZpbGVJbnRlcnByZXRlcjtcbmV4cG9ydCBsZXQgbWVtb3J5ID0gU21hcnRmaWxlTWVtb3J5O1xuZXhwb3J0IGxldCByZW1vdGUgPSBTbWFydGZpbGVSZW1vdGU7XG5leHBvcnQgbGV0IHJlcXVpcmVSZWxvYWQgPSBTbWFydGZpbGVGcy5yZXF1aXJlUmVsb2FkO1xuIl19

View File

@ -1,10 +1,7 @@
"use strict"; "use strict";
var Smartfile = (function () { class Smartfile {
function Smartfile() { constructor() {
} }
; }
return Smartfile;
}());
exports.Smartfile = Smartfile; exports.Smartfile = Smartfile;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtJQUNJO0lBRUEsQ0FBQztDQUNKO0FBSkQsOEJBSUMifQ==
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5jbGFzc2VzLnNtYXJ0ZmlsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUE7SUFDSTtJQUVBLENBQUM7O0lBQ0wsZ0JBQUM7QUFBRCxDQUpBLEFBSUMsSUFBQTtBQUpZLGlCQUFTLFlBSXJCLENBQUEiLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGNsYXNzIFNtYXJ0ZmlsZSB7XG4gICAgY29uc3RydWN0b3IoKXtcbiAgICAgICAgXG4gICAgfTtcbn0iXX0=

View File

@ -1,4 +1,4 @@
import "typings-global"; import 'typings-global';
/** /**
* *
* @param filePath * @param filePath
@ -10,7 +10,7 @@ export declare let fileExistsSync: (filePath: any) => boolean;
* @param filePath * @param filePath
* @returns {any} * @returns {any}
*/ */
export declare let fileExists: (filePath: any) => any; 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
*/ */
@ -19,37 +19,64 @@ export declare let isDirectory: (pathArg: any) => boolean;
* Checks if a given path points to an existing file * Checks if a given path points to an existing file
*/ */
export declare let isFile: (pathArg: any) => boolean; 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 * copies a file from A to B on the local disk
*/ */
export declare let copy: (fromArg: string, toArg: string) => any; 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
*/ */
export declare let copySync: (fromArg: string, toArg: string) => boolean; export declare let copySync: (fromArg: string, toArg: string) => boolean;
/**
* ensures that a directory is in place
*/
export declare let ensureDir: (dirPathArg: string) => Promise<{}>;
/**
* ensures that a directory is in place
*/
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
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec ASYNC
*/
export declare let ensureFile: (filePathArg: any, initFileStringArg: any) => Promise<void>;
/**
* ensures that a file is on disk
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec SYNC
*/
export declare let ensureFileSync: (filePathArg: string, initFileStringArg: string) => void;
/** /**
* removes a file or folder from local disk * removes a file or folder from local disk
*/ */
export declare let remove: (pathArg: string) => any; 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
@ -80,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) => any; 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
@ -90,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) => any; 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
@ -98,11 +125,18 @@ export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => any;
export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => string[]; export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => 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 Promise * @returns Promise<string[]>
*/ */
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => any; export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => Promise<string[]>;
/** /**
* lists all items (folders AND files) SYNCHRONOUSLY 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
* @executes SYNC
*/ */
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
* 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
*/
export declare let listFileTree: (dirPathArg: string, miniMatchFilter: string) => Promise<string[]>;

242
dist/smartfile.fs.js vendored

File diff suppressed because one or more lines are too long

View File

@ -1,3 +1,3 @@
import "typings-global"; import 'typings-global';
export declare let filetype: (pathArg: string) => string; export declare let filetype: (pathArg: string) => string;
export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any; export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any;

View File

@ -1,22 +1,21 @@
"use strict"; "use strict";
require("typings-global"); require("typings-global");
var plugins = require("./smartfile.plugins"); const plugins = require("./smartfile.plugins");
exports.filetype = function (pathArg) { exports.filetype = (pathArg) => {
var extName = plugins.path.extname(pathArg); let extName = plugins.path.extname(pathArg);
var fileType = extName.replace(/\.([a-z]*)/, "$1"); //remove . form fileType let fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
return fileType; return fileType;
}; };
exports.objectFile = function (fileStringArg, fileTypeArg) { exports.objectFile = (fileStringArg, fileTypeArg) => {
switch (fileTypeArg) { switch (fileTypeArg) {
case "yml": case 'yml':
case "yaml": case 'yaml':
return plugins.yaml.safeLoad(fileStringArg); return plugins.yaml.safeLoad(fileStringArg);
case "json": case 'json':
return JSON.parse(fileStringArg); return JSON.parse(fileStringArg);
default: default:
plugins.beautylog.error("file type " + fileTypeArg.blue + " not supported"); console.error('file type ' + fileTypeArg.blue + ' not supported');
break; break;
} }
}; };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBdUI7QUFFdkIsK0NBQStDO0FBRXBDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZTtJQUNsQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUMzQyxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBQyxJQUFJLENBQUMsQ0FBQSxDQUFDLHlCQUF5QjtJQUMzRSxNQUFNLENBQUMsUUFBUSxDQUFBO0FBQ25CLENBQUMsQ0FBQTtBQUVVLFFBQUEsVUFBVSxHQUFHLENBQUMsYUFBcUIsRUFBRSxXQUFXO0lBQ3ZELE1BQU0sQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7UUFDbEIsS0FBSyxLQUFLLENBQUU7UUFDWixLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDL0MsS0FBSyxNQUFNO1lBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDcEM7WUFDSSxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUE7WUFDakUsS0FBSyxDQUFBO0lBQ2IsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5pbnRlcnByZXRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBRXhCLElBQU8sT0FBTyxXQUFXLHFCQUFxQixDQUFDLENBQUM7QUFFckMsZ0JBQVEsR0FBRyxVQUFDLE9BQWM7SUFDakMsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDNUMsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyx3QkFBd0I7SUFDM0UsTUFBTSxDQUFDLFFBQVEsQ0FBQztBQUNwQixDQUFDLENBQUM7QUFFUyxrQkFBVSxHQUFHLFVBQUMsYUFBb0IsRUFBRSxXQUFXO0lBQ3RELE1BQU0sQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7UUFDbEIsS0FBSyxLQUFLLENBQUU7UUFDWixLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDaEQsS0FBSyxNQUFNO1lBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDckM7WUFDSSxPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxZQUFZLEdBQUcsV0FBVyxDQUFDLElBQUksR0FBRyxnQkFBZ0IsQ0FBQyxDQUFDO1lBQzVFLEtBQUssQ0FBQztJQUNkLENBQUM7QUFDTCxDQUFDLENBQUEiLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIjtcblxuaW1wb3J0IHBsdWdpbnMgPSByZXF1aXJlKFwiLi9zbWFydGZpbGUucGx1Z2luc1wiKTtcblxuZXhwb3J0IGxldCBmaWxldHlwZSA9IChwYXRoQXJnOnN0cmluZyk6c3RyaW5nID0+IHtcbiAgICBsZXQgZXh0TmFtZSA9IHBsdWdpbnMucGF0aC5leHRuYW1lKHBhdGhBcmcpO1xuICAgIGxldCBmaWxlVHlwZSA9IGV4dE5hbWUucmVwbGFjZSgvXFwuKFthLXpdKikvLFwiJDFcIik7IC8vcmVtb3ZlIC4gZm9ybSBmaWxlVHlwZVxuICAgIHJldHVybiBmaWxlVHlwZTtcbn07XG5cbmV4cG9ydCBsZXQgb2JqZWN0RmlsZSA9IChmaWxlU3RyaW5nQXJnOnN0cmluZywgZmlsZVR5cGVBcmcpID0+IHtcbiAgICBzd2l0Y2ggKGZpbGVUeXBlQXJnKSB7XG4gICAgICAgIGNhc2UgXCJ5bWxcIiA6XG4gICAgICAgIGNhc2UgXCJ5YW1sXCI6XG4gICAgICAgICAgICByZXR1cm4gcGx1Z2lucy55YW1sLnNhZmVMb2FkKGZpbGVTdHJpbmdBcmcpO1xuICAgICAgICBjYXNlIFwianNvblwiOlxuICAgICAgICAgICAgcmV0dXJuIEpTT04ucGFyc2UoZmlsZVN0cmluZ0FyZyk7XG4gICAgICAgIGRlZmF1bHQ6XG4gICAgICAgICAgICBwbHVnaW5zLmJlYXV0eWxvZy5lcnJvcihcImZpbGUgdHlwZSBcIiArIGZpbGVUeXBlQXJnLmJsdWUgKyBcIiBub3Qgc3VwcG9ydGVkXCIpO1xuICAgICAgICAgICAgYnJlYWs7XG4gICAgfVxufSJdfQ==

View File

@ -1,5 +1,10 @@
import "typings-global"; /// <reference types="node" />
import plugins = require("./smartfile.plugins"); import 'typings-global';
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
@ -7,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
@ -24,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
@ -38,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) => string; 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) => any; 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

@ -1,14 +1,11 @@
import "typings-global"; import 'typings-global';
export declare let beautylog: any; export import fs = require('fs');
export declare let fs: any; export import fsExtra = require('fs-extra');
export declare let gulp: any; export declare let glob: any;
export declare let g: { export import path = require('path');
remoteSrc: any; export import q = require('smartq');
};
export import path = require("path");
export declare let q: any;
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

@ -1,17 +1,13 @@
"use strict"; "use strict";
require("typings-global"); require("typings-global");
exports.beautylog = require("beautylog"); exports.fs = require("fs");
exports.fs = require("fs-extra"); exports.fsExtra = require("fs-extra");
exports.gulp = require("gulp"); 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.request = require('request');
exports.vinylFile = require("vinyl-file"); exports.requireReload = require('require-reload');
exports.yaml = require("js-yaml"); exports.smartpath = require("smartpath");
exports.request = require("request"); exports.vinylFile = require('vinyl-file');
exports.requireReload = require("require-reload"); exports.yaml = require('js-yaml');
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLDJCQUFnQztBQUNoQyxzQ0FBMkM7QUFDaEMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0FBQ2pDLCtCQUFvQztBQUNwQyw4QkFBbUM7QUFDeEIsUUFBQSxPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBQzVCLFFBQUEsYUFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ3BELHlDQUE4QztBQUNuQyxRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBIn0=
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDYixpQkFBUyxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUNqQyxVQUFFLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0FBQ3pCLFlBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDdkIsU0FBQyxHQUFHO0lBQ1gsU0FBUyxFQUFFLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQztDQUN4QyxDQUFDO0FBQ1ksWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQzFCLFNBQUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDZCxhQUFLLFdBQVcsT0FBTyxDQUFDLENBQUM7QUFDNUIsaUJBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDbEMsWUFBSSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUMxQixlQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzdCLHFCQUFhLEdBQUcsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUMiLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgXCJ0eXBpbmdzLWdsb2JhbFwiO1xuZXhwb3J0IGxldCBiZWF1dHlsb2cgPSByZXF1aXJlKFwiYmVhdXR5bG9nXCIpO1xuZXhwb3J0IGxldCBmcyA9IHJlcXVpcmUoXCJmcy1leHRyYVwiKTtcbmV4cG9ydCBsZXQgZ3VscCA9IHJlcXVpcmUoXCJndWxwXCIpO1xuZXhwb3J0IGxldCBnID0ge1xuICAgIHJlbW90ZVNyYzogcmVxdWlyZShcImd1bHAtcmVtb3RlLXNyY1wiKVxufTtcbmV4cG9ydCBpbXBvcnQgcGF0aCA9IHJlcXVpcmUoXCJwYXRoXCIpO1xuZXhwb3J0IGxldCBxID0gcmVxdWlyZShcInFcIik7XG5leHBvcnQgaW1wb3J0IHZpbnlsID0gcmVxdWlyZShcInZpbnlsXCIpO1xuZXhwb3J0IGxldCB2aW55bEZpbGUgPSByZXF1aXJlKFwidmlueWwtZmlsZVwiKTtcbmV4cG9ydCBsZXQgeWFtbCA9IHJlcXVpcmUoXCJqcy15YW1sXCIpO1xuZXhwb3J0IGxldCByZXF1ZXN0ID0gcmVxdWlyZShcInJlcXVlc3RcIik7XG5leHBvcnQgbGV0IHJlcXVpcmVSZWxvYWQgPSByZXF1aXJlKFwicmVxdWlyZS1yZWxvYWRcIik7XG4iXX0=

View File

@ -1,20 +1,14 @@
import "typings-global"; import 'typings-global';
export declare let toFs: (from: string, toPath: string) => any; export declare let toFs: (from: string, toPath: string) => 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) => any; export declare let toObject: (fromArg: string) => Promise<{}>;
/** /**
* *
* @param fromArg * @param fromArg
* @returns {any} * @returns {any}
*/ */
export declare let toString: (fromArg: string) => any; export declare let toString: (fromArg: string) => Promise<{}>;

File diff suppressed because one or more lines are too long

9
npmextra.json Normal file
View File

@ -0,0 +1,9 @@
{
"npmts":{
"mode":"default",
"coverageTreshold":70
},
"npmdocker":{
}
}

View File

@ -1,5 +0,0 @@
{
"mode":"default",
"codecov":true,
"coverageTreshold":70
}

View File

@ -1,6 +1,6 @@
{ {
"name": "smartfile", "name": "smartfile",
"version": "4.0.7", "version": "4.1.5",
"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",
@ -26,22 +26,23 @@
}, },
"homepage": "https://gitlab.com/pushrocks/smartfile", "homepage": "https://gitlab.com/pushrocks/smartfile",
"dependencies": { "dependencies": {
"beautylog": "^5.0.12", "@types/fs-extra": "0.x.x",
"fs-extra": "^0.30.0", "@types/vinyl": "^2.0.0",
"gulp": "^3.9.1", "fs-extra": "^2.0.0",
"gulp-remote-src": "^0.4.1", "glob": "^7.1.1",
"js-yaml": "^3.6.1", "js-yaml": "^3.7.0",
"q": "^1.4.1", "request": "^2.79.0",
"request": "^2.72.0",
"require-reload": "0.2.2", "require-reload": "0.2.2",
"typings-global": "^1.0.3", "smartpath": "^3.2.7",
"vinyl": "^1.1.1", "smartq": "^1.0.4",
"vinyl-file": "^2.0.0" "typings-global": "^1.0.14",
"vinyl": "^2.0.1",
"vinyl-file": "^3.0.0"
}, },
"devDependencies": { "devDependencies": {
"gulp-function": "^1.3.6", "gulp-function": "^2.2.3",
"npmts-g": "^5.2.6", "npmts-g": "^6.0.0",
"should": "^9.0.2", "smartchai": "^1.0.1",
"typings-test": "^1.0.1" "typings-test": "^1.0.3"
} }
} }

2
test/test.d.ts vendored
View File

@ -1 +1 @@
import "typings-test"; import 'typings-test';

File diff suppressed because one or more lines are too long

View File

@ -1,200 +1,227 @@
import "typings-test"; import 'typings-test'
import * as smartfile from "../dist/index"; import * as smartfile from '../dist/index'
let beautylog = require("beautylog"); import path = require('path')
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(){ import { expect } from 'smartchai'
import * as vinyl from 'vinyl'
describe(".fs".yellow,function(){ describe('smartfile', function () {
describe(".fileExistsSync".yellow,function(){ describe('.fs', function () {
it("should return an accurate boolean",function(){ describe('.fileExistsSync', function () {
(smartfile.fs.fileExistsSync("./test/mytest.json")).should.be.true(); it('should return an accurate boolean', function () {
(smartfile.fs.fileExistsSync("./test/notthere.json")).should.be.false(); expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true
}); expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false
}); })
describe(".fileExists".yellow,function(){ })
it("should return a working promise",function(){ describe('.fileExists', function () {
(smartfile.fs.fileExists("./test/mytest.json")).should.be.Promise(); it('should return a working promise', function () {
(smartfile.fs.fileExists("./test/mytest.json")).should.be.fulfilled(); expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.a('promise')
(smartfile.fs.fileExists("./test/notthere.json")).should.not.be.fulfilled(); expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.fulfilled
}); expect(smartfile.fs.fileExists('./test/notthere.json')).to.not.be.fulfilled
}); })
describe(".listFoldersSync()",function(){ })
it("should get the file type from a string",function(){ describe('.listFoldersSync()', function () {
smartfile.fs.listFoldersSync("./test/").should.containDeep([ "testfolder"]); it('should get the file type from a string', function () {
smartfile.fs.listFoldersSync("./test/").should.not.containDeep([ "notExistentFolder"]); expect(smartfile.fs.listFoldersSync('./test/')).to.deep.include('testfolder')
}); expect(smartfile.fs.listFoldersSync('./test/')).to.not.deep.include('notExistentFolder')
}); })
describe(".listFolders()",function(){ })
it("should get the file type from a string",function(done){ describe('.listFolders()', function () {
smartfile.fs.listFolders("./test/") it('should get the file type from a string', function (done) {
.then(function(folderArrayArg){ smartfile.fs.listFolders('./test/')
folderArrayArg.should.containDeep([ "testfolder"]); .then(function (folderArrayArg) {
folderArrayArg.should.not.containDeep([ "notExistentFolder"]); expect(folderArrayArg).to.deep.include('testfolder')
done(); expect(folderArrayArg).to.not.deep.include('notExistentFolder')
}); done()
}); })
}); })
describe(".copy()".yellow,function(){ })
it("should copy a directory",function(){ describe('.listFilesSync()', function () {
smartfile.fs.copy("./test/testfolder/","./test/temp/") it('should get the file type from a string', function () {
}); expect(smartfile.fs.listFilesSync('./test/')).to.deep.include('mytest.json')
it("should copy a file",function(){ expect(smartfile.fs.listFilesSync('./test/')).to.not.deep.include('notExistentFile')
smartfile.fs.copy("./test/mytest.yaml","./test/temp/") expect(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).to.deep.include('mytest.json')
}); expect(smartfile.fs.listFilesSync('./test/', /mytests.json/)).to.not.deep.include('mytest.json')
it("should copy a file and rename it",function(){ })
smartfile.fs.copy("./test/mytest.yaml","./test/temp/mytestRenamed.yaml") })
}); describe('.listFiles()', function () {
}); it('should get the file type from a string', function (done) {
describe(".remove()",function(){ smartfile.fs.listFiles('./test/')
it("should remove an entire directory",function(){ .then(function (folderArrayArg) {
expect(folderArrayArg).to.deep.include('mytest.json')
expect(folderArrayArg).to.not.deep.include('notExistentFile')
done()
})
})
})
describe('.listFileTree()', function () {
it('should get a file tree', function (done) {
smartfile.fs.listFileTree(path.resolve('./test/'), '**/*.txt')
.then(function (folderArrayArg) {
expect(folderArrayArg).to.deep.include('testfolder/testfile1.txt')
expect(folderArrayArg).to.not.deep.include('mytest.json')
done()
})
})
})
describe('.copy()', function () {
it('should copy a directory', function () {
smartfile.fs.copy('./test/testfolder/', './test/temp/')
})
it('should copy a file', function () {
smartfile.fs.copy('./test/mytest.yaml', './test/temp/')
})
it('should copy a file and rename it', function () {
smartfile.fs.copy('./test/mytest.yaml', './test/temp/mytestRenamed.yaml')
})
})
describe('.remove()', function () {
it('should remove an entire directory', 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
})
})
})
}); describe('.interpreter', function () {
it("should remove single files",function(){ describe('.filetype()', function () {
it('should get the file type from a string', function () {
expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json')
})
})
})
}); describe('.fs', function () {
}); describe('.toObjectSync()', function () {
}); it('should read an ' + '.yaml' + ' file to an object', function () {
let testData = smartfile.fs.toObjectSync('./test/mytest.yaml')
expect(testData).have.property('key1', 'this works')
expect(testData).have.property('key2', 'this works too')
describe(".interpreter",function(){ })
describe(".filetype()",function(){ it('should state unknown file type for unknown file types', function () {
it("should get the file type from a string",function(){ let testData = smartfile.fs.toObjectSync('./test/mytest.txt')
smartfile.interpreter.filetype("./somefolder/data.json").should.equal("json"); })
}); it('should read an ' + '.json' + ' file to an object', function () {
}); let testData = smartfile.fs.toObjectSync('./test/mytest.json')
}); expect(testData).have.property('key1', 'this works')
expect(testData).have.property('key2', 'this works too')
})
})
describe('.toStringSync()', function () {
it('should read a file to a string', function () {
expect(smartfile.fs.toStringSync('./test/mytest.txt'))
.to.equal('Some TestString &&%$')
})
})
describe('.toVinylSync', function () {
it('should read an ' + '.json OR .yaml' + ' file to an ' + 'vinyl file object', function () {
let testData = smartfile.fs.toVinylSync('./test/mytest.json')
expect(vinyl.isVinyl(testData)).to.be.true
})
})
})
describe(".fs".yellow,function(){ describe('.memory', function () {
describe("toGulpStreamSync() and toGulpDestSync",function(){ describe('.toGulpStream()', function () {
it("should produce a gulp stream",function(done){ it('should produce a valid gulp stream', function () {
smartfile.fs.toGulpStreamSync("./test/my*") let localArray = ['test1', 'test2', 'test3']
.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");
testData.should.have.property("key1","this works");
testData.should.have.property("key2","this works too");
});
it("should state unknown file type for unknown file types",function(){
let testData = smartfile.fs.toObjectSync("./test/mytest.txt");
});
it("should read an " + ".json".blue + " file to an object",function(){
let testData = smartfile.fs.toObjectSync("./test/mytest.json");
testData.should.have.property("key1","this works");
testData.should.have.property("key2","this works too");
});
});
describe(".toStringSync()".yellow,function(){
it("should read a file to a string",function(){
should.equal(
smartfile.fs.toStringSync("./test/mytest.txt"),
"Some TestString &&%$"
);
});
});
describe(".toVinylSync".yellow,function(){
it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan,function(){
let testData = smartfile.fs.toVinylSync("./test/mytest.json");
(vinyl.isVinyl(testData)).should.be.true();
});
});
});
describe(".memory",function(){
describe(".toGulpStream()",function(){
it("should produce a valid gulp stream",function(){
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"}; expect(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).to.be.true
(smartfile.memory.toVinylFileSync(localString,localOptions) instanceof vinyl).should.be.true(); })
}); })
}); describe('toVinylArraySync()', function () {
describe("toVinylArraySync()",function(){ it('should produce a an array of vinylfiles', function () {
it("should produce a an array of vinylfiles",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); expect(testResult).to.be.a('array')
testResult.should.be.Array(); expect(testResult.length === 3).to.be.true
(testResult.length === 3).should.be.true(); for (let myKey in testResult) {
for (let myKey in testResult){ expect(testResult[myKey] instanceof vinyl).to.be.true
(testResult[myKey] instanceof vinyl).should.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')
})); }))
localString.should.equal("myString"); expect(localString).equal('myString')
}); })
}); })
describe("toFs()",function(){ describe('toFs()', function () {
it("should write a file to disk and return a promise",function(done){ it('should write a file to disk and return a promise', function (done) {
let localString = "myString"; let localString = 'myString'
smartfile.memory.toFs( smartfile.memory.toFs(
localString, localString,
path.join(process.cwd(),"./test/temp/testMemToFs.txt") path.join(process.cwd(), './test/temp/testMemToFs.txt')
).then(done); ).then(done)
}); })
}); })
describe("toFsSync()",function(){ describe('toFsSync()', function () {
it("should write a file to disk and return true if successfull",function(){ it('should write a file to disk and return true if successfull', function () {
let localString = "myString"; let localString = 'myString'
smartfile.memory.toFsSync( smartfile.memory.toFsSync(
localString, localString,
path.join(process.cwd(),"./test/temp/testMemToFsSync.txt") path.join(process.cwd(), './test/temp/testMemToFsSync.txt')
); )
}); })
}); })
});
describe(".remote",function(){
describe("toGulpStreamSync()",function(){
it("should produce a gulp stream",function(done){
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(){
it("should load a remote file to a variable",function(done){
this.timeout(5000);
smartfile.remote.toString("https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt")
.then(function(responseString){
should.equal(responseString,"Some TestString &&%$");
done();
});
});
it("should reject a Promise when the link is false",function(done){
this.timeout(10000);
smartfile.remote.toString("https://push.rocks/doesnotexist.txt")
.then(function(){
throw new Error("this test should not be resolved");
},function(){
done();
})
});
});
}) })
});
describe('.remote', function () {
describe('.toString()', function () {
it('should load a remote file to a variable', function (done) {
this.timeout(5000)
smartfile.remote.toString(
'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt'
).then(function (responseString) {
expect(responseString).to.equal('Some TestString &&%$')
done()
})
})
it('should reject a Promise when the link is false', function (done) {
this.timeout(10000)
smartfile.remote.toString('https://push.rocks/doesnotexist.txt')
.then(
function () {
throw new Error('this test should not be resolved')
},
function () {
done()
}
)
})
})
})
})

View File

@ -1,15 +1,15 @@
import "typings-global"; import 'typings-global'
import * as plugins from "./smartfile.plugins"; import * as plugins from './smartfile.plugins'
import * as SmartfileFs from "./smartfile.fs"; import * as SmartfileFs from './smartfile.fs'
import * as SmartfileInterpreter from "./smartfile.interpreter" import * as SmartfileInterpreter from './smartfile.interpreter'
import * as SmartfileMemory from "./smartfile.memory"; import * as SmartfileMemory from './smartfile.memory'
import * as SmartfileRemote from "./smartfile.remote"; import * as SmartfileRemote from './smartfile.remote'
export {Smartfile} from "./smartfile.classes.smartfile"; export {Smartfile} from './smartfile.classes.smartfile'
export let fs = SmartfileFs; export let fs = SmartfileFs
export let interpreter = SmartfileInterpreter; export let interpreter = SmartfileInterpreter
export let memory = SmartfileMemory; export let memory = SmartfileMemory
export let remote = SmartfileRemote; export let remote = SmartfileRemote
export let requireReload = SmartfileFs.requireReload; export let requireReload = SmartfileFs.requireReload

View File

@ -1,5 +1,5 @@
export class Smartfile { export class Smartfile {
constructor(){ constructor() {
}; }
} }

View File

@ -1,8 +1,8 @@
import "typings-global"; import 'typings-global'
import plugins = require("./smartfile.plugins");
import SmartfileInterpreter = require("./smartfile.interpreter");
import plugins = require('./smartfile.plugins')
import SmartfileInterpreter = require('./smartfile.interpreter')
import * as memory from './smartfile.memory'
/*=============================================================== /*===============================================================
============================ Checks ============================= ============================ Checks =============================
===============================================================*/ ===============================================================*/
@ -12,17 +12,16 @@ import SmartfileInterpreter = require("./smartfile.interpreter");
* @param filePath * @param filePath
* @returns {boolean} * @returns {boolean}
*/ */
export let fileExistsSync = function(filePath):boolean { export let fileExistsSync = function(filePath): boolean {
let fileExistsBool:boolean = false; let fileExistsBool: boolean = false
try { try {
plugins.fs.readFileSync(filePath); plugins.fsExtra.readFileSync(filePath)
fileExistsBool = true fileExistsBool = true
} catch (err) {
fileExistsBool = false
} }
catch(err){ return fileExistsBool
fileExistsBool = false; }
}
return fileExistsBool;
};
/** /**
* *
@ -30,104 +29,159 @@ export let fileExistsSync = function(filePath):boolean {
* @returns {any} * @returns {any}
*/ */
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() : done.resolve(); err ? done.reject(err) : done.resolve()
}); })
return done.promise; return done.promise
}; }
/** /**
* Checks if given path points to an existing directory * Checks if given path points to an existing directory
*/ */
export let isDirectory = function(pathArg):boolean{ export let isDirectory = function(pathArg): boolean{
return plugins.fs.statSync(pathArg).isDirectory(); return plugins.fsExtra.statSync(pathArg).isDirectory()
}; }
/** /**
* Checks if a given path points to an existing file * Checks if a given path points to an existing file
*/ */
export let isFile = function(pathArg):boolean{ export let isFile = function(pathArg): boolean{
return plugins.fs.statSync(pathArg).isFile(); return plugins.fsExtra.statSync(pathArg).isFile()
}; }
/*=============================================================== /*===============================================================
============================ FS ACTIONS ========================= ============================ 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 * copies a file from A to B on the local disk
*/ */
export let copy = function(fromArg:string, toArg:string){ export let copy = function(fromArg: string, toArg: string){
var done = plugins.q.defer(); let done = plugins.q.defer()
plugins.fs.copy(fromArg,toArg,{},function(){ plugins.fsExtra.copy(fromArg,toArg,{},function(){
done.resolve(); done.resolve()
}); })
return done.promise; return done.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
*/ */
export let copySync = function(fromArg:string,toArg:string):boolean{ export let copySync = function(fromArg: string,toArg: string): boolean{
plugins.fs.copySync(fromArg,toArg); plugins.fsExtra.copySync(fromArg,toArg)
return true; return true
}; }
/** /**
* removes a file or folder from local disk * ensures that a directory is in place
*/ */
export let remove = function(pathArg:string){ export let ensureDir = (dirPathArg: string) => {
var done = plugins.q.defer(); let done = plugins.q.defer()
plugins.fs.remove(pathArg,function(){ plugins.fsExtra.ensureDir(dirPathArg,done.resolve)
done.resolve(); return done.promise
}); }
return done.promise;
}; /**
* ensures that a directory is in place
*/
export let ensureDirSync = (dirPathArg: string) => {
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
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec ASYNC
*/
export let ensureFile = (filePathArg, initFileStringArg): Promise<void> => {
let done = plugins.q.defer<void>()
ensureFileSync(filePathArg, initFileStringArg)
done.resolve()
return done.promise
}
/**
* ensures that a file is on disk
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec SYNC
*/
export let ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
if (fileExistsSync(filePathArg)) {
return null
} else {
memory.toFsSync(initFileStringArg, filePathArg)
}
}
/**
* removes a file or folder from local disk
*/
export let remove = function(pathArg: string): Promise<void> {
let done = plugins.q.defer<void>()
plugins.fsExtra.remove(pathArg,function(){
done.resolve()
})
return done.promise
}
/** /**
* removes a file SYNCHRONOUSLY from local disk * removes a file SYNCHRONOUSLY from local disk
*/ */
export let removeSync = function(pathArg:string):boolean{ export let removeSync = function(pathArg: string): boolean{
plugins.fs.removeSync(pathArg); plugins.fsExtra.removeSync(pathArg)
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
@ -135,11 +189,11 @@ export let toGulpDestSync = function(folderPathArg:string){
* @returns {any} * @returns {any}
*/ */
export let toObjectSync = function(filePathArg,fileTypeArg?) { export let toObjectSync = function(filePathArg,fileTypeArg?) {
let fileString = plugins.fs.readFileSync(filePathArg, 'utf8'); let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8')
let fileType; let fileType
fileTypeArg ? fileType = fileTypeArg : fileType = SmartfileInterpreter.filetype(filePathArg); fileTypeArg ? fileType = fileTypeArg : fileType = SmartfileInterpreter.filetype(filePathArg)
return SmartfileInterpreter.objectFile(fileString,fileType); return SmartfileInterpreter.objectFile(fileString,fileType)
}; }
/** /**
* reads a file content to a String * reads a file content to a String
@ -147,10 +201,10 @@ export let toObjectSync = function(filePathArg,fileTypeArg?) {
* @returns {string|Buffer|any} * @returns {string|Buffer|any}
*/ */
export let toStringSync = function(filePath) { export let toStringSync = function(filePath) {
let fileString; let fileString
fileString = plugins.fs.readFileSync(filePath, "utf8"); fileString = plugins.fsExtra.readFileSync(filePath, 'utf8')
return fileString; return fileString
}; }
/** /**
* *
@ -159,117 +213,144 @@ export let toStringSync = function(filePath) {
* @returns {number} * @returns {number}
*/ */
export let toVinylSync = function(filePathArg,options = {}) { export let toVinylSync = function(filePathArg,options = {}) {
return plugins.vinylFile.readSync(filePathArg,options); return plugins.vinylFile.readSync(filePathArg,options)
}; }
/** /**
* lets you reload files hot. * lets you reload files hot.
* @param path * @param path
* @returns {any} * @returns {any}
*/ */
export let requireReload = function(path:string){ export let requireReload = function(path: string){
return plugins.requireReload(path); return plugins.requireReload(path)
}; }
/** /**
* lists Folders in a directory on local disk * lists Folders in a directory on local disk
* @returns Promise * @returns Promise
*/ */
export let listFolders = function(pathArg:string,regexFilter?:RegExp){ export let listFolders = function(pathArg: string,regexFilter?: RegExp){
let done = plugins.q.defer(); let done = plugins.q.defer()
let folderArray = plugins.fs.readdirSync(pathArg).filter(function(file) { let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory(); return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory()
}); })
if(regexFilter){ if (regexFilter) {
folderArray = folderArray.filter((fileItem) => { folderArray = folderArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
} }
done.resolve(folderArray); done.resolve(folderArray)
return done.promise; return done.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
*/ */
export let listFoldersSync = function(pathArg:string,regexFilter?:RegExp):string[]{ export let listFoldersSync = function(pathArg: string,regexFilter?: RegExp): string[]{
let folderArray = plugins.fs.readdirSync(pathArg).filter(function(file) { let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory(); return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory()
}); })
if(regexFilter){ if (regexFilter) {
folderArray = folderArray.filter((fileItem) => { folderArray = folderArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
}; }
return folderArray; return folderArray
}; }
/** /**
* lists Files in a directory on local disk * lists Files in a directory on local disk
* @returns Promise * @returns Promise
*/ */
export let listFiles = function(pathArg:string, regexFilter?:RegExp){ export let listFiles = function(pathArg: string, regexFilter?: RegExp){
let done = plugins.q.defer(); let done = plugins.q.defer()
let fileArray = plugins.fs.readdirSync(pathArg).filter(function(file) { let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile(); return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
}); })
if(regexFilter){ if (regexFilter) {
fileArray = fileArray.filter((fileItem) => { fileArray = fileArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
}; }
done.resolve(fileArray); done.resolve(fileArray)
return done.promise(); return done.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
*/ */
export let listFilesSync = function(pathArg:string, regexFilter?:RegExp):string[]{ export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): string[]{
let fileArray = plugins.fs.readdirSync(pathArg).filter(function(file) { let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile(); return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
}); })
if(regexFilter){ if (regexFilter) {
fileArray = fileArray.filter((fileItem) => { fileArray = fileArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
}; }
return fileArray; return fileArray
}; }
/** /**
* 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 * @returns Promise<string[]>
*/ */
export let listAllItems = function(pathArg:string, regexFilter?:RegExp){ export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
let done = plugins.q.defer(); let done = plugins.q.defer<string[]>()
let allItmesArray = plugins.fs.readdirSync(pathArg); let allItmesArray = plugins.fsExtra.readdirSync(pathArg)
if(regexFilter){ if (regexFilter) {
allItmesArray = allItmesArray.filter((fileItem) => { allItmesArray = allItmesArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
}; };
done.resolve(allItmesArray); done.resolve(allItmesArray)
return done.promise(); return done.promise
}; }
/** /**
* lists all items (folders AND files) SYNCHRONOUSLY 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
* @executes SYNC
*/ */
export let listAllItemsSync = function(pathArg:string, regexFilter?:RegExp):string[]{ export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): string[]{
let allItmesArray = plugins.fs.readdirSync(pathArg).filter(function(file) { let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isFile(); return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
}); })
if(regexFilter){ if (regexFilter) {
allItmesArray = allItmesArray.filter((fileItem) => { allItmesArray = allItmesArray.filter((fileItem) => {
regexFilter.test(fileItem); return regexFilter.test(fileItem)
}); })
}; }
return allItmesArray; return allItmesArray
}; }
/**
* 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
*/
export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise<string[]> => {
let done = plugins.q.defer<string[]>()
// handle absolute miniMatchFilter
let dirPath: string
if (plugins.path.isAbsolute(miniMatchFilter)) {
dirPath = '/'
} else {
dirPath = dirPathArg
}
let options = {
cwd: dirPath
}
plugins.glob(miniMatchFilter,options,(err,files: string[]) => {
if (err) {
console.log(err)
done.reject(err)
}
done.resolve(files)
})
return done.promise
}

View File

@ -1,22 +1,22 @@
import "typings-global"; import 'typings-global'
import plugins = require("./smartfile.plugins"); import plugins = require('./smartfile.plugins')
export let filetype = (pathArg:string):string => { export let filetype = (pathArg: string): string => {
let extName = plugins.path.extname(pathArg); let extName = plugins.path.extname(pathArg)
let fileType = extName.replace(/\.([a-z]*)/,"$1"); //remove . form fileType let fileType = extName.replace(/\.([a-z]*)/,'$1') // remove . form fileType
return fileType; return fileType
}; }
export let objectFile = (fileStringArg:string, fileTypeArg) => { export let objectFile = (fileStringArg: string, fileTypeArg) => {
switch (fileTypeArg) { switch (fileTypeArg) {
case "yml" : case 'yml' :
case "yaml": case 'yaml':
return plugins.yaml.safeLoad(fileStringArg); return plugins.yaml.safeLoad(fileStringArg)
case "json": case 'json':
return JSON.parse(fileStringArg); return JSON.parse(fileStringArg)
default: default:
plugins.beautylog.error("file type " + fileTypeArg.blue + " not supported"); console.error('file type ' + fileTypeArg.blue + ' not supported')
break; break
} }
} }

View File

@ -1,9 +1,17 @@
import "typings-global"; import 'typings-global'
import plugins = require('./smartfile.plugins')
import SmartfileInterpreter = require('./smartfile.interpreter')
let vinyl = require('vinyl')
export interface IVinylFile {
contents: Buffer
base: string
path: string,
}
let Readable = require('stream').Readable
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 * 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
@ -11,34 +19,34 @@ 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
} else { } else {
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}))
}; };
let stream = new Readable({ objectMode: true }); let stream = new Readable({ objectMode: true })
for(let vinylFileIndexArg in vinylFileArray){ for (let vinylFileIndexArg in vinylFileArray) {
let vinylFile = vinylFileArray[vinylFileIndexArg]; let vinylFile = vinylFileArray[vinylFileIndexArg]
stream.push(vinylFile); stream.push(vinylFile)
}; };
stream.push(null); //signal end of stream; stream.push(null) // signal end of stream;
return stream; return stream
}; }
/** /**
* converts file to Object * converts file to Object
@ -46,50 +54,55 @@ export let toGulpStream = function(fileArg:string|string[]|plugins.vinyl|plugins
* @param fileTypeArg * @param fileTypeArg
* @returns {any|any} * @returns {any|any}
*/ */
export let toObject = function(fileStringArg:string,fileTypeArg:string){ export let toObject = function(fileStringArg: string,fileTypeArg: string){
return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg); return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
}; }
/** /**
* takes a string and converts it to vinyl file * takes a string and converts it to vinyl file
* @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(
let vinylArray = []; arrayArg: string[],
for(let stringIndexArg in arrayArg){ optionsArg?: {
let myString = arrayArg[stringIndexArg]; filename?: string,
vinylArray.push(toVinylFileSync(myString,optionsArg)); base?: string,
relPath?: string
} }
return vinylArray; ){
}; let vinylArray = []
for (let stringIndexArg in arrayArg) {
let myString = arrayArg[stringIndexArg]
vinylArray.push(toVinylFileSync(myString,optionsArg))
}
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.
@ -97,37 +110,41 @@ 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
if (!fileContentArg || !filePathArg) throw new Error("expected valid arguments"); if (!fileContentArg || !filePathArg) {
throw new Error('expected valid arguments')
}
// 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
} else if (typeof fileContentArg === "string") { fileString = vinylToStringSync(fileContentArg2)
fileString = fileContentArg; } else if (typeof fileContentArg === 'string') {
fileString = fileContentArg
} }
plugins.fs.writeFile(filePath,fileString,"utf8",done.resolve); plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
return done.promise; return done.promise
}; }
export let toFsSync = function(fileArg,filePathArg:string){ export let toFsSync = function(fileArg,filePathArg: string){
//function checks to abort if needed // function checks to abort if needed
if (!fileArg || !filePathArg) throw new Error("expected a valid arguments"); if (!fileArg || !filePathArg) {
throw new Error('expected a valid arguments')
}
// prepare actual write action // prepare actual write action
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.fs.writeFileSync(filePath,fileString,"utf8"); plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
}; }

View File

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

View File

@ -1,65 +1,52 @@
import "typings-global"; import 'typings-global'
import plugins = require("./smartfile.plugins"); import plugins = require('./smartfile.plugins')
import SmartfileInterpreter = require("./smartfile.interpreter"); import SmartfileInterpreter = require('./smartfile.interpreter')
export let toFs = function(from:string,toPath:string) { export let toFs = function(from: string,toPath: string) {
var done = plugins.q.defer(); let done = plugins.q.defer()
var stream = plugins.request(from).pipe(plugins.fs.createWriteStream(toPath)); let stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath))
stream.on('finish',function(){ stream.on('finish',function(){
done.resolve(toPath); done.resolve(toPath)
}); })
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
* @returns {any} * @returns {any}
*/ */
export let toObject = function(fromArg:string){ export let toObject = function(fromArg: string){
let done = plugins.q.defer(); let done = plugins.q.defer()
plugins.request.get(fromArg, function (error, response, bodyString) { plugins.request.get(fromArg, function (error, response, bodyString) {
let returnObject; let returnObject
if (!error && response.statusCode == 200) { if (!error && response.statusCode === 200) {
returnObject = SmartfileInterpreter.objectFile(bodyString,SmartfileInterpreter.filetype(fromArg)); returnObject = SmartfileInterpreter.objectFile(bodyString,SmartfileInterpreter.filetype(fromArg))
done.resolve(returnObject); done.resolve(returnObject)
} else { } else {
console.log('could not get remote file from ' + fromArg); console.log('could not get remote file from ' + fromArg)
returnObject = undefined; returnObject = undefined
done.reject(returnObject); done.reject(returnObject)
}; }
}); })
return done.promise; return done.promise
}; }
/** /**
* *
* @param fromArg * @param fromArg
* @returns {any} * @returns {any}
*/ */
export let toString = (fromArg:string) => { export let toString = (fromArg: string) => {
let done = plugins.q.defer(); let done = plugins.q.defer()
plugins.request.get(fromArg, function (error, response, bodyString) { plugins.request.get(fromArg, function (error, response, bodyString) {
if (!error && response.statusCode == 200) { if (!error && response.statusCode === 200) {
done.resolve(bodyString); done.resolve(bodyString)
} else { } else {
plugins.beautylog.error('could not get remote file from ' + fromArg); console.error('could not get remote file from ' + fromArg)
bodyString = undefined; bodyString = undefined
done.reject(bodyString); done.reject(bodyString)
}; }
}); })
return done.promise; return done.promise
}; }

View File

@ -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"
}
}

3
tslint.json Normal file
View File

@ -0,0 +1,3 @@
{
"extends": "tslint-config-standard"
}