Compare commits
106 Commits
Author | SHA1 | Date | |
---|---|---|---|
d1538f939d | |||
3fef2a4ab9 | |||
77603ee736 | |||
353058ed73 | |||
bf618512e2 | |||
b276c5639d | |||
779c62dcbb | |||
3e1101c5e1 | |||
395504127c | |||
6dee92a3df | |||
0ba3c1794e | |||
0a810a3ac1 | |||
fc23f221eb | |||
cfcd1f7aaf | |||
2cb8c5117a | |||
2c52dec8ea | |||
1fdd492eff | |||
38354d2944 | |||
760913bad3 | |||
f7b8fe5498 | |||
37fbf9a409 | |||
49aba4c85f | |||
37d81fa4c6 | |||
0256166c2f | |||
bef2bd6b3a | |||
759e1655da | |||
d732d1ba97 | |||
eeab2cf0cd | |||
ab76cae75e | |||
f39daca6aa | |||
e70db71ec4 | |||
50ef41d5d4 | |||
2a417ba18f | |||
3516189940 | |||
10e3628a89 | |||
86eafe4568 | |||
fddde78b92 | |||
2a365b04a6 | |||
df1d82cb7c | |||
d20742f881 | |||
db2a0c2992 | |||
7d806f313b | |||
ff2e34696a | |||
23188dfe3f | |||
38f10e0d04 | |||
2e2b8351f8 | |||
8c386ee91c | |||
9828689f31 | |||
8205da5284 | |||
2fc132ab20 | |||
e948d08f2e | |||
4362e94a88 | |||
fea9675b2a | |||
4522907af3 | |||
163eb5a70c | |||
fa5371a6bd | |||
5ff7f8c3ac | |||
0c49bbd4b2 | |||
f2e2a22a57 | |||
6ae30110f8 | |||
7b4626586c | |||
ef027d32c7 | |||
f5e89c57e5 | |||
d02e59a829 | |||
44f3d3597f | |||
322335f2e5 | |||
c0b5e2805f | |||
2599753877 | |||
66e9d29667 | |||
c57b81c901 | |||
ed6c730a6c | |||
d77999e62d | |||
8561cfcc5c | |||
f3a81d60e9 | |||
96210fca9f | |||
60a2a7fc69 | |||
5d898baadf | |||
9954ae4ba7 | |||
4b1f3d234b | |||
aed2c92b75 | |||
cb805898c9 | |||
c09fe29d99 | |||
a787836e56 | |||
287c2fa99f | |||
111b70aefb | |||
be91e22447 | |||
a337663830 | |||
2cbb14c515 | |||
68cc85b684 | |||
7e875212b5 | |||
372e00597c | |||
6e32af1c9b | |||
c60eac7787 | |||
581b9e21d3 | |||
0661744614 | |||
20a3fdba03 | |||
580cb95aa7 | |||
9a05df4200 | |||
9afe7c8a9e | |||
9aac47cae3 | |||
4e62bbeeea | |||
4a8df9c12f | |||
34d38cd3d4 | |||
834b22ed8d | |||
8e9b080004 | |||
d5d4d3ff67 |
11
.gitignore
vendored
11
.gitignore
vendored
@ -1,12 +1,7 @@
|
||||
node_modules/
|
||||
.settings/
|
||||
.idea/
|
||||
coverage/
|
||||
docs/
|
||||
pages/
|
||||
public/
|
||||
|
||||
ts/*.js
|
||||
ts/*.js.map
|
||||
ts/typings/
|
||||
|
||||
test/assets/
|
||||
test/temp/
|
||||
|
||||
|
59
.gitlab-ci.yml
Normal file
59
.gitlab-ci.yml
Normal file
@ -0,0 +1,59 @@
|
||||
image: hosttoday/ht-docker-node:npmts
|
||||
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
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
|
||||
|
||||
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
|
14
.travis.yml
14
.travis.yml
@ -1,14 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- '4.2.4'
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: 3RdzAcS9d6sLJs3tHM2uCVU2wV2NsKiLiYWue98DevgijIqTFDHtYuoP29p7fbB4SV87JRbTK1y41QM2u/CCjnbB+mrAUg/Pn08dTibmzi9liom67sLczIPD4eZeMznXPRaddESQdzqrtQfc/6P+1JQO7XWexLNebgYtMrUzYcOrHPWf/Uktk2cKiYfrO8piSR+HOFh2rzC5HjVZ/7fKDIa9bqTlBETkNc7s2NgB++jKRF9LNMVGI/9EmxjBzSSE1juOz26Ahp4+/+P3Lc5LngnTFOYsPoW5iWNY+AQltZxhu9K+rrtfn90rmQDnO7RCGO5yZgMS2+0UjJedwV+4ancU3nzoNmiuoIL7DjQ7NQlt0QKMmIqZuBFBc3tdxqotxNoJDk8/Ui0yfHWzJz0Fd22OI+VdTWNH1y5Vyywsql6wwkl2+Da1WhZf/Mn2gPgLPI0lssPTIl/u3Bey+167tZ3HvX0yqlvPO/JbqK02+5VrRBaV67vT00DG+dh4nnwqcX14Umx2a3JHt3tSGkDnDKpsLbvqjhPhkMRsCIloju+wMnyKjtScMZW+2FeO2n4PgbjNhF+5SG8pDmTS8p0Vy7iohUOiGIJty7K/1r6sQ1FNluhO5Ol3mBDs6wjg6S5QCSNL9eylpV52FV0UX4cRCijmzso+n48I2BbSwjghTB8=
|
||||
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=
|
35
README.md
35
README.md
@ -1,11 +1,36 @@
|
||||
# smartfile
|
||||
make files easily accessible for processing in javascript.
|
||||
|
||||
## Status
|
||||
[](https://travis-ci.org/pushrocks/smartfile)
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/smartfile)
|
||||
[](https://gitlab.com/pushrocks/smartfile)
|
||||
[](https://github.com/pushrocks/smartfile)
|
||||
[](https://pushrocks.gitlab.io/smartfile/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartfile/commits/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://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Supported file types:
|
||||
* .yml .yaml
|
||||
* .json
|
||||
## Usage
|
||||
smartfile is an approach of being one tool to handle files in diverse environments.
|
||||
|
||||
### 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 more information read the docs
|
||||
|
||||
[](https://push.rocks)
|
||||
|
11
dist/index.d.ts
vendored
Normal file
11
dist/index.d.ts
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
import 'typings-global';
|
||||
import * as SmartfileFs from './smartfile.fs';
|
||||
import * as SmartfileInterpreter from './smartfile.interpreter';
|
||||
import * as SmartfileMemory from './smartfile.memory';
|
||||
import * as SmartfileRemote from './smartfile.remote';
|
||||
export { Smartfile } from './smartfile.classes.smartfile';
|
||||
export declare let fs: typeof SmartfileFs;
|
||||
export declare let interpreter: typeof SmartfileInterpreter;
|
||||
export declare let memory: typeof SmartfileMemory;
|
||||
export declare let remote: typeof SmartfileRemote;
|
||||
export declare let requireReload: (path: string) => any;
|
27
dist/index.js
vendored
27
dist/index.js
vendored
@ -1,15 +1,14 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
"use strict";
|
||||
var SmartfileChecks = require("./smartfile.checks");
|
||||
var SmartfileSimple = require("./smartfile.simple");
|
||||
var smartfile = {
|
||||
copy: SmartfileSimple.copy,
|
||||
checks: SmartfileChecks,
|
||||
readFileToString: SmartfileSimple.readFileToString,
|
||||
readFileToObject: SmartfileSimple.readFileToObject,
|
||||
readFileToVinyl: SmartfileSimple.readFileToVinyl,
|
||||
requireReload: SmartfileSimple.requireReload
|
||||
};
|
||||
module.exports = smartfile;
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0Qzs7QUFHNUMsSUFBTyxlQUFlLFdBQVcsb0JBQW9CLENBQUMsQ0FBQztBQUN2RCxJQUFPLGVBQWUsV0FBVyxvQkFBb0IsQ0FBQyxDQUFDO0FBR3ZELElBQUksU0FBUyxHQUFPO0lBQ2hCLElBQUksRUFBRSxlQUFlLENBQUMsSUFBSTtJQUMxQixNQUFNLEVBQUUsZUFBZTtJQUN2QixnQkFBZ0IsRUFBRSxlQUFlLENBQUMsZ0JBQWdCO0lBQ2xELGdCQUFnQixFQUFFLGVBQWUsQ0FBQyxnQkFBZ0I7SUFDbEQsZUFBZSxFQUFFLGVBQWUsQ0FBQyxlQUFlO0lBQ2hELGFBQWEsRUFBRSxlQUFlLENBQUMsYUFBYTtDQUMvQyxDQUFDO0FBRUYsaUJBQVMsU0FBUyxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxuXG5pbXBvcnQgcGx1Z2lucyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZmlsZS5wbHVnaW5zXCIpO1xuaW1wb3J0IFNtYXJ0ZmlsZUNoZWNrcyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZmlsZS5jaGVja3NcIik7XG5pbXBvcnQgU21hcnRmaWxlU2ltcGxlID0gcmVxdWlyZShcIi4vc21hcnRmaWxlLnNpbXBsZVwiKTtcblxuXG52YXIgc21hcnRmaWxlOmFueSA9IHtcbiAgICBjb3B5OiBTbWFydGZpbGVTaW1wbGUuY29weSxcbiAgICBjaGVja3M6IFNtYXJ0ZmlsZUNoZWNrcyxcbiAgICByZWFkRmlsZVRvU3RyaW5nOiBTbWFydGZpbGVTaW1wbGUucmVhZEZpbGVUb1N0cmluZyxcbiAgICByZWFkRmlsZVRvT2JqZWN0OiBTbWFydGZpbGVTaW1wbGUucmVhZEZpbGVUb09iamVjdCxcbiAgICByZWFkRmlsZVRvVmlueWw6IFNtYXJ0ZmlsZVNpbXBsZS5yZWFkRmlsZVRvVmlueWwsXG4gICAgcmVxdWlyZVJlbG9hZDogU21hcnRmaWxlU2ltcGxlLnJlcXVpcmVSZWxvYWRcbn07XG5cbmV4cG9ydCA9IHNtYXJ0ZmlsZTtcbiJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
||||
require("typings-global");
|
||||
const SmartfileFs = require("./smartfile.fs");
|
||||
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
const SmartfileMemory = require("./smartfile.memory");
|
||||
const SmartfileRemote = require("./smartfile.remote");
|
||||
var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
|
||||
exports.Smartfile = smartfile_classes_smartfile_1.Smartfile;
|
||||
exports.fs = SmartfileFs;
|
||||
exports.interpreter = SmartfileInterpreter;
|
||||
exports.memory = SmartfileMemory;
|
||||
exports.remote = SmartfileRemote;
|
||||
exports.requireReload = SmartfileFs.requireReload;
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBR3ZCLDhDQUE2QztBQUM3QyxnRUFBK0Q7QUFDL0Qsc0RBQXFEO0FBQ3JELHNEQUFxRDtBQUVyRCw2RUFBdUQ7QUFBL0Msa0RBQUEsU0FBUyxDQUFBO0FBRU4sUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFBO0FBQ2hCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFBO0FBQ2xDLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQTtBQUN4QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUE7QUFDeEIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQSJ9
|
33
dist/smartfile.checks.js
vendored
33
dist/smartfile.checks.js
vendored
@ -1,33 +0,0 @@
|
||||
"use strict";
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./smartfile.plugins");
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
exports.fileExistsSync = function (filePath) {
|
||||
var fileExistsBool = false;
|
||||
try {
|
||||
plugins.fs.readFileSync(filePath);
|
||||
fileExistsBool = true;
|
||||
}
|
||||
catch (err) {
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.fileExists = function (filePath) {
|
||||
var done = plugins.q.defer();
|
||||
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||
err ? done.reject() : done.resolve();
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5jaGVja3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDRDQUE0QztBQUM1QyxJQUFPLE9BQU8sV0FBVyxxQkFBcUIsQ0FBQyxDQUFDO0FBRWhEOzs7O0dBSUc7QUFDUSxzQkFBYyxHQUFHLFVBQVMsUUFBUTtJQUN6QyxJQUFJLGNBQWMsR0FBVyxLQUFLLENBQUM7SUFDbkMsSUFBSSxDQUFDO1FBQ0QsT0FBTyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDbEMsY0FBYyxHQUFHLElBQUksQ0FBQTtJQUN6QixDQUNBO0lBQUEsS0FBSyxDQUFBLENBQUMsR0FBRyxDQUFDLENBQUEsQ0FBQztRQUNQLGNBQWMsR0FBRyxLQUFLLENBQUM7SUFDM0IsQ0FBQztJQUNELE1BQU0sQ0FBQyxjQUFjLENBQUM7QUFDMUIsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLGtCQUFVLEdBQUcsVUFBUyxRQUFRO0lBQ3JDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsT0FBTyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFFLE9BQU8sQ0FBQyxFQUFFLENBQUMsSUFBSSxFQUFFLFVBQVUsR0FBRztRQUN0RCxHQUFHLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUN6QyxDQUFDLENBQUMsQ0FBQztJQUNILE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQyIsImZpbGUiOiJzbWFydGZpbGUuY2hlY2tzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxuaW1wb3J0IHBsdWdpbnMgPSByZXF1aXJlKFwiLi9zbWFydGZpbGUucGx1Z2luc1wiKTtcblxuLyoqXG4gKlxuICogQHBhcmFtIGZpbGVQYXRoXG4gKiBAcmV0dXJucyB7Ym9vbGVhbn1cbiAqL1xuZXhwb3J0IGxldCBmaWxlRXhpc3RzU3luYyA9IGZ1bmN0aW9uKGZpbGVQYXRoKTpib29sZWFuIHtcbiAgICBsZXQgZmlsZUV4aXN0c0Jvb2w6Ym9vbGVhbiA9IGZhbHNlO1xuICAgIHRyeSB7XG4gICAgICAgIHBsdWdpbnMuZnMucmVhZEZpbGVTeW5jKGZpbGVQYXRoKTtcbiAgICAgICAgZmlsZUV4aXN0c0Jvb2wgPSB0cnVlXG4gICAgfVxuICAgIGNhdGNoKGVycil7XG4gICAgICAgIGZpbGVFeGlzdHNCb29sID0gZmFsc2U7XG4gICAgfVxuICAgIHJldHVybiBmaWxlRXhpc3RzQm9vbDtcbn07XG5cbi8qKlxuICpcbiAqIEBwYXJhbSBmaWxlUGF0aFxuICogQHJldHVybnMge2FueX1cbiAqL1xuZXhwb3J0IGxldCBmaWxlRXhpc3RzID0gZnVuY3Rpb24oZmlsZVBhdGgpe1xuICAgIGxldCBkb25lID0gcGx1Z2lucy5xLmRlZmVyKCk7XG4gICAgcGx1Z2lucy5mcy5hY2Nlc3MoZmlsZVBhdGgsIHBsdWdpbnMuZnMuUl9PSywgZnVuY3Rpb24gKGVycikge1xuICAgICAgICBlcnIgPyBkb25lLnJlamVjdCgpIDogZG9uZS5yZXNvbHZlKCk7XG4gICAgfSk7XG4gICAgcmV0dXJuIGRvbmUucHJvbWlzZTtcbn07XG4iXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
|
3
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
3
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
export declare class Smartfile {
|
||||
constructor();
|
||||
}
|
7
dist/smartfile.classes.smartfile.js
vendored
Normal file
7
dist/smartfile.classes.smartfile.js
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
"use strict";
|
||||
class Smartfile {
|
||||
constructor() {
|
||||
}
|
||||
}
|
||||
exports.Smartfile = Smartfile;
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtJQUNJO0lBRUEsQ0FBQztDQUNKO0FBSkQsOEJBSUMifQ==
|
142
dist/smartfile.fs.d.ts
vendored
Normal file
142
dist/smartfile.fs.d.ts
vendored
Normal file
@ -0,0 +1,142 @@
|
||||
import 'typings-global';
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export declare let fileExistsSync: (filePath: any) => boolean;
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let fileExists: (filePath: any) => Promise<{}>;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
export declare let copy: (fromArg: string, toArg: string) => Promise<{}>;
|
||||
/**
|
||||
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
||||
*/
|
||||
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
|
||||
*/
|
||||
export declare let remove: (pathArg: string) => Promise<void>;
|
||||
/**
|
||||
* removes a file SYNCHRONOUSLY from local disk
|
||||
*/
|
||||
export declare let removeSync: (pathArg: string) => boolean;
|
||||
/**
|
||||
* removes an array of filePaths from disk
|
||||
*/
|
||||
export declare let removeMany: (filePathArrayArg: string[]) => Promise<void[]>;
|
||||
/**
|
||||
* like removeFilePathArray but SYNCHRONOUSLY
|
||||
*/
|
||||
export declare let removeManySync: (filePathArrayArg: string[]) => void;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param fileTypeArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let toObjectSync: (filePathArg: any, fileTypeArg?: any) => any;
|
||||
/**
|
||||
* reads a file content to a String
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
export declare let toStringSync: (filePath: any) => any;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param options
|
||||
* @returns {number}
|
||||
*/
|
||||
export declare let toVinylSync: (filePathArg: any, options?: {}) => any;
|
||||
/**
|
||||
* lets you reload files hot.
|
||||
* @param path
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let requireReload: (path: string) => any;
|
||||
/**
|
||||
* lists Folders in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
|
||||
/**
|
||||
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||
/**
|
||||
* lists Files in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
|
||||
/**
|
||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
*/
|
||||
export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns Promise<string[]>
|
||||
*/
|
||||
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => Promise<string[]>;
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
* @executes SYNC
|
||||
*/
|
||||
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[]>;
|
330
dist/smartfile.fs.js
vendored
Normal file
330
dist/smartfile.fs.js
vendored
Normal file
File diff suppressed because one or more lines are too long
3
dist/smartfile.interpreter.d.ts
vendored
Normal file
3
dist/smartfile.interpreter.d.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
import 'typings-global';
|
||||
export declare let filetype: (pathArg: string) => string;
|
||||
export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any;
|
21
dist/smartfile.interpreter.js
vendored
Normal file
21
dist/smartfile.interpreter.js
vendored
Normal file
@ -0,0 +1,21 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
const plugins = require("./smartfile.plugins");
|
||||
exports.filetype = (pathArg) => {
|
||||
let extName = plugins.path.extname(pathArg);
|
||||
let fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
|
||||
return fileType;
|
||||
};
|
||||
exports.objectFile = (fileStringArg, fileTypeArg) => {
|
||||
switch (fileTypeArg) {
|
||||
case 'yml':
|
||||
case 'yaml':
|
||||
return plugins.yaml.safeLoad(fileStringArg);
|
||||
case 'json':
|
||||
return JSON.parse(fileStringArg);
|
||||
default:
|
||||
console.error('file type ' + fileTypeArg.blue + ' not supported');
|
||||
break;
|
||||
}
|
||||
};
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBdUI7QUFFdkIsK0NBQStDO0FBRXBDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZTtJQUNsQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUMzQyxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBQyxJQUFJLENBQUMsQ0FBQSxDQUFDLHlCQUF5QjtJQUMzRSxNQUFNLENBQUMsUUFBUSxDQUFBO0FBQ25CLENBQUMsQ0FBQTtBQUVVLFFBQUEsVUFBVSxHQUFHLENBQUMsYUFBcUIsRUFBRSxXQUFXO0lBQ3ZELE1BQU0sQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7UUFDbEIsS0FBSyxLQUFLLENBQUU7UUFDWixLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDL0MsS0FBSyxNQUFNO1lBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDcEM7WUFDSSxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUE7WUFDakUsS0FBSyxDQUFBO0lBQ2IsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9
|
54
dist/smartfile.memory.d.ts
vendored
Normal file
54
dist/smartfile.memory.d.ts
vendored
Normal file
@ -0,0 +1,54 @@
|
||||
/// <reference types="node" />
|
||||
import 'typings-global';
|
||||
export interface IVinylFile {
|
||||
contents: Buffer;
|
||||
base: string;
|
||||
path: string;
|
||||
}
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
|
||||
* @param fileArg
|
||||
* @returns stream.Readable
|
||||
* @TODO: make it async;
|
||||
*/
|
||||
export declare let toGulpStream: (fileArg: string | string[] | IVinylFile | IVinylFile[], baseArg?: string) => any;
|
||||
/**
|
||||
* converts file to Object
|
||||
* @param fileStringArg
|
||||
* @param fileTypeArg
|
||||
* @returns {any|any}
|
||||
*/
|
||||
export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
|
||||
/**
|
||||
* takes a string and converts it to vinyl file
|
||||
* @param fileArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
|
||||
filename?: string;
|
||||
base?: string;
|
||||
relPath?: string;
|
||||
}) => any;
|
||||
/**
|
||||
* takes a string array and some options and returns a vinylfile array
|
||||
* @param arrayArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
|
||||
filename?: string;
|
||||
base?: string;
|
||||
relPath?: string;
|
||||
}) => any[];
|
||||
/**
|
||||
* takes a vinylFile object and converts it to String
|
||||
*/
|
||||
export declare let vinylToStringSync: (fileArg: IVinylFile) => string;
|
||||
/**
|
||||
* writes string or vinyl file to disk.
|
||||
* @param fileArg
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export declare let toFs: (fileContentArg: string | IVinylFile, filePathArg: any) => Promise<{}>;
|
||||
export declare let toFsSync: (fileArg: any, filePathArg: string) => void;
|
128
dist/smartfile.memory.js
vendored
Normal file
128
dist/smartfile.memory.js
vendored
Normal file
File diff suppressed because one or more lines are too long
11
dist/smartfile.plugins.d.ts
vendored
Normal file
11
dist/smartfile.plugins.d.ts
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
import 'typings-global';
|
||||
export import fs = require('fs');
|
||||
export import fsExtra = require('fs-extra');
|
||||
export declare let glob: any;
|
||||
export import path = require('path');
|
||||
export import q = require('smartq');
|
||||
export declare let request: any;
|
||||
export declare let requireReload: any;
|
||||
export import smartpath = require('smartpath');
|
||||
export declare let vinylFile: any;
|
||||
export declare let yaml: any;
|
22
dist/smartfile.plugins.js
vendored
22
dist/smartfile.plugins.js
vendored
@ -1,13 +1,13 @@
|
||||
"use strict";
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.fs = require("fs-extra");
|
||||
require("typings-global");
|
||||
exports.fs = require("fs");
|
||||
exports.fsExtra = require("fs-extra");
|
||||
exports.glob = require('glob');
|
||||
exports.path = require("path");
|
||||
exports.q = require("q");
|
||||
exports.vinyl = require("vinyl");
|
||||
exports.vinylFile = require("vinyl-file");
|
||||
exports.yaml = require("js-yaml");
|
||||
exports.requireReload = require("require-reload");
|
||||
exports.shelljs = require("shelljs");
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSw0Q0FBNEM7QUFDakMsaUJBQVMsR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUM7QUFDakMsVUFBRSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQztBQUN6QixZQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLFNBQUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDakIsYUFBSyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUN6QixpQkFBUyxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNsQyxZQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzFCLHFCQUFhLEdBQUcsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDMUMsZUFBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQyIsImZpbGUiOiJzbWFydGZpbGUucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCIuL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbmV4cG9ydCBsZXQgYmVhdXR5bG9nID0gcmVxdWlyZShcImJlYXV0eWxvZ1wiKTtcbmV4cG9ydCBsZXQgZnMgPSByZXF1aXJlKFwiZnMtZXh0cmFcIik7XG5leHBvcnQgbGV0IHBhdGggPSByZXF1aXJlKFwicGF0aFwiKTtcbmV4cG9ydCBsZXQgcSA9IHJlcXVpcmUoXCJxXCIpO1xuZXhwb3J0IGxldCB2aW55bCA9IHJlcXVpcmUoXCJ2aW55bFwiKTtcbmV4cG9ydCBsZXQgdmlueWxGaWxlID0gcmVxdWlyZShcInZpbnlsLWZpbGVcIik7XG5leHBvcnQgbGV0IHlhbWwgPSByZXF1aXJlKFwianMteWFtbFwiKTtcbmV4cG9ydCBsZXQgcmVxdWlyZVJlbG9hZCA9IHJlcXVpcmUoXCJyZXF1aXJlLXJlbG9hZFwiKTtcbmV4cG9ydCBsZXQgc2hlbGxqcyA9IHJlcXVpcmUoXCJzaGVsbGpzXCIpO1xuIl0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
||||
exports.q = require("smartq");
|
||||
exports.request = require('request');
|
||||
exports.requireReload = require('require-reload');
|
||||
exports.smartpath = require("smartpath");
|
||||
exports.vinylFile = require('vinyl-file');
|
||||
exports.yaml = require('js-yaml');
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLDJCQUFnQztBQUNoQyxzQ0FBMkM7QUFDaEMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0FBQ2pDLCtCQUFvQztBQUNwQyw4QkFBbUM7QUFDeEIsUUFBQSxPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBQzVCLFFBQUEsYUFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ3BELHlDQUE4QztBQUNuQyxRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBIn0=
|
14
dist/smartfile.remote.d.ts
vendored
Normal file
14
dist/smartfile.remote.d.ts
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
import 'typings-global';
|
||||
export declare let toFs: (from: string, toPath: string) => Promise<{}>;
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let toObject: (fromArg: string) => Promise<{}>;
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let toString: (fromArg: string) => Promise<{}>;
|
53
dist/smartfile.remote.js
vendored
Normal file
53
dist/smartfile.remote.js
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
const plugins = require("./smartfile.plugins");
|
||||
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
exports.toFs = function (from, toPath) {
|
||||
let done = plugins.q.defer();
|
||||
let stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath));
|
||||
stream.on('finish', function () {
|
||||
done.resolve(toPath);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.toObject = function (fromArg) {
|
||||
let done = plugins.q.defer();
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
let returnObject;
|
||||
if (!error && response.statusCode === 200) {
|
||||
returnObject = SmartfileInterpreter.objectFile(bodyString, SmartfileInterpreter.filetype(fromArg));
|
||||
done.resolve(returnObject);
|
||||
}
|
||||
else {
|
||||
console.log('could not get remote file from ' + fromArg);
|
||||
returnObject = undefined;
|
||||
done.reject(returnObject);
|
||||
}
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.toString = (fromArg) => {
|
||||
let done = plugins.q.defer();
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
if (!error && response.statusCode === 200) {
|
||||
done.resolve(bodyString);
|
||||
}
|
||||
else {
|
||||
console.error('could not get remote file from ' + fromArg);
|
||||
bodyString = undefined;
|
||||
done.reject(bodyString);
|
||||
}
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQ0FBK0M7QUFDL0MsZ0VBQWdFO0FBRXJELFFBQUEsSUFBSSxHQUFHLFVBQVMsSUFBWSxFQUFDLE1BQWM7SUFDbEQsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7SUFDbEYsTUFBTSxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUM7UUFDZixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7QUFDdkIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZTtJQUMxQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxVQUFVLEtBQUssRUFBRSxRQUFRLEVBQUUsVUFBVTtRQUM5RCxJQUFJLFlBQVksQ0FBQTtRQUNoQixFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsWUFBWSxHQUFHLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxVQUFVLEVBQUMsb0JBQW9CLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUE7WUFDakcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM5QixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsR0FBRyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3hELFlBQVksR0FBRyxTQUFTLENBQUE7WUFDeEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM3QixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUE7QUFFRDs7OztHQUlHO0FBQ1EsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUFlO0lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDNUIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFVBQVUsS0FBSyxFQUFFLFFBQVEsRUFBRSxVQUFVO1FBQzlELEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQzVCLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE9BQU8sQ0FBQyxLQUFLLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUE7WUFDMUQsVUFBVSxHQUFHLFNBQVMsQ0FBQTtZQUN0QixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQzNCLENBQUM7SUFDTCxDQUFDLENBQUMsQ0FBQTtJQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0FBQ3ZCLENBQUMsQ0FBQSJ9
|
69
dist/smartfile.simple.js
vendored
69
dist/smartfile.simple.js
vendored
@ -1,69 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
"use strict";
|
||||
var plugins = require("./smartfile.plugins");
|
||||
exports.copy = function (fromArg, toArg) {
|
||||
plugins.shelljs.cp("-r", fromArg, toArg);
|
||||
};
|
||||
/**
|
||||
* reads a file content to a String
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
exports.readFileToString = function (filePath) {
|
||||
var fileString;
|
||||
fileString = plugins.fs.readFileSync(filePath, "utf8");
|
||||
return fileString;
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @param fileTypeArg
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.readFileToObject = function (filePath, fileTypeArg) {
|
||||
if (fileTypeArg === void 0) { fileTypeArg = undefined; }
|
||||
var fileType;
|
||||
if (typeof fileTypeArg == "undefined") {
|
||||
fileType = plugins.path.extname(filePath);
|
||||
}
|
||||
else {
|
||||
fileType = fileTypeArg;
|
||||
}
|
||||
fileType = fileType.replace(/\.([a-z]*)/, "$1"); //remove . form fileType
|
||||
switch (fileType) {
|
||||
case "yml":
|
||||
case "yaml":
|
||||
try {
|
||||
return plugins.yaml.safeLoad(plugins.fs.readFileSync(filePath, 'utf8'));
|
||||
}
|
||||
catch (e) {
|
||||
plugins.beautylog.error("check that " + filePath.blue + " points to a valid file");
|
||||
}
|
||||
break;
|
||||
case "json":
|
||||
return plugins.fs.readJsonSync(filePath, {});
|
||||
default:
|
||||
plugins.beautylog.error("file type " + fileType.blue + " not supported");
|
||||
break;
|
||||
}
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param options
|
||||
* @returns {number}
|
||||
*/
|
||||
exports.readFileToVinyl = function (filePathArg, options) {
|
||||
if (options === void 0) { options = {}; }
|
||||
return plugins.vinylFile.readSync(filePathArg, options);
|
||||
};
|
||||
/**
|
||||
* lets you reload files hot.
|
||||
* @param path
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.requireReload = function (path) {
|
||||
return plugins.requireReload(path);
|
||||
};
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5zaW1wbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsNENBQTRDOztBQUU1QyxJQUFPLE9BQU8sV0FBVyxxQkFBcUIsQ0FBQyxDQUFDO0FBRXJDLFlBQUksR0FBRyxVQUFTLE9BQWMsRUFBQyxLQUFZO0lBQ2xELE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksRUFBQyxPQUFPLEVBQUMsS0FBSyxDQUFDLENBQUM7QUFDM0MsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLHdCQUFnQixHQUFHLFVBQVMsUUFBUTtJQUMzQyxJQUFJLFVBQVUsQ0FBQztJQUNmLFVBQVUsR0FBRyxPQUFPLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDdkQsTUFBTSxDQUFDLFVBQVUsQ0FBQztBQUN0QixDQUFDLENBQUM7QUFFRjs7Ozs7R0FLRztBQUNRLHdCQUFnQixHQUFHLFVBQVMsUUFBUSxFQUFDLFdBQXVCO0lBQXZCLDJCQUF1QixHQUF2Qix1QkFBdUI7SUFDbkUsSUFBSSxRQUFRLENBQUM7SUFDYixFQUFFLENBQUMsQ0FBQyxPQUFPLFdBQVcsSUFBSSxXQUFXLENBQUMsQ0FBQyxDQUFDO1FBQ3BDLFFBQVEsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUM5QyxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixRQUFRLEdBQUcsV0FBVyxDQUFDO0lBQzNCLENBQUM7SUFDRCxRQUFRLEdBQUcsUUFBUSxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyx3QkFBd0I7SUFDeEUsTUFBTSxDQUFDLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztRQUNmLEtBQUssS0FBSyxDQUFFO1FBQ1osS0FBSyxNQUFNO1lBQ1AsSUFBSSxDQUFDO2dCQUNELE1BQU0sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQztZQUM1RSxDQUFFO1lBQUEsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUEsQ0FBQztnQkFDUixPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxhQUFhLEdBQUcsUUFBUSxDQUFDLElBQUksR0FBRyx5QkFBeUIsQ0FBQyxDQUFDO1lBQ3ZGLENBQUM7WUFDRCxLQUFLLENBQUM7UUFDVixLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsUUFBUSxFQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQ2hEO1lBQ0ksT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsWUFBWSxHQUFHLFFBQVEsQ0FBQyxJQUFJLEdBQUcsZ0JBQWdCLENBQUMsQ0FBQztZQUN6RSxLQUFLLENBQUM7SUFDZCxDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBRUY7Ozs7O0dBS0c7QUFDUSx1QkFBZSxHQUFHLFVBQVMsV0FBVyxFQUFDLE9BQVk7SUFBWix1QkFBWSxHQUFaLFlBQVk7SUFDMUQsTUFBTSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLFdBQVcsRUFBQyxPQUFPLENBQUMsQ0FBQztBQUMzRCxDQUFDLENBQUM7QUFFRjs7OztHQUlHO0FBQ1EscUJBQWEsR0FBRyxVQUFTLElBQVc7SUFDM0MsTUFBTSxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLENBQUM7QUFDdkMsQ0FBQyxDQUFDIiwiZmlsZSI6InNtYXJ0ZmlsZS5zaW1wbGUuanMiLCJzb3VyY2VzQ29udGVudCI6WyIvLy8gPHJlZmVyZW5jZSBwYXRoPVwiLi90eXBpbmdzL21haW4uZC50c1wiIC8+XG5cbmltcG9ydCBwbHVnaW5zID0gcmVxdWlyZShcIi4vc21hcnRmaWxlLnBsdWdpbnNcIik7XG5cbmV4cG9ydCBsZXQgY29weSA9IGZ1bmN0aW9uKGZyb21Bcmc6c3RyaW5nLHRvQXJnOnN0cmluZyl7XG4gICAgcGx1Z2lucy5zaGVsbGpzLmNwKFwiLXJcIixmcm9tQXJnLHRvQXJnKTtcbn07XG5cbi8qKlxuICogcmVhZHMgYSBmaWxlIGNvbnRlbnQgdG8gYSBTdHJpbmdcbiAqIEBwYXJhbSBmaWxlUGF0aFxuICogQHJldHVybnMge3N0cmluZ3xCdWZmZXJ8YW55fVxuICovXG5leHBvcnQgbGV0IHJlYWRGaWxlVG9TdHJpbmcgPSBmdW5jdGlvbihmaWxlUGF0aCkge1xuICAgIGxldCBmaWxlU3RyaW5nO1xuICAgIGZpbGVTdHJpbmcgPSBwbHVnaW5zLmZzLnJlYWRGaWxlU3luYyhmaWxlUGF0aCwgXCJ1dGY4XCIpO1xuICAgIHJldHVybiBmaWxlU3RyaW5nO1xufTtcblxuLyoqXG4gKlxuICogQHBhcmFtIGZpbGVQYXRoXG4gKiBAcGFyYW0gZmlsZVR5cGVBcmdcbiAqIEByZXR1cm5zIHthbnl9XG4gKi9cbmV4cG9ydCBsZXQgcmVhZEZpbGVUb09iamVjdCA9IGZ1bmN0aW9uKGZpbGVQYXRoLGZpbGVUeXBlQXJnID0gdW5kZWZpbmVkKSB7XG4gICAgbGV0IGZpbGVUeXBlO1xuICAgIGlmICh0eXBlb2YgZmlsZVR5cGVBcmcgPT0gXCJ1bmRlZmluZWRcIikge1xuICAgICAgICBmaWxlVHlwZSA9IHBsdWdpbnMucGF0aC5leHRuYW1lKGZpbGVQYXRoKTtcbiAgICB9IGVsc2Uge1xuICAgICAgICBmaWxlVHlwZSA9IGZpbGVUeXBlQXJnO1xuICAgIH1cbiAgICBmaWxlVHlwZSA9IGZpbGVUeXBlLnJlcGxhY2UoL1xcLihbYS16XSopLyxcIiQxXCIpOyAvL3JlbW92ZSAuIGZvcm0gZmlsZVR5cGVcbiAgICBzd2l0Y2ggKGZpbGVUeXBlKSB7XG4gICAgICAgIGNhc2UgXCJ5bWxcIiA6XG4gICAgICAgIGNhc2UgXCJ5YW1sXCI6XG4gICAgICAgICAgICB0cnkge1xuICAgICAgICAgICAgICAgIHJldHVybiBwbHVnaW5zLnlhbWwuc2FmZUxvYWQocGx1Z2lucy5mcy5yZWFkRmlsZVN5bmMoZmlsZVBhdGgsICd1dGY4JykpO1xuICAgICAgICAgICAgfSBjYXRjaCAoZSl7XG4gICAgICAgICAgICAgICAgcGx1Z2lucy5iZWF1dHlsb2cuZXJyb3IoXCJjaGVjayB0aGF0IFwiICsgZmlsZVBhdGguYmx1ZSArIFwiIHBvaW50cyB0byBhIHZhbGlkIGZpbGVcIik7XG4gICAgICAgICAgICB9XG4gICAgICAgICAgICBicmVhaztcbiAgICAgICAgY2FzZSBcImpzb25cIjpcbiAgICAgICAgICAgIHJldHVybiBwbHVnaW5zLmZzLnJlYWRKc29uU3luYyhmaWxlUGF0aCx7fSk7XG4gICAgICAgIGRlZmF1bHQ6XG4gICAgICAgICAgICBwbHVnaW5zLmJlYXV0eWxvZy5lcnJvcihcImZpbGUgdHlwZSBcIiArIGZpbGVUeXBlLmJsdWUgKyBcIiBub3Qgc3VwcG9ydGVkXCIpO1xuICAgICAgICAgICAgYnJlYWs7XG4gICAgfVxufTtcblxuLyoqXG4gKlxuICogQHBhcmFtIGZpbGVQYXRoQXJnXG4gKiBAcGFyYW0gb3B0aW9uc1xuICogQHJldHVybnMge251bWJlcn1cbiAqL1xuZXhwb3J0IGxldCByZWFkRmlsZVRvVmlueWwgPSBmdW5jdGlvbihmaWxlUGF0aEFyZyxvcHRpb25zID0ge30pIHtcbiAgICByZXR1cm4gcGx1Z2lucy52aW55bEZpbGUucmVhZFN5bmMoZmlsZVBhdGhBcmcsb3B0aW9ucyk7XG59O1xuXG4vKipcbiAqIGxldHMgeW91IHJlbG9hZCBmaWxlcyBob3QuXG4gKiBAcGFyYW0gcGF0aFxuICogQHJldHVybnMge2FueX1cbiAqL1xuZXhwb3J0IGxldCByZXF1aXJlUmVsb2FkID0gZnVuY3Rpb24ocGF0aDpzdHJpbmcpe1xuICAgIHJldHVybiBwbHVnaW5zLnJlcXVpcmVSZWxvYWQocGF0aCk7XG59OyJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
9
npmextra.json
Normal file
9
npmextra.json
Normal file
@ -0,0 +1,9 @@
|
||||
{
|
||||
"npmts":{
|
||||
"mode":"default",
|
||||
"coverageTreshold":70
|
||||
},
|
||||
"npmdocker":{
|
||||
|
||||
}
|
||||
}
|
@ -1,4 +0,0 @@
|
||||
{
|
||||
"mode":"default",
|
||||
"coveralls":true
|
||||
}
|
33
package.json
33
package.json
@ -1,8 +1,9 @@
|
||||
{
|
||||
"name": "smartfile",
|
||||
"version": "0.1.0",
|
||||
"version": "4.1.4",
|
||||
"description": "offers smart ways to work with files in nodejs",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
"test": "(npmts)",
|
||||
"reinstall": "(rm -r node_modules && npm install)",
|
||||
@ -12,7 +13,7 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/pushrocks/smartfile.git"
|
||||
"url": "https://gitlab.com/pushrocks/smartfile.git"
|
||||
},
|
||||
"keywords": [
|
||||
"filesystem",
|
||||
@ -21,21 +22,27 @@
|
||||
"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": {
|
||||
"beautylog": "3.1.2",
|
||||
"fs-extra": "0.26.5",
|
||||
"js-yaml": "3.5.4",
|
||||
"q": "1.4.1",
|
||||
"@types/fs-extra": "0.x.x",
|
||||
"@types/vinyl": "^2.0.0",
|
||||
"fs-extra": "^2.0.0",
|
||||
"glob": "^7.1.1",
|
||||
"js-yaml": "^3.7.0",
|
||||
"request": "^2.79.0",
|
||||
"require-reload": "0.2.2",
|
||||
"shelljs": "^0.6.0",
|
||||
"vinyl": "1.1.1",
|
||||
"vinyl-file": "2.0.0"
|
||||
"smartpath": "^3.2.7",
|
||||
"smartq": "^1.0.4",
|
||||
"typings-global": "^1.0.14",
|
||||
"vinyl": "^2.0.1",
|
||||
"vinyl-file": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"npmts": "3.4.1",
|
||||
"should": "^8.2.2"
|
||||
"gulp-function": "^2.2.3",
|
||||
"npmts-g": "^6.0.0",
|
||||
"smartchai": "^1.0.1",
|
||||
"typings-test": "^1.0.3"
|
||||
}
|
||||
}
|
||||
|
1
test/test.d.ts
vendored
Normal file
1
test/test.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
import 'typings-test';
|
248
test/test.js
248
test/test.js
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
285
test/test.ts
285
test/test.ts
@ -1,66 +1,227 @@
|
||||
/// <reference path="../ts/typings/main.d.ts" />
|
||||
var smartfile = require("../dist/index.js");
|
||||
var beautylog = require("beautylog");
|
||||
var should = require("should");
|
||||
var vinyl = require("vinyl");
|
||||
import 'typings-test'
|
||||
import * as smartfile from '../dist/index'
|
||||
import path = require('path')
|
||||
|
||||
describe("smartfile",function(){
|
||||
describe(".readFileToString".yellow,function(){
|
||||
it("should read a file to a string",function(){
|
||||
should.equal(
|
||||
smartfile.readFileToString("./test/mytest.txt"),
|
||||
"Some TestString &&%$"
|
||||
);
|
||||
});
|
||||
});
|
||||
describe(".readFileToObject".yellow,function(){
|
||||
it("should read an " + ".yaml".blue + " file to an object",function(){
|
||||
var testData = smartfile.readFileToObject("./test/mytest.yaml");
|
||||
testData.should.have.property("key1","this works");
|
||||
testData.should.have.property("key2","this works too");
|
||||
import { expect } from 'smartchai'
|
||||
|
||||
});
|
||||
it("should state unknown file type for unknown file types",function(){
|
||||
var testData = smartfile.readFileToObject("./test/mytest.txt");
|
||||
});
|
||||
it("should read an " + ".json".blue + " file to an object",function(){
|
||||
var testData = smartfile.readFileToObject("./test/mytest.json");
|
||||
testData.should.have.property("key1","this works");
|
||||
testData.should.have.property("key2","this works too");
|
||||
import * as vinyl from 'vinyl'
|
||||
|
||||
});
|
||||
});
|
||||
describe(".readFileToVinyl".yellow,function(){
|
||||
it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan,function(){
|
||||
var testData = smartfile.readFileToVinyl("./test/mytest.json");
|
||||
(vinyl.isVinyl(testData)).should.be.true();
|
||||
|
||||
});
|
||||
});
|
||||
describe(".checks".yellow,function(){
|
||||
describe(".fileExistsSync".yellow,function(){
|
||||
it("should return an accurate boolean",function(){
|
||||
(smartfile.checks.fileExistsSync("./test/mytest.json")).should.be.true();
|
||||
(smartfile.checks.fileExistsSync("./test/notthere.json")).should.be.false();
|
||||
});
|
||||
});
|
||||
describe(".fileExists".yellow,function(){
|
||||
it("should return a working promise",function(){
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.Promise();
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.fulfilled();
|
||||
(smartfile.checks.fileExists("./test/notthere.json")).should.not.be.fulfilled();
|
||||
});
|
||||
describe('smartfile', function () {
|
||||
describe('.fs', function () {
|
||||
describe('.fileExistsSync', function () {
|
||||
it('should return an accurate boolean', function () {
|
||||
expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true
|
||||
expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false
|
||||
})
|
||||
})
|
||||
});
|
||||
describe("copy",function(){
|
||||
it("should copy a directory",function(){
|
||||
smartfile.copy("./test/testfolder/","./test/assets/")
|
||||
});
|
||||
it("should copy a file",function(){
|
||||
smartfile.copy("./test/mytest.yaml","./test/assets/")
|
||||
});
|
||||
it("should copy a file and rename it",function(){
|
||||
smartfile.copy("./test/mytest.yaml","./test/assets/mytestRenamed.yaml")
|
||||
});
|
||||
});
|
||||
});
|
||||
describe('.fileExists', function () {
|
||||
it('should return a working promise', function () {
|
||||
expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.a('promise')
|
||||
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 () {
|
||||
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) {
|
||||
smartfile.fs.listFolders('./test/')
|
||||
.then(function (folderArrayArg) {
|
||||
expect(folderArrayArg).to.deep.include('testfolder')
|
||||
expect(folderArrayArg).to.not.deep.include('notExistentFolder')
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
describe('.listFilesSync()', function () {
|
||||
it('should get the file type from a string', function () {
|
||||
expect(smartfile.fs.listFilesSync('./test/')).to.deep.include('mytest.json')
|
||||
expect(smartfile.fs.listFilesSync('./test/')).to.not.deep.include('notExistentFile')
|
||||
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')
|
||||
})
|
||||
})
|
||||
describe('.listFiles()', function () {
|
||||
it('should get the file type from a string', function (done) {
|
||||
smartfile.fs.listFiles('./test/')
|
||||
.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 () {
|
||||
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')
|
||||
|
||||
})
|
||||
it('should state unknown file type for unknown file types', function () {
|
||||
let testData = smartfile.fs.toObjectSync('./test/mytest.txt')
|
||||
})
|
||||
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('.memory', function () {
|
||||
describe('.toGulpStream()', function () {
|
||||
it('should produce a valid gulp stream', function () {
|
||||
let localArray = ['test1', 'test2', 'test3']
|
||||
smartfile.memory.toGulpStream(localArray)
|
||||
})
|
||||
})
|
||||
describe('toVinylFileSync()', function () {
|
||||
it('should produce a vinylFile', function () {
|
||||
let localString = 'myString'
|
||||
let localOptions = { filename: 'vinylfile2', base: '/someDir' }
|
||||
expect(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).to.be.true
|
||||
})
|
||||
})
|
||||
describe('toVinylArraySync()', function () {
|
||||
it('should produce a an array of vinylfiles', function () {
|
||||
let localStringArray = ['string1', 'string2', 'string3']
|
||||
let localOptions = { filename: 'vinylfile2', base: '/someDir' }
|
||||
let testResult = smartfile.memory.toVinylArraySync(localStringArray, localOptions)
|
||||
expect(testResult).to.be.a('array')
|
||||
expect(testResult.length === 3).to.be.true
|
||||
for (let myKey in testResult) {
|
||||
expect(testResult[myKey] instanceof vinyl).to.be.true
|
||||
}
|
||||
})
|
||||
})
|
||||
describe('vinylToStringSync()', function () {
|
||||
it('should produce a String from vinyl file', function () {
|
||||
let localString = smartfile.memory.vinylToStringSync(new vinyl({
|
||||
base: '/',
|
||||
path: '/test.txt',
|
||||
contents: new Buffer('myString')
|
||||
}))
|
||||
expect(localString).equal('myString')
|
||||
})
|
||||
})
|
||||
describe('toFs()', function () {
|
||||
it('should write a file to disk and return a promise', function (done) {
|
||||
let localString = 'myString'
|
||||
smartfile.memory.toFs(
|
||||
localString,
|
||||
path.join(process.cwd(), './test/temp/testMemToFs.txt')
|
||||
).then(done)
|
||||
})
|
||||
})
|
||||
describe('toFsSync()', function () {
|
||||
it('should write a file to disk and return true if successfull', function () {
|
||||
let localString = 'myString'
|
||||
smartfile.memory.toFsSync(
|
||||
localString,
|
||||
path.join(process.cwd(), './test/temp/testMemToFsSync.txt')
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
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()
|
||||
}
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
26
ts/index.ts
26
ts/index.ts
@ -1,17 +1,15 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import 'typings-global'
|
||||
|
||||
import plugins = require("./smartfile.plugins");
|
||||
import SmartfileChecks = require("./smartfile.checks");
|
||||
import SmartfileSimple = require("./smartfile.simple");
|
||||
import * as plugins from './smartfile.plugins'
|
||||
import * as SmartfileFs from './smartfile.fs'
|
||||
import * as SmartfileInterpreter from './smartfile.interpreter'
|
||||
import * as SmartfileMemory from './smartfile.memory'
|
||||
import * as SmartfileRemote from './smartfile.remote'
|
||||
|
||||
export {Smartfile} from './smartfile.classes.smartfile'
|
||||
|
||||
var smartfile:any = {
|
||||
copy: SmartfileSimple.copy,
|
||||
checks: SmartfileChecks,
|
||||
readFileToString: SmartfileSimple.readFileToString,
|
||||
readFileToObject: SmartfileSimple.readFileToObject,
|
||||
readFileToVinyl: SmartfileSimple.readFileToVinyl,
|
||||
requireReload: SmartfileSimple.requireReload
|
||||
};
|
||||
|
||||
export = smartfile;
|
||||
export let fs = SmartfileFs
|
||||
export let interpreter = SmartfileInterpreter
|
||||
export let memory = SmartfileMemory
|
||||
export let remote = SmartfileRemote
|
||||
export let requireReload = SmartfileFs.requireReload
|
||||
|
@ -1,32 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./smartfile.plugins");
|
||||
|
||||
/**
|
||||
*
|
||||
* @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;
|
||||
};
|
5
ts/smartfile.classes.smartfile.ts
Normal file
5
ts/smartfile.classes.smartfile.ts
Normal file
@ -0,0 +1,5 @@
|
||||
export class Smartfile {
|
||||
constructor() {
|
||||
|
||||
}
|
||||
}
|
356
ts/smartfile.fs.ts
Normal file
356
ts/smartfile.fs.ts
Normal file
@ -0,0 +1,356 @@
|
||||
import 'typings-global'
|
||||
|
||||
import plugins = require('./smartfile.plugins')
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
import * as memory from './smartfile.memory'
|
||||
/*===============================================================
|
||||
============================ Checks =============================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export let fileExistsSync = function(filePath): boolean {
|
||||
let fileExistsBool: boolean = false
|
||||
try {
|
||||
plugins.fsExtra.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, 4, function (err) {
|
||||
err ? done.reject(err) : done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if given path points to an existing directory
|
||||
*/
|
||||
export let isDirectory = function(pathArg): boolean{
|
||||
return plugins.fsExtra.statSync(pathArg).isDirectory()
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a given path points to an existing file
|
||||
*/
|
||||
export let isFile = function(pathArg): boolean{
|
||||
return plugins.fsExtra.statSync(pathArg).isFile()
|
||||
}
|
||||
|
||||
/*===============================================================
|
||||
============================ FS ACTIONS =========================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
export let copy = function(fromArg: string, toArg: string){
|
||||
let done = plugins.q.defer()
|
||||
plugins.fsExtra.copy(fromArg,toArg,{},function(){
|
||||
done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
||||
*/
|
||||
export let copySync = function(fromArg: string,toArg: string): boolean{
|
||||
plugins.fsExtra.copySync(fromArg,toArg)
|
||||
return true
|
||||
}
|
||||
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export let ensureDir = (dirPathArg: string) => {
|
||||
let done = plugins.q.defer()
|
||||
plugins.fsExtra.ensureDir(dirPathArg,done.resolve)
|
||||
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
|
||||
*/
|
||||
export let removeSync = function(pathArg: string): boolean{
|
||||
plugins.fsExtra.removeSync(pathArg)
|
||||
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 =========================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param fileTypeArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export let toObjectSync = function(filePathArg,fileTypeArg?) {
|
||||
let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8')
|
||||
let fileType
|
||||
fileTypeArg ? fileType = fileTypeArg : fileType = SmartfileInterpreter.filetype(filePathArg)
|
||||
return SmartfileInterpreter.objectFile(fileString,fileType)
|
||||
}
|
||||
|
||||
/**
|
||||
* reads a file content to a String
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
export let toStringSync = function(filePath) {
|
||||
let fileString
|
||||
fileString = plugins.fsExtra.readFileSync(filePath, 'utf8')
|
||||
return fileString
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param options
|
||||
* @returns {number}
|
||||
*/
|
||||
export let toVinylSync = function(filePathArg,options = {}) {
|
||||
return plugins.vinylFile.readSync(filePathArg,options)
|
||||
}
|
||||
|
||||
/**
|
||||
* lets you reload files hot.
|
||||
* @param path
|
||||
* @returns {any}
|
||||
*/
|
||||
export let requireReload = function(path: string){
|
||||
return plugins.requireReload(path)
|
||||
}
|
||||
|
||||
/**
|
||||
* lists Folders in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listFolders = function(pathArg: string,regexFilter?: RegExp){
|
||||
let done = plugins.q.defer()
|
||||
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.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: string,regexFilter?: RegExp): string[]{
|
||||
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory()
|
||||
})
|
||||
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.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
|
||||
})
|
||||
if (regexFilter) {
|
||||
fileArray = fileArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
done.resolve(fileArray)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
|
||||
})
|
||||
if (regexFilter) {
|
||||
fileArray = fileArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
return fileArray
|
||||
}
|
||||
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns Promise<string[]>
|
||||
*/
|
||||
export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
|
||||
let done = plugins.q.defer<string[]>()
|
||||
let allItmesArray = plugins.fsExtra.readdirSync(pathArg)
|
||||
if (regexFilter) {
|
||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
};
|
||||
done.resolve(allItmesArray)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
* @executes SYNC
|
||||
*/
|
||||
export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): string[]{
|
||||
let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
|
||||
})
|
||||
if (regexFilter) {
|
||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
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
|
||||
}
|
22
ts/smartfile.interpreter.ts
Normal file
22
ts/smartfile.interpreter.ts
Normal file
@ -0,0 +1,22 @@
|
||||
import 'typings-global'
|
||||
|
||||
import plugins = require('./smartfile.plugins')
|
||||
|
||||
export let filetype = (pathArg: string): string => {
|
||||
let extName = plugins.path.extname(pathArg)
|
||||
let fileType = extName.replace(/\.([a-z]*)/,'$1') // remove . form fileType
|
||||
return fileType
|
||||
}
|
||||
|
||||
export let objectFile = (fileStringArg: string, fileTypeArg) => {
|
||||
switch (fileTypeArg) {
|
||||
case 'yml' :
|
||||
case 'yaml':
|
||||
return plugins.yaml.safeLoad(fileStringArg)
|
||||
case 'json':
|
||||
return JSON.parse(fileStringArg)
|
||||
default:
|
||||
console.error('file type ' + fileTypeArg.blue + ' not supported')
|
||||
break
|
||||
}
|
||||
}
|
150
ts/smartfile.memory.ts
Normal file
150
ts/smartfile.memory.ts
Normal file
@ -0,0 +1,150 @@
|
||||
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
|
||||
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
|
||||
* @param fileArg
|
||||
* @returns stream.Readable
|
||||
* @TODO: make it async;
|
||||
*/
|
||||
export let toGulpStream = function(fileArg: string|string[]|IVinylFile|IVinylFile[],baseArg: string = '/'){
|
||||
let fileArray = []
|
||||
|
||||
if (typeof fileArg === 'string' || vinyl.isVinyl(fileArg)) { // make sure we work with an array later on
|
||||
fileArray.push(fileArg)
|
||||
} else if (Array.isArray(fileArg)) {
|
||||
fileArray = fileArg
|
||||
} else {
|
||||
throw new Error('fileArg has unknown format')
|
||||
}
|
||||
|
||||
let vinylFileArray: IVinylFile[] = [] // we want to have an array of vinylFiles
|
||||
|
||||
for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
|
||||
let file = fileArray[fileIndexArg]
|
||||
file instanceof vinyl ?
|
||||
vinylFileArray.push(file) :
|
||||
vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
|
||||
};
|
||||
|
||||
let stream = new Readable({ objectMode: true })
|
||||
for (let vinylFileIndexArg in vinylFileArray) {
|
||||
let vinylFile = vinylFileArray[vinylFileIndexArg]
|
||||
stream.push(vinylFile)
|
||||
};
|
||||
stream.push(null) // signal end of stream;
|
||||
return stream
|
||||
}
|
||||
|
||||
/**
|
||||
* converts file to Object
|
||||
* @param fileStringArg
|
||||
* @param fileTypeArg
|
||||
* @returns {any|any}
|
||||
*/
|
||||
export let toObject = function(fileStringArg: string,fileTypeArg: string){
|
||||
return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
|
||||
}
|
||||
|
||||
/**
|
||||
* takes a string and converts it to vinyl file
|
||||
* @param fileArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}) {
|
||||
optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
|
||||
optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
|
||||
optionsArg.base ? void(0) : optionsArg.base = '/'
|
||||
optionsArg.relPath ? void('0') : optionsArg.relPath = ''
|
||||
let vinylFile = new vinyl({
|
||||
base: optionsArg.base,
|
||||
path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
|
||||
contents: new Buffer(fileArg)
|
||||
})
|
||||
return vinylFile
|
||||
}
|
||||
|
||||
/**
|
||||
* takes a string array and some options and returns a vinylfile array
|
||||
* @param arrayArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export let toVinylArraySync = function(
|
||||
arrayArg: string[],
|
||||
optionsArg?: {
|
||||
filename?: string,
|
||||
base?: string,
|
||||
relPath?: string
|
||||
}
|
||||
){
|
||||
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
|
||||
*/
|
||||
export let vinylToStringSync = function(fileArg: IVinylFile): string {
|
||||
return fileArg.contents.toString('utf8')
|
||||
}
|
||||
|
||||
/**
|
||||
* writes string or vinyl file to disk.
|
||||
* @param fileArg
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export let toFs = function(fileContentArg: string|IVinylFile,filePathArg){
|
||||
let done = plugins.q.defer()
|
||||
|
||||
// function checks to abort if needed
|
||||
if (!fileContentArg || !filePathArg) {
|
||||
throw new Error('expected valid arguments')
|
||||
}
|
||||
|
||||
// prepare actual write action
|
||||
let fileString: string
|
||||
let filePath: string = filePathArg
|
||||
if (vinyl.isVinyl(fileContentArg)) {
|
||||
let fileContentArg2: any = fileContentArg
|
||||
fileString = vinylToStringSync(fileContentArg2)
|
||||
} else if (typeof fileContentArg === 'string') {
|
||||
fileString = fileContentArg
|
||||
}
|
||||
plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let toFsSync = function(fileArg,filePathArg: string){
|
||||
// function checks to abort if needed
|
||||
if (!fileArg || !filePathArg) {
|
||||
throw new Error('expected a valid arguments')
|
||||
}
|
||||
|
||||
// prepare actual write action
|
||||
let fileString: string
|
||||
let filePath: string = filePathArg
|
||||
|
||||
if (typeof fileArg !== 'string') {
|
||||
fileString = vinylToStringSync(fileArg)
|
||||
} else if (typeof fileArg === 'string') {
|
||||
fileString = fileArg
|
||||
}
|
||||
plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
|
||||
}
|
@ -1,10 +1,11 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
export let beautylog = require("beautylog");
|
||||
export let fs = require("fs-extra");
|
||||
export let path = require("path");
|
||||
export let q = require("q");
|
||||
export let vinyl = require("vinyl");
|
||||
export let vinylFile = require("vinyl-file");
|
||||
export let yaml = require("js-yaml");
|
||||
export let requireReload = require("require-reload");
|
||||
export let shelljs = require("shelljs");
|
||||
import 'typings-global'
|
||||
export import fs = require('fs')
|
||||
export import fsExtra = require('fs-extra')
|
||||
export let glob = require('glob')
|
||||
export import path = require('path')
|
||||
export import q = require('smartq')
|
||||
export let request = require('request')
|
||||
export let requireReload = require('require-reload')
|
||||
export import smartpath = require('smartpath')
|
||||
export let vinylFile = require('vinyl-file')
|
||||
export let yaml = require('js-yaml')
|
||||
|
52
ts/smartfile.remote.ts
Normal file
52
ts/smartfile.remote.ts
Normal file
@ -0,0 +1,52 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./smartfile.plugins')
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
|
||||
export let toFs = function(from: string,toPath: string) {
|
||||
let done = plugins.q.defer()
|
||||
let stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath))
|
||||
stream.on('finish',function(){
|
||||
done.resolve(toPath)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export let toObject = function(fromArg: string){
|
||||
let done = plugins.q.defer()
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
let returnObject
|
||||
if (!error && response.statusCode === 200) {
|
||||
returnObject = SmartfileInterpreter.objectFile(bodyString,SmartfileInterpreter.filetype(fromArg))
|
||||
done.resolve(returnObject)
|
||||
} else {
|
||||
console.log('could not get remote file from ' + fromArg)
|
||||
returnObject = undefined
|
||||
done.reject(returnObject)
|
||||
}
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export let toString = (fromArg: string) => {
|
||||
let done = plugins.q.defer()
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
if (!error && response.statusCode === 200) {
|
||||
done.resolve(bodyString)
|
||||
} else {
|
||||
console.error('could not get remote file from ' + fromArg)
|
||||
bodyString = undefined
|
||||
done.reject(bodyString)
|
||||
}
|
||||
})
|
||||
return done.promise
|
||||
}
|
@ -1,68 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
|
||||
import plugins = require("./smartfile.plugins");
|
||||
|
||||
export let copy = function(fromArg:string,toArg:string){
|
||||
plugins.shelljs.cp("-r",fromArg,toArg);
|
||||
};
|
||||
|
||||
/**
|
||||
* reads a file content to a String
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
export let readFileToString = function(filePath) {
|
||||
let fileString;
|
||||
fileString = plugins.fs.readFileSync(filePath, "utf8");
|
||||
return fileString;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
* @param fileTypeArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export let readFileToObject = function(filePath,fileTypeArg = undefined) {
|
||||
let fileType;
|
||||
if (typeof fileTypeArg == "undefined") {
|
||||
fileType = plugins.path.extname(filePath);
|
||||
} else {
|
||||
fileType = fileTypeArg;
|
||||
}
|
||||
fileType = fileType.replace(/\.([a-z]*)/,"$1"); //remove . form fileType
|
||||
switch (fileType) {
|
||||
case "yml" :
|
||||
case "yaml":
|
||||
try {
|
||||
return plugins.yaml.safeLoad(plugins.fs.readFileSync(filePath, 'utf8'));
|
||||
} catch (e){
|
||||
plugins.beautylog.error("check that " + filePath.blue + " points to a valid file");
|
||||
}
|
||||
break;
|
||||
case "json":
|
||||
return plugins.fs.readJsonSync(filePath,{});
|
||||
default:
|
||||
plugins.beautylog.error("file type " + fileType.blue + " not supported");
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @param options
|
||||
* @returns {number}
|
||||
*/
|
||||
export let readFileToVinyl = function(filePathArg,options = {}) {
|
||||
return plugins.vinylFile.readSync(filePathArg,options);
|
||||
};
|
||||
|
||||
/**
|
||||
* lets you reload files hot.
|
||||
* @param path
|
||||
* @returns {any}
|
||||
*/
|
||||
export let requireReload = function(path:string){
|
||||
return plugins.requireReload(path);
|
||||
};
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"browserify": "github:DefinitelyTyped/DefinitelyTyped/browserify/browserify.d.ts",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts",
|
||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
||||
"node": "registry:dt/node#4.0.0+20160311162451"
|
||||
}
|
||||
}
|
3
tslint.json
Normal file
3
tslint.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "tslint-config-standard"
|
||||
}
|
Reference in New Issue
Block a user