Compare commits
214 Commits
Author | SHA1 | Date | |
---|---|---|---|
818767b7cc | |||
52367f5c1a | |||
b6b2101054 | |||
e322a41c45 | |||
f5e2c0c7d7 | |||
6733a156b8 | |||
ebac45a152 | |||
92ac410b96 | |||
078bdda803 | |||
7b87adf3d9 | |||
908db4d847 | |||
87d047af42 | |||
610a70079d | |||
2c24cdc9f4 | |||
459bd662f4 | |||
0613b7c3ed | |||
d78ee87a82 | |||
fadf8782df | |||
8fcdc5ce44 | |||
878da9ff3a | |||
168136bebb | |||
16cecbefac | |||
24b890956e | |||
fe73e8edf7 | |||
5b2089044d | |||
9fa98c3804 | |||
f49c5af339 | |||
61a6cfd452 | |||
769a1a707e | |||
0408cff3fc | |||
533d71a6cd | |||
b3fd13506c | |||
4052337626 | |||
d823229bee | |||
5bdc6e1dc9 | |||
625f540978 | |||
459d2531b4 | |||
b5993560b1 | |||
b800957f19 | |||
d79e1180d8 | |||
ac99ecf743 | |||
897a46e12d | |||
64219f8f09 | |||
42c6c1eec5 | |||
ef3ca28a66 | |||
3beff3320c | |||
0343287775 | |||
e4180022b1 | |||
7909bd1a38 | |||
495c3afdc3 | |||
73ad2d6193 | |||
f5ffb7fc67 | |||
36364bb490 | |||
52f8fd2469 | |||
65dda3bcf1 | |||
d29dcc5a1c | |||
d22e0cde8f | |||
c8a21e8228 | |||
72bb3f33ac | |||
7694cc9c08 | |||
679c870229 | |||
30bc489822 | |||
5493d3cd5d | |||
bd50c122eb | |||
51f9d76a64 | |||
c2f809f9cf | |||
9f311984ac | |||
7515ecf9ce | |||
fb9766e93b | |||
9cfd147fdc | |||
18ff99aef7 | |||
46b1151201 | |||
8e19586e47 | |||
9fc581b866 | |||
dcc85a56b8 | |||
4899d454eb | |||
9d02fccc01 | |||
a5b24a7c33 | |||
06fb0acd52 | |||
97bf5ff74b | |||
531f169c11 | |||
e25675cc49 | |||
32cdac5b38 | |||
7457093476 | |||
f560b6b7bb | |||
ed01ebeee8 | |||
7eed9dd6d3 | |||
d9852e18a5 | |||
0be281746d | |||
6ac60cb3a5 | |||
eb3c720d4e | |||
c29084f000 | |||
b53240a2ea | |||
2ba39cf2ac | |||
675934d049 | |||
dda4c1af07 | |||
214bae9931 | |||
fde809eb02 | |||
9f3a71f0b9 | |||
e9c9e95118 | |||
943a0c30c2 | |||
2dad3707ee | |||
cd35d110a9 | |||
257939462b | |||
8104188b90 | |||
02842f1d0f | |||
f753c2c491 | |||
4ecb817bac | |||
909fcd6e2a | |||
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 |
11
.gitignore
vendored
11
.gitignore
vendored
@ -1,12 +1,7 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
.settings/
|
|
||||||
.idea/
|
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
pages/
|
||||||
|
public/
|
||||||
|
|
||||||
ts/*.js
|
test/temp/
|
||||||
ts/*.js.map
|
|
||||||
ts/typings/
|
|
||||||
|
|
||||||
test/assets/
|
|
||||||
|
|
||||||
|
137
.gitlab-ci.yml
Normal file
137
.gitlab-ci.yml
Normal file
@ -0,0 +1,137 @@
|
|||||||
|
# gitzone standard
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: "$CI_BUILD_STAGE"
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
snyk:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install -g snyk
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command snyk test
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
testLEGACY:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install legacy
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
testLTS:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
testSTABLE:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
image: docker:stable
|
||||||
|
allow_failure: true
|
||||||
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
|
script:
|
||||||
|
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||||
|
- docker run
|
||||||
|
--env SOURCE_CODE="$PWD"
|
||||||
|
--volume "$PWD":/code
|
||||||
|
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||||
|
artifacts:
|
||||||
|
paths: [codeclimate.json]
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g typedoc typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
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=
|
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2015 Push.Rocks
|
Copyright (c) 2015 Lossless GmbH
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
44
README.md
44
README.md
@ -1,11 +1,43 @@
|
|||||||
# smartfile
|
# @pushrocks/smartfile
|
||||||
|
|
||||||
make files easily accessible for processing in javascript.
|
make files easily accessible for processing in javascript.
|
||||||
|
|
||||||
## Status
|
## Availabililty
|
||||||
[](https://travis-ci.org/pushrocks/smartfile)
|
|
||||||
|
[](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/master/dependencies/npm)
|
||||||
[](https://www.bithound.io/github/pushrocks/smartfile)
|
[](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:
|
## Usage
|
||||||
* .yml .yaml
|
|
||||||
* .json
|
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 further information read the linked docs at the top of this README.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
||||||
|
10
dist/index.d.ts
vendored
Normal file
10
dist/index.d.ts
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
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";
|
"use strict";
|
||||||
var SmartfileChecks = require("./smartfile.checks");
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
var SmartfileSimple = require("./smartfile.simple");
|
const SmartfileFs = require("./smartfile.fs");
|
||||||
var smartfile = {
|
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||||
copy: SmartfileSimple.copy,
|
const SmartfileMemory = require("./smartfile.memory");
|
||||||
checks: SmartfileChecks,
|
const SmartfileRemote = require("./smartfile.remote");
|
||||||
readFileToString: SmartfileSimple.readFileToString,
|
var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
|
||||||
readFileToObject: SmartfileSimple.readFileToObject,
|
exports.Smartfile = smartfile_classes_smartfile_1.Smartfile;
|
||||||
readFileToVinyl: SmartfileSimple.readFileToVinyl,
|
exports.fs = SmartfileFs;
|
||||||
requireReload: SmartfileSimple.requireReload
|
exports.interpreter = SmartfileInterpreter;
|
||||||
};
|
exports.memory = SmartfileMemory;
|
||||||
module.exports = smartfile;
|
exports.remote = SmartfileRemote;
|
||||||
|
exports.requireReload = SmartfileFs.requireReload;
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0Qzs7QUFHNUMsSUFBTyxlQUFlLFdBQVcsb0JBQW9CLENBQUMsQ0FBQztBQUN2RCxJQUFPLGVBQWUsV0FBVyxvQkFBb0IsQ0FBQyxDQUFDO0FBR3ZELElBQUksU0FBUyxHQUFPO0lBQ2hCLElBQUksRUFBRSxlQUFlLENBQUMsSUFBSTtJQUMxQixNQUFNLEVBQUUsZUFBZTtJQUN2QixnQkFBZ0IsRUFBRSxlQUFlLENBQUMsZ0JBQWdCO0lBQ2xELGdCQUFnQixFQUFFLGVBQWUsQ0FBQyxnQkFBZ0I7SUFDbEQsZUFBZSxFQUFFLGVBQWUsQ0FBQyxlQUFlO0lBQ2hELGFBQWEsRUFBRSxlQUFlLENBQUMsYUFBYTtDQUMvQyxDQUFDO0FBRUYsaUJBQVMsU0FBUyxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxuXG5pbXBvcnQgcGx1Z2lucyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZmlsZS5wbHVnaW5zXCIpO1xuaW1wb3J0IFNtYXJ0ZmlsZUNoZWNrcyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZmlsZS5jaGVja3NcIik7XG5pbXBvcnQgU21hcnRmaWxlU2ltcGxlID0gcmVxdWlyZShcIi4vc21hcnRmaWxlLnNpbXBsZVwiKTtcblxuXG52YXIgc21hcnRmaWxlOmFueSA9IHtcbiAgICBjb3B5OiBTbWFydGZpbGVTaW1wbGUuY29weSxcbiAgICBjaGVja3M6IFNtYXJ0ZmlsZUNoZWNrcyxcbiAgICByZWFkRmlsZVRvU3RyaW5nOiBTbWFydGZpbGVTaW1wbGUucmVhZEZpbGVUb1N0cmluZyxcbiAgICByZWFkRmlsZVRvT2JqZWN0OiBTbWFydGZpbGVTaW1wbGUucmVhZEZpbGVUb09iamVjdCxcbiAgICByZWFkRmlsZVRvVmlueWw6IFNtYXJ0ZmlsZVNpbXBsZS5yZWFkRmlsZVRvVmlueWwsXG4gICAgcmVxdWlyZVJlbG9hZDogU21hcnRmaWxlU2ltcGxlLnJlcXVpcmVSZWxvYWRcbn07XG5cbmV4cG9ydCA9IHNtYXJ0ZmlsZTtcbiJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDhDQUE4QztBQUM5QyxnRUFBZ0U7QUFDaEUsc0RBQXNEO0FBQ3RELHNEQUFzRDtBQUV0RCw2RUFBMEQ7QUFBakQsa0RBQUEsU0FBUyxDQUFBO0FBRVAsUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFDO0FBQ2pCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFDO0FBQ25DLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQztBQUN6QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUM7QUFDekIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyJ9
|
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=
|
|
79
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
79
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
@ -0,0 +1,79 @@
|
|||||||
|
/// <reference types="node" />
|
||||||
|
import * as plugins from './smartfile.plugins';
|
||||||
|
export interface ISmartfileConstructorOptions {
|
||||||
|
path?: string;
|
||||||
|
contentString?: string;
|
||||||
|
contentBuffer?: Buffer;
|
||||||
|
base?: string;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* class Smartfile
|
||||||
|
* -> is vinyl file compatible
|
||||||
|
*/
|
||||||
|
export declare class Smartfile {
|
||||||
|
/**
|
||||||
|
* the full path of the file on disk
|
||||||
|
*/
|
||||||
|
path: string;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
parsedPath: plugins.path.ParsedPath;
|
||||||
|
/**
|
||||||
|
* the content of the file as Buffer
|
||||||
|
*/
|
||||||
|
contentBuffer: Buffer;
|
||||||
|
/**
|
||||||
|
* The current working directory of the file
|
||||||
|
* Note:this is similar to gulp and different from native node path base
|
||||||
|
*/
|
||||||
|
base: string;
|
||||||
|
/**
|
||||||
|
* sync the file with disk
|
||||||
|
*/
|
||||||
|
sync: boolean;
|
||||||
|
/**
|
||||||
|
* the constructor of Smartfile
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
constructor(optionsArg: ISmartfileConstructorOptions);
|
||||||
|
/**
|
||||||
|
* set contents from string
|
||||||
|
* @param contentString
|
||||||
|
*/
|
||||||
|
setContentsFromString(contentString: string): void;
|
||||||
|
/**
|
||||||
|
* write file to disk
|
||||||
|
* Behaviours:
|
||||||
|
* - no argument write to exactly where the file was picked up
|
||||||
|
*/
|
||||||
|
write(pathArg?: string): Promise<void>;
|
||||||
|
/**
|
||||||
|
* read file from disk
|
||||||
|
*/
|
||||||
|
read(): Promise<void>;
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility: alias of this.contentBuffer
|
||||||
|
*/
|
||||||
|
contents: Buffer;
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility
|
||||||
|
*/
|
||||||
|
readonly cwd: string;
|
||||||
|
/**
|
||||||
|
* return relative path of file
|
||||||
|
*/
|
||||||
|
readonly relative: string;
|
||||||
|
/**
|
||||||
|
* return truw when the file has content
|
||||||
|
*/
|
||||||
|
isNull(): boolean;
|
||||||
|
/**
|
||||||
|
* return true if contents are Buffer
|
||||||
|
*/
|
||||||
|
isBuffer(): boolean;
|
||||||
|
isDirectory(): boolean;
|
||||||
|
isStream(): boolean;
|
||||||
|
isSymbolic(): boolean;
|
||||||
|
updateFileName(fileNameArg: string): void;
|
||||||
|
}
|
118
dist/smartfile.classes.smartfile.js
vendored
Normal file
118
dist/smartfile.classes.smartfile.js
vendored
Normal file
@ -0,0 +1,118 @@
|
|||||||
|
"use strict";
|
||||||
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const plugins = require("./smartfile.plugins");
|
||||||
|
const memory = require("./smartfile.memory");
|
||||||
|
/**
|
||||||
|
* class Smartfile
|
||||||
|
* -> is vinyl file compatible
|
||||||
|
*/
|
||||||
|
class Smartfile {
|
||||||
|
/**
|
||||||
|
* the constructor of Smartfile
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
constructor(optionsArg) {
|
||||||
|
if (optionsArg.contentBuffer) {
|
||||||
|
this.contentBuffer = optionsArg.contentBuffer;
|
||||||
|
}
|
||||||
|
else if (optionsArg.contentString) {
|
||||||
|
this.setContentsFromString(optionsArg.contentString);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
console.log('created empty Smartfile?');
|
||||||
|
}
|
||||||
|
this.path = optionsArg.path;
|
||||||
|
this.parsedPath = plugins.path.parse(this.path);
|
||||||
|
this.base = optionsArg.base;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* set contents from string
|
||||||
|
* @param contentString
|
||||||
|
*/
|
||||||
|
setContentsFromString(contentString) {
|
||||||
|
this.contents = new Buffer(contentString);
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* write file to disk
|
||||||
|
* Behaviours:
|
||||||
|
* - no argument write to exactly where the file was picked up
|
||||||
|
*/
|
||||||
|
write(pathArg) {
|
||||||
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
|
const stringToWrite = this.contentBuffer.toString();
|
||||||
|
yield memory.toFs(stringToWrite, this.path);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* read file from disk
|
||||||
|
*/
|
||||||
|
read() {
|
||||||
|
return __awaiter(this, void 0, void 0, function* () { });
|
||||||
|
}
|
||||||
|
// -----------------------------------------------
|
||||||
|
// vinyl compatibility
|
||||||
|
// -----------------------------------------------
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility: alias of this.contentBuffer
|
||||||
|
*/
|
||||||
|
get contents() {
|
||||||
|
return this.contentBuffer;
|
||||||
|
}
|
||||||
|
set contents(contentsArg) {
|
||||||
|
this.contentBuffer = contentsArg;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility
|
||||||
|
*/
|
||||||
|
get cwd() {
|
||||||
|
return process.cwd();
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* return relative path of file
|
||||||
|
*/
|
||||||
|
get relative() {
|
||||||
|
return plugins.path.relative(this.base, this.path);
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* return truw when the file has content
|
||||||
|
*/
|
||||||
|
isNull() {
|
||||||
|
if (!this.contentBuffer) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* return true if contents are Buffer
|
||||||
|
*/
|
||||||
|
isBuffer() {
|
||||||
|
if (this.contents instanceof Buffer) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
isDirectory() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
isStream() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
isSymbolic() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
// update things
|
||||||
|
updateFileName(fileNameArg) {
|
||||||
|
let oldFileName = this.parsedPath.base;
|
||||||
|
this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
exports.Smartfile = Smartfile;
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBK0M7QUFFL0MsNkNBQTZDO0FBUzdDOzs7R0FHRztBQUNIO0lBMkJFOzs7T0FHRztJQUVILFlBQVksVUFBd0M7UUFDbEQsSUFBSSxVQUFVLENBQUMsYUFBYSxFQUFFO1lBQzVCLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQztTQUMvQzthQUFNLElBQUksVUFBVSxDQUFDLGFBQWEsRUFBRTtZQUNuQyxJQUFJLENBQUMscUJBQXFCLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1NBQ3REO2FBQU07WUFDTCxPQUFPLENBQUMsR0FBRyxDQUFDLDBCQUEwQixDQUFDLENBQUM7U0FDekM7UUFDRCxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDaEQsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO0lBQzlCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxxQkFBcUIsQ0FBQyxhQUFxQjtRQUN6QyxJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0csS0FBSyxDQUFDLE9BQWdCOztZQUMxQixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsYUFBYSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ3BELE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzlDLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs4REFBSSxDQUFDO0tBQUE7SUFFZixrREFBa0Q7SUFDbEQsc0JBQXNCO0lBQ3RCLGtEQUFrRDtJQUNsRDs7T0FFRztJQUNILElBQUksUUFBUTtRQUNWLE9BQU8sSUFBSSxDQUFDLGFBQWEsQ0FBQztJQUM1QixDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsV0FBVztRQUN0QixJQUFJLENBQUMsYUFBYSxHQUFHLFdBQVcsQ0FBQztJQUNuQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLEdBQUc7UUFDTCxPQUFPLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLFFBQVE7UUFDVixPQUFPLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU07UUFDSixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBRTtZQUN2QixPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQ7O09BRUc7SUFDSCxRQUFRO1FBQ04sSUFBSSxJQUFJLENBQUMsUUFBUSxZQUFZLE1BQU0sRUFBRTtZQUNuQyxPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsV0FBVztRQUNULE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxVQUFVO1FBQ1IsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsZ0JBQWdCO0lBQ2hCLGNBQWMsQ0FBQyxXQUFtQjtRQUNoQyxJQUFJLFdBQVcsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQztRQUN2QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksTUFBTSxDQUFDLFdBQVcsR0FBRyxHQUFHLENBQUMsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUM1RSxDQUFDO0NBQ0Y7QUFwSUQsOEJBb0lDIn0=
|
143
dist/smartfile.fs.d.ts
vendored
Normal file
143
dist/smartfile.fs.d.ts
vendored
Normal file
@ -0,0 +1,143 @@
|
|||||||
|
import { Smartfile } from './smartfile.classes.smartfile';
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @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: string) => string;
|
||||||
|
export declare let fileTreeToObject: (dirPathArg: string, miniMatchFilter: string) => Promise<Smartfile[]>;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @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[]>;
|
374
dist/smartfile.fs.js
vendored
Normal file
374
dist/smartfile.fs.js
vendored
Normal file
File diff suppressed because one or more lines are too long
2
dist/smartfile.interpreter.d.ts
vendored
Normal file
2
dist/smartfile.interpreter.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
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";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQWdEO0FBRXJDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFVLEVBQUU7SUFDaEQsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDNUMsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQyx5QkFBeUI7SUFDN0UsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRVMsUUFBQSxVQUFVLEdBQUcsQ0FBQyxhQUFxQixFQUFFLFdBQVcsRUFBRSxFQUFFO0lBQzdELFFBQVEsV0FBVyxFQUFFO1FBQ25CLEtBQUssS0FBSyxDQUFDO1FBQ1gsS0FBSyxNQUFNO1lBQ1QsT0FBTyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUM5QyxLQUFLLE1BQU07WUFDVCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbkM7WUFDRSxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUM7WUFDbEUsTUFBTTtLQUNUO0FBQ0gsQ0FBQyxDQUFDIn0=
|
25
dist/smartfile.memory.d.ts
vendored
Normal file
25
dist/smartfile.memory.d.ts
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
import { Smartfile } from './smartfile.classes.smartfile';
|
||||||
|
/**
|
||||||
|
* converts file to Object
|
||||||
|
* @param fileStringArg
|
||||||
|
* @param fileTypeArg
|
||||||
|
* @returns {any|any}
|
||||||
|
*/
|
||||||
|
export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
|
||||||
|
export interface IToFsOptions {
|
||||||
|
respectRelative?: boolean;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* writes string or Smartfile to disk.
|
||||||
|
* @param fileArg
|
||||||
|
* @param fileNameArg
|
||||||
|
* @param fileBaseArg
|
||||||
|
*/
|
||||||
|
export declare let toFs: (fileContentArg: string | Smartfile, filePathArg: any, optionsArg?: IToFsOptions) => Promise<{}>;
|
||||||
|
/**
|
||||||
|
* writes a string or a Smartfile to disk synchronously, only supports string
|
||||||
|
* @param fileArg
|
||||||
|
* @param filePathArg
|
||||||
|
*/
|
||||||
|
export declare let toFsSync: (fileArg: string, filePathArg: string) => void;
|
||||||
|
export declare let smartfileArrayToFs: (smartfileArrayArg: Smartfile[], dirArg: string) => Promise<void>;
|
87
dist/smartfile.memory.js
vendored
Normal file
87
dist/smartfile.memory.js
vendored
Normal file
@ -0,0 +1,87 @@
|
|||||||
|
"use strict";
|
||||||
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const plugins = require("./smartfile.plugins");
|
||||||
|
const smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
|
||||||
|
const smartfileFs = require("./smartfile.fs");
|
||||||
|
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||||
|
/**
|
||||||
|
* converts file to Object
|
||||||
|
* @param fileStringArg
|
||||||
|
* @param fileTypeArg
|
||||||
|
* @returns {any|any}
|
||||||
|
*/
|
||||||
|
exports.toObject = function (fileStringArg, fileTypeArg) {
|
||||||
|
return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* writes string or Smartfile to disk.
|
||||||
|
* @param fileArg
|
||||||
|
* @param fileNameArg
|
||||||
|
* @param fileBaseArg
|
||||||
|
*/
|
||||||
|
exports.toFs = (fileContentArg, filePathArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
let done = plugins.smartpromise.defer();
|
||||||
|
// check args
|
||||||
|
if (!fileContentArg || !filePathArg) {
|
||||||
|
throw new Error('expected valid arguments');
|
||||||
|
}
|
||||||
|
// prepare actual write action
|
||||||
|
let fileString;
|
||||||
|
let filePath = filePathArg;
|
||||||
|
// handle Smartfile
|
||||||
|
if (fileContentArg instanceof smartfile_classes_smartfile_1.Smartfile) {
|
||||||
|
let fileContentArg2 = fileContentArg;
|
||||||
|
fileString = fileContentArg.contentBuffer.toString();
|
||||||
|
// handle options
|
||||||
|
if (optionsArg.respectRelative) {
|
||||||
|
filePath = plugins.path.join(filePath, fileContentArg.path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (typeof fileContentArg === 'string') {
|
||||||
|
fileString = fileContentArg;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
throw new Error('fileContent is neither string nor Smartfile');
|
||||||
|
}
|
||||||
|
yield smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
|
||||||
|
plugins.fsExtra.writeFile(filePath, fileString, { encoding: 'utf8' }, done.resolve);
|
||||||
|
return yield done.promise;
|
||||||
|
});
|
||||||
|
/**
|
||||||
|
* writes a string or a Smartfile to disk synchronously, only supports string
|
||||||
|
* @param fileArg
|
||||||
|
* @param filePathArg
|
||||||
|
*/
|
||||||
|
exports.toFsSync = function (fileArg, filePathArg) {
|
||||||
|
// function checks to abort if needed
|
||||||
|
if (!fileArg || !filePathArg) {
|
||||||
|
throw new Error('expected a valid arguments');
|
||||||
|
}
|
||||||
|
// prepare actual write action
|
||||||
|
let fileString;
|
||||||
|
let filePath = filePathArg;
|
||||||
|
if (typeof fileArg !== 'string') {
|
||||||
|
throw new Error('fileArg is not of type String.');
|
||||||
|
}
|
||||||
|
else if (typeof fileArg === 'string') {
|
||||||
|
fileString = fileArg;
|
||||||
|
}
|
||||||
|
plugins.fsExtra.writeFileSync(filePath, fileString, { encoding: 'utf8' });
|
||||||
|
};
|
||||||
|
exports.smartfileArrayToFs = (smartfileArrayArg, dirArg) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
yield smartfileFs.ensureDir(dirArg);
|
||||||
|
for (let smartfile of smartfileArrayArg) {
|
||||||
|
yield exports.toFs(smartfile, dirArg, {
|
||||||
|
respectRelative: true
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLm1lbW9yeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5tZW1vcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7OztBQUFBLCtDQUFnRDtBQUNoRCwrRUFBMEQ7QUFDMUQsOENBQThDO0FBRTlDLGdFQUFpRTtBQUVqRTs7Ozs7R0FLRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsYUFBcUIsRUFBRSxXQUFtQjtJQUN2RSxPQUFPLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxhQUFhLEVBQUUsV0FBVyxDQUFDLENBQUM7QUFDckUsQ0FBQyxDQUFDO0FBTUY7Ozs7O0dBS0c7QUFDUSxRQUFBLElBQUksR0FBRyxDQUNoQixjQUFrQyxFQUNsQyxXQUFXLEVBQ1gsYUFBMkIsRUFBRSxFQUM3QixFQUFFO0lBQ0YsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUV4QyxhQUFhO0lBQ2IsSUFBSSxDQUFDLGNBQWMsSUFBSSxDQUFDLFdBQVcsRUFBRTtRQUNuQyxNQUFNLElBQUksS0FBSyxDQUFDLDBCQUEwQixDQUFDLENBQUM7S0FDN0M7SUFFRCw4QkFBOEI7SUFDOUIsSUFBSSxVQUFrQixDQUFDO0lBQ3ZCLElBQUksUUFBUSxHQUFXLFdBQVcsQ0FBQztJQUVuQyxtQkFBbUI7SUFDbkIsSUFBSSxjQUFjLFlBQVksdUNBQVMsRUFBRTtRQUN2QyxJQUFJLGVBQWUsR0FBUSxjQUFjLENBQUM7UUFDMUMsVUFBVSxHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDckQsaUJBQWlCO1FBQ2pCLElBQUksVUFBVSxDQUFDLGVBQWUsRUFBRTtZQUM5QixRQUFRLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUM3RDtLQUNGO1NBQU0sSUFBSSxPQUFPLGNBQWMsS0FBSyxRQUFRLEVBQUU7UUFDN0MsVUFBVSxHQUFHLGNBQWMsQ0FBQztLQUM3QjtTQUFNO1FBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0tBQ2hFO0lBQ0QsTUFBTSxXQUFXLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzlELE9BQU8sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLFFBQVEsRUFBRSxVQUFVLEVBQUUsRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3BGLE9BQU8sTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQzVCLENBQUMsQ0FBQSxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZSxFQUFFLFdBQW1CO0lBQ2pFLHFDQUFxQztJQUNyQyxJQUFJLENBQUMsT0FBTyxJQUFJLENBQUMsV0FBVyxFQUFFO1FBQzVCLE1BQU0sSUFBSSxLQUFLLENBQUMsNEJBQTRCLENBQUMsQ0FBQztLQUMvQztJQUVELDhCQUE4QjtJQUM5QixJQUFJLFVBQWtCLENBQUM7SUFDdkIsSUFBSSxRQUFRLEdBQVcsV0FBVyxDQUFDO0lBRW5DLElBQUksT0FBTyxPQUFPLEtBQUssUUFBUSxFQUFFO1FBQy9CLE1BQU0sSUFBSSxLQUFLLENBQUMsZ0NBQWdDLENBQUMsQ0FBQztLQUNuRDtTQUFNLElBQUksT0FBTyxPQUFPLEtBQUssUUFBUSxFQUFFO1FBQ3RDLFVBQVUsR0FBRyxPQUFPLENBQUM7S0FDdEI7SUFDRCxPQUFPLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxRQUFRLEVBQUUsVUFBVSxFQUFFLEVBQUUsUUFBUSxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUM7QUFDNUUsQ0FBQyxDQUFDO0FBRVMsUUFBQSxrQkFBa0IsR0FBRyxDQUFPLGlCQUE4QixFQUFFLE1BQWMsRUFBRSxFQUFFO0lBQ3ZGLE1BQU0sV0FBVyxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNwQyxLQUFLLElBQUksU0FBUyxJQUFJLGlCQUFpQixFQUFFO1FBQ3ZDLE1BQU0sWUFBSSxDQUFDLFNBQVMsRUFBRSxNQUFNLEVBQUU7WUFDNUIsZUFBZSxFQUFFLElBQUk7U0FDdEIsQ0FBQyxDQUFDO0tBQ0o7QUFDSCxDQUFDLENBQUEsQ0FBQyJ9
|
10
dist/smartfile.plugins.d.ts
vendored
Normal file
10
dist/smartfile.plugins.d.ts
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
export import fs = require('fs');
|
||||||
|
export import fsExtra = require('fs-extra');
|
||||||
|
export declare let glob: any;
|
||||||
|
export import path = require('path');
|
||||||
|
export import smartpromise = require('@pushrocks/smartpromise');
|
||||||
|
export import smartrequest = require('@pushrocks/smartrequest');
|
||||||
|
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";
|
"use strict";
|
||||||
/// <reference path="./typings/main.d.ts" />
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
exports.beautylog = require("beautylog");
|
exports.fs = require("fs");
|
||||||
exports.fs = require("fs-extra");
|
exports.fsExtra = require("fs-extra");
|
||||||
|
exports.glob = require('glob');
|
||||||
exports.path = require("path");
|
exports.path = require("path");
|
||||||
exports.q = require("q");
|
exports.smartpromise = require("@pushrocks/smartpromise");
|
||||||
exports.vinyl = require("vinyl");
|
exports.smartrequest = require("@pushrocks/smartrequest");
|
||||||
exports.vinylFile = require("vinyl-file");
|
exports.requireReload = require('require-reload');
|
||||||
exports.yaml = require("js-yaml");
|
exports.smartpath = require("smartpath");
|
||||||
exports.requireReload = require("require-reload");
|
exports.vinylFile = require('vinyl-file');
|
||||||
exports.shelljs = require("shelljs");
|
exports.yaml = require('js-yaml');
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJCQUFpQztBQUNqQyxzQ0FBNEM7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ2xDLCtCQUFxQztBQUNyQywwREFBZ0U7QUFDaEUsMERBQWdFO0FBQ3JELFFBQUEsYUFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0FBQ3JELHlDQUErQztBQUNwQyxRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDbEMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDIn0=
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZmlsZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSw0Q0FBNEM7QUFDakMsaUJBQVMsR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUM7QUFDakMsVUFBRSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQztBQUN6QixZQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLFNBQUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDakIsYUFBSyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUN6QixpQkFBUyxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNsQyxZQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzFCLHFCQUFhLEdBQUcsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDMUMsZUFBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQyIsImZpbGUiOiJzbWFydGZpbGUucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCIuL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbmV4cG9ydCBsZXQgYmVhdXR5bG9nID0gcmVxdWlyZShcImJlYXV0eWxvZ1wiKTtcbmV4cG9ydCBsZXQgZnMgPSByZXF1aXJlKFwiZnMtZXh0cmFcIik7XG5leHBvcnQgbGV0IHBhdGggPSByZXF1aXJlKFwicGF0aFwiKTtcbmV4cG9ydCBsZXQgcSA9IHJlcXVpcmUoXCJxXCIpO1xuZXhwb3J0IGxldCB2aW55bCA9IHJlcXVpcmUoXCJ2aW55bFwiKTtcbmV4cG9ydCBsZXQgdmlueWxGaWxlID0gcmVxdWlyZShcInZpbnlsLWZpbGVcIik7XG5leHBvcnQgbGV0IHlhbWwgPSByZXF1aXJlKFwianMteWFtbFwiKTtcbmV4cG9ydCBsZXQgcmVxdWlyZVJlbG9hZCA9IHJlcXVpcmUoXCJyZXF1aXJlLXJlbG9hZFwiKTtcbmV4cG9ydCBsZXQgc2hlbGxqcyA9IHJlcXVpcmUoXCJzaGVsbGpzXCIpO1xuIl0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
12
dist/smartfile.remote.d.ts
vendored
Normal file
12
dist/smartfile.remote.d.ts
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let toObject: (fromArg: string) => Promise<{}>;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let toString: (fromArg: string) => Promise<{}>;
|
51
dist/smartfile.remote.js
vendored
Normal file
51
dist/smartfile.remote.js
vendored
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const plugins = require("./smartfile.plugins");
|
||||||
|
/* export let toFs = function (from: string, toPath: string) {
|
||||||
|
let done = plugins.q.defer()
|
||||||
|
let stream = plugins.smartrequest(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.smartpromise.defer();
|
||||||
|
plugins.smartrequest
|
||||||
|
.request(fromArg, {
|
||||||
|
method: 'get'
|
||||||
|
})
|
||||||
|
.then((res) => {
|
||||||
|
if (res.statusCode === 200) {
|
||||||
|
done.resolve(res.body);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
console.log('could not get remote file from ' + fromArg);
|
||||||
|
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
exports.toString = (fromArg) => {
|
||||||
|
let done = plugins.smartpromise.defer();
|
||||||
|
plugins.smartrequest.get(fromArg).then((res) => {
|
||||||
|
if (res.statusCode === 200) {
|
||||||
|
done.resolve(res.body);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwrQ0FBZ0Q7QUFHaEQ7Ozs7Ozs7SUFPSTtBQUVKOzs7O0dBSUc7QUFDUSxRQUFBLFFBQVEsR0FBRyxVQUFTLE9BQWU7SUFDNUMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWTtTQUNqQixPQUFPLENBQUMsT0FBTyxFQUFFO1FBQ2hCLE1BQU0sRUFBRSxLQUFLO0tBQ2QsQ0FBQztTQUNELElBQUksQ0FBQyxDQUFDLEdBQVEsRUFBRSxFQUFFO1FBQ2pCLElBQUksR0FBRyxDQUFDLFVBQVUsS0FBSyxHQUFHLEVBQUU7WUFDMUIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDeEI7YUFBTTtZQUNMLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUM7WUFDekQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxpQ0FBaUMsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDO1NBQ3JFO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFDTCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDdEIsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFFLEVBQUU7SUFDeEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFRLEVBQUUsRUFBRTtRQUNsRCxJQUFJLEdBQUcsQ0FBQyxVQUFVLEtBQUssR0FBRyxFQUFFO1lBQzFCLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ3hCO2FBQU07WUFDTCxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDckU7SUFDSCxDQUFDLENBQUMsQ0FBQztJQUNILE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN0QixDQUFDLENBQUMifQ==
|
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==
|
|
43
docs/index.md
Normal file
43
docs/index.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
# smartfile
|
||||||
|
|
||||||
|
make files easily accessible for processing in javascript.
|
||||||
|
|
||||||
|
## 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/)
|
||||||
|
|
||||||
|
## 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 further information read the linked docs at the top of this README.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
13
npmextra.json
Normal file
13
npmextra.json
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"npmts":{
|
||||||
|
"mode":"default",
|
||||||
|
"coverageTreshold":70
|
||||||
|
},
|
||||||
|
"npmdocker":{
|
||||||
|
|
||||||
|
},
|
||||||
|
"npmci": {
|
||||||
|
"npmGlobalTools": [],
|
||||||
|
"npmAccessLevel": "public"
|
||||||
|
}
|
||||||
|
}
|
@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"mode":"default",
|
|
||||||
"coveralls":true
|
|
||||||
}
|
|
1158
package-lock.json
generated
Normal file
1158
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
44
package.json
44
package.json
@ -1,18 +1,21 @@
|
|||||||
{
|
{
|
||||||
"name": "smartfile",
|
"name": "@pushrocks/smartfile",
|
||||||
"version": "1.0.0",
|
"private": false,
|
||||||
|
"version": "6.0.9",
|
||||||
"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",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)",
|
"test": "(tstest test/)",
|
||||||
"reinstall": "(rm -r node_modules && npm install)",
|
"reinstall": "(rm -r node_modules && npm install)",
|
||||||
"release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
|
"release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
|
||||||
"update": "(git checkout master && git pull origin master && npm install)",
|
"update": "(git checkout master && git pull origin master && npm install)",
|
||||||
"upgrade": "(npm run update) && (ncu upgradeAll && npm install)"
|
"upgrade": "(npm run update) && (ncu upgradeAll && npm install)",
|
||||||
|
"build": "(tsbuild)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/pushrocks/smartfile.git"
|
"url": "https://gitlab.com/pushrocks/smartfile.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"filesystem",
|
"filesystem",
|
||||||
@ -21,21 +24,28 @@
|
|||||||
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"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": {
|
"dependencies": {
|
||||||
"beautylog": "3.1.2",
|
"@pushrocks/smartpath": "^4.0.1",
|
||||||
"fs-extra": "0.26.5",
|
"@pushrocks/smartpromise": "^2.0.5",
|
||||||
"js-yaml": "3.5.4",
|
"@pushrocks/smartrequest": "^1.1.14",
|
||||||
"q": "1.4.1",
|
"@types/fs-extra": "^5.0.4",
|
||||||
"require-reload": "0.2.2",
|
"@types/vinyl": "^2.0.2",
|
||||||
"shelljs": "^0.6.0",
|
"fs-extra": "^7.0.1",
|
||||||
"vinyl": "1.1.1",
|
"glob": "^7.1.3",
|
||||||
"vinyl-file": "2.0.0"
|
"js-yaml": "^3.10.0",
|
||||||
|
"vinyl-file": "^3.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts": "3.4.1",
|
"@gitzone/tsbuild": "^2.0.22",
|
||||||
"should": "^8.2.2"
|
"@gitzone/tsrun": "^1.1.13",
|
||||||
|
"@gitzone/tstest": "^1.0.15",
|
||||||
|
"@pushrocks/tapbundle": "^3.0.7",
|
||||||
|
"@types/node": "^10.12.10",
|
||||||
|
"gulp-function": "^2.2.14",
|
||||||
|
"tslint": "^5.11.0",
|
||||||
|
"tslint-config-prettier": "^1.16.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
60
test/test.js
60
test/test.js
@ -1,60 +0,0 @@
|
|||||||
/// <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");
|
|
||||||
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");
|
|
||||||
});
|
|
||||||
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");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
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("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");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
//# sourceMappingURL=test.js.map
|
|
@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC5C,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AACrC,IAAI,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC/B,IAAI,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7B,QAAQ,CAAC,WAAW,EAAC;IACjB,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAC;QAChC,EAAE,CAAC,gCAAgC,EAAC;YAChC,MAAM,CAAC,KAAK,CACR,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,EAC/C,sBAAsB,CACzB,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAC;QAChC,EAAE,CAAC,iBAAiB,GAAG,OAAO,CAAC,IAAI,GAAG,oBAAoB,EAAC;YACvD,IAAI,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;YAChE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,YAAY,CAAC,CAAC;YACnD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,gBAAgB,CAAC,CAAC;QAE3D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uDAAuD,EAAC;YACvD,IAAI,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iBAAiB,GAAG,OAAO,CAAC,IAAI,GAAG,oBAAoB,EAAC;YACvD,IAAI,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;YAChE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,YAAY,CAAC,CAAC;YACnD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,gBAAgB,CAAC,CAAC;QAE3D,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,kBAAkB,CAAC,MAAM,EAAC;QAC/B,EAAE,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,GAAG,cAAc,GAAG,mBAAmB,CAAC,IAAI,EAAC;YACrF,IAAI,QAAQ,GAAG,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YAC/D,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;QAE/C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAC;QACtB,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAC;YAC9B,EAAE,CAAC,mCAAmC,EAAC;gBACnC,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;gBACzE,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YAChF,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAC;YAC1B,EAAE,CAAC,iCAAiC,EAAC;gBACjC,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;gBACxE,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;gBAC1E,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;YACpF,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,MAAM,EAAC;QACZ,EAAE,CAAC,yBAAyB,EAAC;YACzB,SAAS,CAAC,IAAI,CAAC,oBAAoB,EAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oBAAoB,EAAC;YACpB,SAAS,CAAC,IAAI,CAAC,oBAAoB,EAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kCAAkC,EAAC;YAClC,SAAS,CAAC,IAAI,CAAC,oBAAoB,EAAC,kCAAkC,CAAC,CAAA;QAC3E,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
252
test/test.ts
252
test/test.ts
@ -1,66 +1,194 @@
|
|||||||
/// <reference path="../ts/typings/main.d.ts" />
|
import * as smartfile from '../ts/index';
|
||||||
var smartfile = require("../dist/index.js");
|
import path = require('path');
|
||||||
var beautylog = require("beautylog");
|
|
||||||
var should = require("should");
|
|
||||||
var vinyl = require("vinyl");
|
|
||||||
|
|
||||||
describe("smartfile",function(){
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
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");
|
|
||||||
|
|
||||||
});
|
// ---------------------------
|
||||||
it("should state unknown file type for unknown file types",function(){
|
// smartfile.fs
|
||||||
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");
|
|
||||||
|
|
||||||
});
|
tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
|
||||||
});
|
expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true;
|
||||||
describe(".readFileToVinyl".yellow,function(){
|
expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false;
|
||||||
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("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")
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.fileExists -> should resolve or reject a promise', async () => {
|
||||||
|
expect(smartfile.fs.fileExists('./test/mytest.json')).to.be.instanceof(Promise);
|
||||||
|
await smartfile.fs.fileExists('./test/mytest.json');
|
||||||
|
await smartfile.fs.fileExists('./test/notthere.json').catch(err => {
|
||||||
|
return expect(err.message).to.equal(
|
||||||
|
"ENOENT: no such file or directory, access './test/notthere.json'"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.listFoldersSync() -> should get the file type from a string', async () => {
|
||||||
|
expect(smartfile.fs.listFoldersSync('./test/')).to.include('testfolder');
|
||||||
|
expect(smartfile.fs.listFoldersSync('./test/')).to.not.include('notExistentFolder');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.listFolders() -> should get the file type from a string', async () => {
|
||||||
|
let folderArrayArg = await smartfile.fs.listFolders('./test/');
|
||||||
|
expect(folderArrayArg).to.include('testfolder');
|
||||||
|
expect(folderArrayArg).to.not.include('notExistentFolder');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.listFilesSync() -> should get the file type from a string', async () => {
|
||||||
|
expect(smartfile.fs.listFilesSync('./test/')).to.include('mytest.json');
|
||||||
|
expect(smartfile.fs.listFilesSync('./test/')).to.not.include('notExistentFile');
|
||||||
|
expect(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).to.include('mytest.json');
|
||||||
|
expect(smartfile.fs.listFilesSync('./test/', /mytests.json/)).to.not.include('mytest.json');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.listFiles() -> should get the file type from a string', async () => {
|
||||||
|
let folderArrayArg = await smartfile.fs.listFiles('./test/');
|
||||||
|
expect(folderArrayArg).to.include('mytest.json');
|
||||||
|
expect(folderArrayArg).to.not.include('notExistentFile');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.listFileTree() -> should get a file tree', async () => {
|
||||||
|
let folderArrayArg = await smartfile.fs.listFileTree(path.resolve('./test/'), '**/*.txt');
|
||||||
|
expect(folderArrayArg).to.include('testfolder/testfile1.txt');
|
||||||
|
expect(folderArrayArg).to.not.include('mytest.json');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.fileTreeToObject -> should read a file tree into an Object', async () => {
|
||||||
|
let fileArrayArg = await smartfile.fs.fileTreeToObject(path.resolve('./test/'), '**/*.txt');
|
||||||
|
expect(fileArrayArg[0]).to.be.instanceof(smartfile.Smartfile);
|
||||||
|
expect(fileArrayArg[0].contents.toString()).to.equal(fileArrayArg[0].contentBuffer.toString());
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.copy() -> should copy a directory', async () => {
|
||||||
|
smartfile.fs.copy('./test/testfolder/', './test/temp/');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.copy() -> should copy a file', async () => {
|
||||||
|
smartfile.fs.copy('./test/mytest.yaml', './test/temp/');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.copy() -> should copy a file and rename it', async () => {
|
||||||
|
smartfile.fs.copy('./test/mytest.yaml', './test/temp/mytestRenamed.yaml');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.remove() -> should remove an entire directory', async () => {});
|
||||||
|
|
||||||
|
tap.test('.fs.remove -> should remove single files', async () => {
|
||||||
|
await smartfile.fs.remove('./test/temp/mytestRenamed.yaml');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
|
||||||
|
smartfile.fs.removeSync('./test/temp/testfile1.txt');
|
||||||
|
expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.removeMany -> should remove and array of files', async () => {
|
||||||
|
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;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.removeManySync -> should remove and array of single files synchronouly', async () => {
|
||||||
|
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;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.toObjectSync() -> should read an ' + '.yaml' + ' file to an object', async () => {
|
||||||
|
let testData = smartfile.fs.toObjectSync('./test/mytest.yaml');
|
||||||
|
expect(testData).to.include({ key1: 'this works' });
|
||||||
|
expect(testData).to.include({ key2: 'this works too' });
|
||||||
|
});
|
||||||
|
tap.test(
|
||||||
|
'.fs.toObjectSync() -> should state unknown file type for unknown file types',
|
||||||
|
async () => {
|
||||||
|
let testData = smartfile.fs.toObjectSync('./test/mytest.txt');
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
tap.test('.fs.toObjectSync() -> should read an ' + '.json' + ' file to an object', async () => {
|
||||||
|
let testData = smartfile.fs.toObjectSync('./test/mytest.json');
|
||||||
|
expect(testData).to.include({ key1: 'this works' });
|
||||||
|
expect(testData).to.include({ key2: 'this works too' });
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
|
||||||
|
expect(smartfile.fs.toStringSync('./test/mytest.txt')).to.equal('Some TestString &&%$');
|
||||||
|
});
|
||||||
|
|
||||||
|
// ---------------------------
|
||||||
|
// smartfile.interpreter
|
||||||
|
// ---------------------------
|
||||||
|
|
||||||
|
tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
|
||||||
|
expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json');
|
||||||
|
});
|
||||||
|
|
||||||
|
// ---------------------------
|
||||||
|
// smartfile.memory
|
||||||
|
// ---------------------------
|
||||||
|
|
||||||
|
tap.test('.memory.toFs() -> should write a file to disk and return a promise', async () => {
|
||||||
|
let localString = 'myString';
|
||||||
|
await smartfile.memory.toFs(localString, path.join(process.cwd(), './test/temp/testMemToFs.txt'));
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test(
|
||||||
|
'.memory.toFsSync() -> should write a file to disk and return true if successfull',
|
||||||
|
async () => {
|
||||||
|
let localString = 'myString';
|
||||||
|
smartfile.memory.toFsSync(
|
||||||
|
localString,
|
||||||
|
path.join(process.cwd(), './test/temp/testMemToFsSync.txt')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
tap.test('.remote.toString() -> should load a remote file to a variable', async () => {
|
||||||
|
let responseString = await smartfile.remote.toString(
|
||||||
|
'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt'
|
||||||
|
);
|
||||||
|
expect(responseString).to.equal('Some TestString &&%$');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('.remote.toString() -> should reject a Promise when the link is false', async tools => {
|
||||||
|
tools.returnError;
|
||||||
|
await smartfile.remote.toString('https://push.rocks/doesnotexist.txt').catch(err => {
|
||||||
|
return expect(err.message).to.equal(
|
||||||
|
'could not get remote file from https://push.rocks/doesnotexist.txt'
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ---------------------------
|
||||||
|
// smartfile.Smartfile
|
||||||
|
// ---------------------------
|
||||||
|
|
||||||
|
tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
|
||||||
|
let smartfileArray = await smartfile.fs.fileTreeToObject(process.cwd(), './test/testfolder/**/*');
|
||||||
|
let localSmartfile = smartfileArray[0];
|
||||||
|
expect(localSmartfile).to.be.instanceof(smartfile.Smartfile);
|
||||||
|
expect(localSmartfile.contents).to.be.instanceof(Buffer);
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(localSmartfile.isBuffer()).to.be.true;
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(localSmartfile.isDirectory()).to.be.false;
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(localSmartfile.isNull()).to.be.false;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should output a smartfile array to disk', async () => {
|
||||||
|
let smartfileArray = await smartfile.fs.fileTreeToObject('./test/testfolder/', '*');
|
||||||
|
for (let smartfile of smartfileArray) {
|
||||||
|
console.log(smartfile.relative);
|
||||||
|
console.log(smartfile.path);
|
||||||
|
console.log(smartfile.base);
|
||||||
|
console.log(smartfile.parsedPath);
|
||||||
|
}
|
||||||
|
await smartfile.memory.smartfileArrayToFs(
|
||||||
|
smartfileArray,
|
||||||
|
path.resolve('./test/temp/testoutput/')
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
|
@ -0,0 +1 @@
|
|||||||
|
okidoks
|
1
test/testfolder/subfolder/subtestfile.txt
Normal file
1
test/testfolder/subfolder/subtestfile.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
hi
|
25
ts/index.ts
25
ts/index.ts
@ -1,17 +1,12 @@
|
|||||||
/// <reference path="./typings/main.d.ts" />
|
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';
|
||||||
|
|
||||||
import plugins = require("./smartfile.plugins");
|
export { Smartfile } from './smartfile.classes.smartfile';
|
||||||
import SmartfileChecks = require("./smartfile.checks");
|
|
||||||
import SmartfileSimple = require("./smartfile.simple");
|
|
||||||
|
|
||||||
|
export let fs = SmartfileFs;
|
||||||
var smartfile:any = {
|
export let interpreter = SmartfileInterpreter;
|
||||||
copy: SmartfileSimple.copy,
|
export let memory = SmartfileMemory;
|
||||||
checks: SmartfileChecks,
|
export let remote = SmartfileRemote;
|
||||||
readFileToString: SmartfileSimple.readFileToString,
|
|
||||||
readFileToObject: SmartfileSimple.readFileToObject,
|
|
||||||
readFileToVinyl: SmartfileSimple.readFileToVinyl,
|
|
||||||
requireReload: SmartfileSimple.requireReload
|
|
||||||
};
|
|
||||||
|
|
||||||
export = smartfile;
|
|
||||||
|
@ -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;
|
|
||||||
};
|
|
148
ts/smartfile.classes.smartfile.ts
Normal file
148
ts/smartfile.classes.smartfile.ts
Normal file
@ -0,0 +1,148 @@
|
|||||||
|
import * as plugins from './smartfile.plugins';
|
||||||
|
import * as fs from './smartfile.fs';
|
||||||
|
import * as memory from './smartfile.memory';
|
||||||
|
|
||||||
|
export interface ISmartfileConstructorOptions {
|
||||||
|
path?: string;
|
||||||
|
contentString?: string;
|
||||||
|
contentBuffer?: Buffer;
|
||||||
|
base?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* class Smartfile
|
||||||
|
* -> is vinyl file compatible
|
||||||
|
*/
|
||||||
|
export class Smartfile {
|
||||||
|
/**
|
||||||
|
* the full path of the file on disk
|
||||||
|
*/
|
||||||
|
path: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
parsedPath: plugins.path.ParsedPath;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the content of the file as Buffer
|
||||||
|
*/
|
||||||
|
contentBuffer: Buffer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current working directory of the file
|
||||||
|
* Note:this is similar to gulp and different from native node path base
|
||||||
|
*/
|
||||||
|
base: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sync the file with disk
|
||||||
|
*/
|
||||||
|
sync: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the constructor of Smartfile
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
|
||||||
|
constructor(optionsArg: ISmartfileConstructorOptions) {
|
||||||
|
if (optionsArg.contentBuffer) {
|
||||||
|
this.contentBuffer = optionsArg.contentBuffer;
|
||||||
|
} else if (optionsArg.contentString) {
|
||||||
|
this.setContentsFromString(optionsArg.contentString);
|
||||||
|
} else {
|
||||||
|
console.log('created empty Smartfile?');
|
||||||
|
}
|
||||||
|
this.path = optionsArg.path;
|
||||||
|
this.parsedPath = plugins.path.parse(this.path);
|
||||||
|
this.base = optionsArg.base;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set contents from string
|
||||||
|
* @param contentString
|
||||||
|
*/
|
||||||
|
setContentsFromString(contentString: string) {
|
||||||
|
this.contents = new Buffer(contentString);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* write file to disk
|
||||||
|
* Behaviours:
|
||||||
|
* - no argument write to exactly where the file was picked up
|
||||||
|
*/
|
||||||
|
async write(pathArg?: string) {
|
||||||
|
const stringToWrite = this.contentBuffer.toString();
|
||||||
|
await memory.toFs(stringToWrite, this.path);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* read file from disk
|
||||||
|
*/
|
||||||
|
async read() {}
|
||||||
|
|
||||||
|
// -----------------------------------------------
|
||||||
|
// vinyl compatibility
|
||||||
|
// -----------------------------------------------
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility: alias of this.contentBuffer
|
||||||
|
*/
|
||||||
|
get contents(): Buffer {
|
||||||
|
return this.contentBuffer;
|
||||||
|
}
|
||||||
|
set contents(contentsArg) {
|
||||||
|
this.contentBuffer = contentsArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* vinyl-compatibility
|
||||||
|
*/
|
||||||
|
get cwd() {
|
||||||
|
return process.cwd();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return relative path of file
|
||||||
|
*/
|
||||||
|
get relative(): string {
|
||||||
|
return plugins.path.relative(this.base, this.path);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return truw when the file has content
|
||||||
|
*/
|
||||||
|
isNull(): boolean {
|
||||||
|
if (!this.contentBuffer) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* return true if contents are Buffer
|
||||||
|
*/
|
||||||
|
isBuffer(): boolean {
|
||||||
|
if (this.contents instanceof Buffer) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
isDirectory() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
isStream() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
isSymbolic() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// update things
|
||||||
|
updateFileName(fileNameArg: string) {
|
||||||
|
let oldFileName = this.parsedPath.base;
|
||||||
|
this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
|
||||||
|
}
|
||||||
|
}
|
386
ts/smartfile.fs.ts
Normal file
386
ts/smartfile.fs.ts
Normal file
@ -0,0 +1,386 @@
|
|||||||
|
import plugins = require('./smartfile.plugins');
|
||||||
|
import SmartfileInterpreter = require('./smartfile.interpreter');
|
||||||
|
|
||||||
|
import { Smartfile } from './smartfile.classes.smartfile';
|
||||||
|
|
||||||
|
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.smartpromise.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 {
|
||||||
|
try {
|
||||||
|
return plugins.fsExtra.statSync(pathArg).isDirectory();
|
||||||
|
} catch (err) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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.smartpromise.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.smartpromise.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.smartpromise.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.smartpromise.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.smartpromise.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: string): string {
|
||||||
|
let fileString: any = plugins.fsExtra.readFileSync(filePath, 'utf8');
|
||||||
|
return fileString;
|
||||||
|
};
|
||||||
|
|
||||||
|
export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
|
||||||
|
// handle absolute miniMatchFilter
|
||||||
|
let dirPath: string;
|
||||||
|
if (plugins.path.isAbsolute(miniMatchFilter)) {
|
||||||
|
dirPath = '/';
|
||||||
|
} else {
|
||||||
|
dirPath = dirPathArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
let fileTree = await listFileTree(dirPath, miniMatchFilter);
|
||||||
|
let smartfileArray: Smartfile[] = [];
|
||||||
|
for (let filePath of fileTree) {
|
||||||
|
let readPath = ((): string => {
|
||||||
|
if (!plugins.path.isAbsolute(filePath)) {
|
||||||
|
return plugins.path.join(dirPath, filePath);
|
||||||
|
} else {
|
||||||
|
return filePath;
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
let fileContentString = toStringSync(readPath);
|
||||||
|
|
||||||
|
// push a read file as Smartfile
|
||||||
|
smartfileArray.push(
|
||||||
|
new Smartfile({
|
||||||
|
contentBuffer: new Buffer(fileContentString),
|
||||||
|
base: dirPath,
|
||||||
|
path: filePath
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return smartfileArray;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @param options
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
export let toVinylSync = function(filePathArg, options = {}) {
|
||||||
|
return plugins.vinylFile.readSync(filePathArg, options);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* lists Folders in a directory on local disk
|
||||||
|
* @returns Promise with an array that contains the folder names
|
||||||
|
*/
|
||||||
|
export let listFolders = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
|
||||||
|
let done = plugins.smartpromise.defer<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);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
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.smartpromise.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.smartpromise.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.smartpromise.defer<string[]>();
|
||||||
|
|
||||||
|
// handle absolute miniMatchFilter
|
||||||
|
let dirPath: string;
|
||||||
|
if (plugins.path.isAbsolute(miniMatchFilter)) {
|
||||||
|
dirPath = '/';
|
||||||
|
} else {
|
||||||
|
dirPath = dirPathArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
let options = {
|
||||||
|
cwd: dirPath,
|
||||||
|
nodir: true,
|
||||||
|
dot: true
|
||||||
|
};
|
||||||
|
plugins.glob(miniMatchFilter, options, (err, files: string[]) => {
|
||||||
|
if (err) {
|
||||||
|
console.log(err);
|
||||||
|
done.reject(err);
|
||||||
|
}
|
||||||
|
done.resolve(files);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
20
ts/smartfile.interpreter.ts
Normal file
20
ts/smartfile.interpreter.ts
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
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;
|
||||||
|
}
|
||||||
|
};
|
91
ts/smartfile.memory.ts
Normal file
91
ts/smartfile.memory.ts
Normal file
@ -0,0 +1,91 @@
|
|||||||
|
import plugins = require('./smartfile.plugins');
|
||||||
|
import { Smartfile } from './smartfile.classes.smartfile';
|
||||||
|
import * as smartfileFs from './smartfile.fs';
|
||||||
|
|
||||||
|
import SmartfileInterpreter = require('./smartfile.interpreter');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* converts file to Object
|
||||||
|
* @param fileStringArg
|
||||||
|
* @param fileTypeArg
|
||||||
|
* @returns {any|any}
|
||||||
|
*/
|
||||||
|
export let toObject = function(fileStringArg: string, fileTypeArg: string) {
|
||||||
|
return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface IToFsOptions {
|
||||||
|
respectRelative?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* writes string or Smartfile to disk.
|
||||||
|
* @param fileArg
|
||||||
|
* @param fileNameArg
|
||||||
|
* @param fileBaseArg
|
||||||
|
*/
|
||||||
|
export let toFs = async (
|
||||||
|
fileContentArg: string | Smartfile,
|
||||||
|
filePathArg,
|
||||||
|
optionsArg: IToFsOptions = {}
|
||||||
|
) => {
|
||||||
|
let done = plugins.smartpromise.defer();
|
||||||
|
|
||||||
|
// check args
|
||||||
|
if (!fileContentArg || !filePathArg) {
|
||||||
|
throw new Error('expected valid arguments');
|
||||||
|
}
|
||||||
|
|
||||||
|
// prepare actual write action
|
||||||
|
let fileString: string;
|
||||||
|
let filePath: string = filePathArg;
|
||||||
|
|
||||||
|
// handle Smartfile
|
||||||
|
if (fileContentArg instanceof Smartfile) {
|
||||||
|
let fileContentArg2: any = fileContentArg;
|
||||||
|
fileString = fileContentArg.contentBuffer.toString();
|
||||||
|
// handle options
|
||||||
|
if (optionsArg.respectRelative) {
|
||||||
|
filePath = plugins.path.join(filePath, fileContentArg.path);
|
||||||
|
}
|
||||||
|
} else if (typeof fileContentArg === 'string') {
|
||||||
|
fileString = fileContentArg;
|
||||||
|
} else {
|
||||||
|
throw new Error('fileContent is neither string nor Smartfile');
|
||||||
|
}
|
||||||
|
await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
|
||||||
|
plugins.fsExtra.writeFile(filePath, fileString, { encoding: 'utf8' }, done.resolve);
|
||||||
|
return await done.promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* writes a string or a Smartfile to disk synchronously, only supports string
|
||||||
|
* @param fileArg
|
||||||
|
* @param filePathArg
|
||||||
|
*/
|
||||||
|
export let toFsSync = function(fileArg: string, 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') {
|
||||||
|
throw new Error('fileArg is not of type String.');
|
||||||
|
} else if (typeof fileArg === 'string') {
|
||||||
|
fileString = fileArg;
|
||||||
|
}
|
||||||
|
plugins.fsExtra.writeFileSync(filePath, fileString, { encoding: 'utf8' });
|
||||||
|
};
|
||||||
|
|
||||||
|
export let smartfileArrayToFs = async (smartfileArrayArg: Smartfile[], dirArg: string) => {
|
||||||
|
await smartfileFs.ensureDir(dirArg);
|
||||||
|
for (let smartfile of smartfileArrayArg) {
|
||||||
|
await toFs(smartfile, dirArg, {
|
||||||
|
respectRelative: true
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
@ -1,10 +1,9 @@
|
|||||||
/// <reference path="./typings/main.d.ts" />
|
export import fs = require('fs');
|
||||||
export let beautylog = require("beautylog");
|
export import fsExtra = require('fs-extra');
|
||||||
export let fs = require("fs-extra");
|
export let glob = require('glob');
|
||||||
export let path = require("path");
|
export import path = require('path');
|
||||||
export let q = require("q");
|
export import smartpromise = require('@pushrocks/smartpromise');
|
||||||
export let vinyl = require("vinyl");
|
export import smartrequest = require('@pushrocks/smartrequest');
|
||||||
export let vinylFile = require("vinyl-file");
|
export import smartpath = require('@pushrocks/smartpath');
|
||||||
export let yaml = require("js-yaml");
|
export let vinylFile = require('vinyl-file');
|
||||||
export let requireReload = require("require-reload");
|
export let yaml = require('js-yaml');
|
||||||
export let shelljs = require("shelljs");
|
|
||||||
|
50
ts/smartfile.remote.ts
Normal file
50
ts/smartfile.remote.ts
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
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.smartrequest(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.smartpromise.defer();
|
||||||
|
plugins.smartrequest
|
||||||
|
.request(fromArg, {
|
||||||
|
method: 'get'
|
||||||
|
})
|
||||||
|
.then((res: any) => {
|
||||||
|
if (res.statusCode === 200) {
|
||||||
|
done.resolve(res.body);
|
||||||
|
} else {
|
||||||
|
console.log('could not get remote file from ' + fromArg);
|
||||||
|
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export let toString = (fromArg: string) => {
|
||||||
|
let done = plugins.smartpromise.defer();
|
||||||
|
plugins.smartrequest.getBinary(fromArg).then((res: any) => {
|
||||||
|
if (res.statusCode === 200) {
|
||||||
|
done.resolve(res.body);
|
||||||
|
} else {
|
||||||
|
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
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"
|
|
||||||
}
|
|
||||||
}
|
|
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
Reference in New Issue
Block a user