Compare commits
121 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 |
116
.gitlab-ci.yml
116
.gitlab-ci.yml
@ -1,37 +1,141 @@
|
||||
image: hosttoday/ht-docker-node:npmts
|
||||
# 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 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 test legacy
|
||||
- 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 test lts
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
environment: npm_registry
|
||||
script:
|
||||
- npmci publish
|
||||
- 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 npmpage
|
||||
- npmci command npmpage
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
|
||||
windowsCompatibility:
|
||||
image: stefanscherer/node-windows:10-build-tools
|
||||
stage: metadata
|
||||
script:
|
||||
- npm install & npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- windows
|
||||
allow_failure: true
|
||||
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
||||
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
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
35
README.md
35
README.md
@ -1,13 +1,16 @@
|
||||
# smartfile
|
||||
# @pushrocks/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/)
|
||||
|
||||
[](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)
|
||||
@ -18,19 +21,23 @@ make files easily accessible for processing in javascript.
|
||||
[](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
|
||||
| section | description |
|
||||
| ----------- | ---------------------------------------------------------------------------- |
|
||||
| fs | (object) gets data from fs to somewhere |
|
||||
| memory | gets data from memory to somewhere |
|
||||
| remote | gets data from remote locations to somewhere |
|
||||
| interpreter | (object) handles yaml and json |
|
||||
| smartfile | (class) a virtual representation of a file, alternative to vinyl file format |
|
||||
|
||||
For more information read the docs
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
[](https://push.rocks)
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
|
||||
[](https://push.rocks)
|
||||
|
1
dist/index.d.ts
vendored
1
dist/index.d.ts
vendored
@ -1,4 +1,3 @@
|
||||
import 'typings-global';
|
||||
import * as SmartfileFs from './smartfile.fs';
|
||||
import * as SmartfileInterpreter from './smartfile.interpreter';
|
||||
import * as SmartfileMemory from './smartfile.memory';
|
||||
|
4
dist/index.js
vendored
4
dist/index.js
vendored
@ -1,5 +1,5 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const SmartfileFs = require("./smartfile.fs");
|
||||
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
const SmartfileMemory = require("./smartfile.memory");
|
||||
@ -11,4 +11,4 @@ exports.interpreter = SmartfileInterpreter;
|
||||
exports.memory = SmartfileMemory;
|
||||
exports.remote = SmartfileRemote;
|
||||
exports.requireReload = SmartfileFs.requireReload;
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBR3ZCLDhDQUE2QztBQUM3QyxnRUFBK0Q7QUFDL0Qsc0RBQXFEO0FBQ3JELHNEQUFxRDtBQUVyRCw2RUFBdUQ7QUFBL0Msa0RBQUEsU0FBUyxDQUFBO0FBRU4sUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFBO0FBQ2hCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFBO0FBQ2xDLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQTtBQUN4QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUE7QUFDeEIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQSJ9
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDhDQUE4QztBQUM5QyxnRUFBZ0U7QUFDaEUsc0RBQXNEO0FBQ3RELHNEQUFzRDtBQUV0RCw2RUFBMEQ7QUFBakQsa0RBQUEsU0FBUyxDQUFBO0FBRVAsUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFDO0FBQ2pCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFDO0FBQ25DLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQztBQUN6QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUM7QUFDekIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyJ9
|
80
dist/smartfile.classes.smartfile.d.ts
vendored
80
dist/smartfile.classes.smartfile.d.ts
vendored
@ -1,3 +1,79 @@
|
||||
export declare class Smartfile {
|
||||
constructor();
|
||||
/// <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;
|
||||
}
|
||||
|
115
dist/smartfile.classes.smartfile.js
vendored
115
dist/smartfile.classes.smartfile.js
vendored
@ -1,7 +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 {
|
||||
constructor() {
|
||||
/**
|
||||
* 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtJQUNJO0lBRUEsQ0FBQztDQUNKO0FBSkQsOEJBSUMifQ==
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBK0M7QUFFL0MsNkNBQTZDO0FBUzdDOzs7R0FHRztBQUNIO0lBMkJFOzs7T0FHRztJQUVILFlBQVksVUFBd0M7UUFDbEQsSUFBSSxVQUFVLENBQUMsYUFBYSxFQUFFO1lBQzVCLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQztTQUMvQzthQUFNLElBQUksVUFBVSxDQUFDLGFBQWEsRUFBRTtZQUNuQyxJQUFJLENBQUMscUJBQXFCLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1NBQ3REO2FBQU07WUFDTCxPQUFPLENBQUMsR0FBRyxDQUFDLDBCQUEwQixDQUFDLENBQUM7U0FDekM7UUFDRCxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDaEQsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO0lBQzlCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxxQkFBcUIsQ0FBQyxhQUFxQjtRQUN6QyxJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0csS0FBSyxDQUFDLE9BQWdCOztZQUMxQixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsYUFBYSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ3BELE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzlDLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs4REFBSSxDQUFDO0tBQUE7SUFFZixrREFBa0Q7SUFDbEQsc0JBQXNCO0lBQ3RCLGtEQUFrRDtJQUNsRDs7T0FFRztJQUNILElBQUksUUFBUTtRQUNWLE9BQU8sSUFBSSxDQUFDLGFBQWEsQ0FBQztJQUM1QixDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsV0FBVztRQUN0QixJQUFJLENBQUMsYUFBYSxHQUFHLFdBQVcsQ0FBQztJQUNuQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLEdBQUc7UUFDTCxPQUFPLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLFFBQVE7UUFDVixPQUFPLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU07UUFDSixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBRTtZQUN2QixPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQ7O09BRUc7SUFDSCxRQUFRO1FBQ04sSUFBSSxJQUFJLENBQUMsUUFBUSxZQUFZLE1BQU0sRUFBRTtZQUNuQyxPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsV0FBVztRQUNULE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxVQUFVO1FBQ1IsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsZ0JBQWdCO0lBQ2hCLGNBQWMsQ0FBQyxXQUFtQjtRQUNoQyxJQUFJLFdBQVcsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQztRQUN2QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksTUFBTSxDQUFDLFdBQVcsR0FBRyxHQUFHLENBQUMsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUM1RSxDQUFDO0NBQ0Y7QUFwSUQsOEJBb0lDIn0=
|
75
dist/smartfile.fs.d.ts
vendored
75
dist/smartfile.fs.d.ts
vendored
@ -1,6 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./smartfile.plugins');
|
||||
import { Smartfile } from './smartfile.classes.smartfile';
|
||||
/**
|
||||
*
|
||||
* @param filePath
|
||||
@ -12,7 +10,7 @@ export declare let fileExistsSync: (filePath: any) => boolean;
|
||||
* @param filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let fileExists: (filePath: any) => plugins.q.Promise<{}>;
|
||||
export declare let fileExists: (filePath: any) => Promise<{}>;
|
||||
/**
|
||||
* Checks if given path points to an existing directory
|
||||
*/
|
||||
@ -21,37 +19,64 @@ export declare let isDirectory: (pathArg: any) => boolean;
|
||||
* Checks if a given path points to an existing file
|
||||
*/
|
||||
export declare let isFile: (pathArg: any) => boolean;
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export declare let ensureDir: (dirPathArg: string) => plugins.q.Promise<{}>;
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export declare let ensureDirSync: (dirPathArg: string) => void;
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
export declare let copy: (fromArg: string, toArg: string) => plugins.q.Promise<{}>;
|
||||
export declare let copy: (fromArg: string, toArg: string) => Promise<{}>;
|
||||
/**
|
||||
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
||||
*/
|
||||
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) => plugins.q.Promise<{}>;
|
||||
export declare let remove: (pathArg: string) => Promise<void>;
|
||||
/**
|
||||
* removes a file SYNCHRONOUSLY from local disk
|
||||
*/
|
||||
export declare let removeSync: (pathArg: string) => boolean;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @returns {*}
|
||||
* removes an array of filePaths from disk
|
||||
*/
|
||||
export declare let toGulpStreamSync: (filePathArg: string) => any;
|
||||
export declare let toGulpDestSync: (folderPathArg: string) => any;
|
||||
export declare let removeMany: (filePathArrayArg: string[]) => Promise<void[]>;
|
||||
/**
|
||||
* like removeFilePathArray but SYNCHRONOUSLY
|
||||
*/
|
||||
export declare let removeManySync: (filePathArrayArg: string[]) => void;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
@ -64,7 +89,8 @@ export declare let toObjectSync: (filePathArg: any, fileTypeArg?: any) => any;
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
export declare let toStringSync: (filePath: any) => any;
|
||||
export declare let toStringSync: (filePath: string) => string;
|
||||
export declare let fileTreeToObject: (dirPathArg: string, miniMatchFilter: string) => Promise<Smartfile[]>;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
@ -82,7 +108,7 @@ 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) => plugins.q.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
|
||||
@ -92,7 +118,7 @@ export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => s
|
||||
* lists Files in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => plugins.q.Promise<{}>;
|
||||
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
|
||||
/**
|
||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
@ -102,7 +128,7 @@ export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => str
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns Promise<string[]>
|
||||
*/
|
||||
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => plugins.q.Promise<string[]>;
|
||||
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => Promise<string[]>;
|
||||
/**
|
||||
* lists all items (folders AND files) in a directory on local disk
|
||||
* @returns an array with the folder names as strings
|
||||
@ -111,6 +137,7 @@ export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => plug
|
||||
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: (dirPath: string, miniMatchFilter: string) => plugins.q.Promise<string[]>;
|
||||
export declare let listFileTree: (dirPathArg: string, miniMatchFilter: string) => Promise<string[]>;
|
||||
|
203
dist/smartfile.fs.js
vendored
203
dist/smartfile.fs.js
vendored
File diff suppressed because one or more lines are too long
1
dist/smartfile.interpreter.d.ts
vendored
1
dist/smartfile.interpreter.d.ts
vendored
@ -1,3 +1,2 @@
|
||||
import 'typings-global';
|
||||
export declare let filetype: (pathArg: string) => string;
|
||||
export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any;
|
||||
|
6
dist/smartfile.interpreter.js
vendored
6
dist/smartfile.interpreter.js
vendored
@ -1,5 +1,5 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./smartfile.plugins");
|
||||
exports.filetype = (pathArg) => {
|
||||
let extName = plugins.path.extname(pathArg);
|
||||
@ -14,8 +14,8 @@ exports.objectFile = (fileStringArg, fileTypeArg) => {
|
||||
case 'json':
|
||||
return JSON.parse(fileStringArg);
|
||||
default:
|
||||
plugins.beautylog.error('file type ' + fileTypeArg.blue + ' not supported');
|
||||
console.error('file type ' + fileTypeArg.blue + ' not supported');
|
||||
break;
|
||||
}
|
||||
};
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBdUI7QUFFdkIsK0NBQStDO0FBRXBDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZTtJQUNsQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUMzQyxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBQyxJQUFJLENBQUMsQ0FBQSxDQUFDLHlCQUF5QjtJQUMzRSxNQUFNLENBQUMsUUFBUSxDQUFBO0FBQ25CLENBQUMsQ0FBQTtBQUVVLFFBQUEsVUFBVSxHQUFHLENBQUMsYUFBcUIsRUFBRSxXQUFXO0lBQ3ZELE1BQU0sQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7UUFDbEIsS0FBSyxLQUFLLENBQUU7UUFDWixLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDL0MsS0FBSyxNQUFNO1lBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDcEM7WUFDSSxPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxZQUFZLEdBQUcsV0FBVyxDQUFDLElBQUksR0FBRyxnQkFBZ0IsQ0FBQyxDQUFBO1lBQzNFLEtBQUssQ0FBQTtJQUNiLENBQUM7QUFDTCxDQUFDLENBQUEifQ==
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQWdEO0FBRXJDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFVLEVBQUU7SUFDaEQsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDNUMsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQyx5QkFBeUI7SUFDN0UsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRVMsUUFBQSxVQUFVLEdBQUcsQ0FBQyxhQUFxQixFQUFFLFdBQVcsRUFBRSxFQUFFO0lBQzdELFFBQVEsV0FBVyxFQUFFO1FBQ25CLEtBQUssS0FBSyxDQUFDO1FBQ1gsS0FBSyxNQUFNO1lBQ1QsT0FBTyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUM5QyxLQUFLLE1BQU07WUFDVCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbkM7WUFDRSxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUM7WUFDbEUsTUFBTTtLQUNUO0FBQ0gsQ0FBQyxDQUFDIn0=
|
52
dist/smartfile.memory.d.ts
vendored
52
dist/smartfile.memory.d.ts
vendored
@ -1,15 +1,4 @@
|
||||
/// <reference types="vinyl" />
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./smartfile.plugins');
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
|
||||
* @param fileArg
|
||||
* @returns stream.Readable
|
||||
* @TODO: make it async;
|
||||
*/
|
||||
export declare let toGulpStream: (fileArg: string | string[] | plugins.vinyl | plugins.vinyl[], baseArg?: string) => any;
|
||||
import { Smartfile } from './smartfile.classes.smartfile';
|
||||
/**
|
||||
* converts file to Object
|
||||
* @param fileStringArg
|
||||
@ -17,35 +6,20 @@ export declare let toGulpStream: (fileArg: string | string[] | plugins.vinyl | p
|
||||
* @returns {any|any}
|
||||
*/
|
||||
export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
|
||||
export interface IToFsOptions {
|
||||
respectRelative?: boolean;
|
||||
}
|
||||
/**
|
||||
* takes a string and converts it to vinyl file
|
||||
* @param fileArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
|
||||
filename?: string;
|
||||
base?: string;
|
||||
relPath?: string;
|
||||
}) => plugins.vinyl;
|
||||
/**
|
||||
* takes a string array and some options and returns a vinylfile array
|
||||
* @param arrayArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
|
||||
filename?: string;
|
||||
base?: string;
|
||||
relPath?: string;
|
||||
}) => any[];
|
||||
/**
|
||||
* takes a vinylFile object and converts it to String
|
||||
*/
|
||||
export declare let toStringSync: (fileArg: plugins.vinyl) => any;
|
||||
/**
|
||||
* writes string or vinyl file to disk.
|
||||
* writes string or Smartfile to disk.
|
||||
* @param fileArg
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export declare let toFs: (fileContentArg: string | plugins.vinyl, filePathArg: any) => plugins.q.Promise<{}>;
|
||||
export declare let toFsSync: (fileArg: any, filePathArg: string) => void;
|
||||
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>;
|
||||
|
135
dist/smartfile.memory.js
vendored
135
dist/smartfile.memory.js
vendored
File diff suppressed because one or more lines are too long
14
dist/smartfile.plugins.d.ts
vendored
14
dist/smartfile.plugins.d.ts
vendored
@ -1,16 +1,10 @@
|
||||
import 'typings-global';
|
||||
export import beautylog = require('beautylog');
|
||||
export import fs = require('fs');
|
||||
export import fsExtra = require('fs-extra');
|
||||
export declare let gulp: any;
|
||||
export declare let glob: any;
|
||||
export declare let g: {
|
||||
remoteSrc: any;
|
||||
};
|
||||
export import path = require('path');
|
||||
export import q = require('q');
|
||||
export import vinyl = require('vinyl');
|
||||
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;
|
||||
export declare let request: any;
|
||||
export declare let requireReload: any;
|
||||
|
17
dist/smartfile.plugins.js
vendored
17
dist/smartfile.plugins.js
vendored
@ -1,18 +1,13 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.fs = require("fs");
|
||||
exports.fsExtra = require("fs-extra");
|
||||
exports.gulp = require('gulp');
|
||||
exports.glob = require('glob');
|
||||
exports.g = {
|
||||
remoteSrc: require('gulp-remote-src')
|
||||
};
|
||||
exports.path = require("path");
|
||||
exports.q = require("q");
|
||||
exports.vinyl = require("vinyl");
|
||||
exports.smartpromise = require("@pushrocks/smartpromise");
|
||||
exports.smartrequest = require("@pushrocks/smartrequest");
|
||||
exports.requireReload = require('require-reload');
|
||||
exports.smartpath = require("smartpath");
|
||||
exports.vinylFile = require('vinyl-file');
|
||||
exports.yaml = require('js-yaml');
|
||||
exports.request = require('request');
|
||||
exports.requireReload = require('require-reload');
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHlDQUE4QztBQUM5QywyQkFBZ0M7QUFDaEMsc0NBQTJDO0FBQ2hDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUN0QixRQUFBLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUE7QUFDdEIsUUFBQSxDQUFDLEdBQUc7SUFDWCxTQUFTLEVBQUUsT0FBTyxDQUFDLGlCQUFpQixDQUFDO0NBQ3hDLENBQUE7QUFDRCwrQkFBb0M7QUFDcEMseUJBQThCO0FBQzlCLGlDQUFzQztBQUMzQixRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBQ3pCLFFBQUEsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUM1QixRQUFBLGFBQWEsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQSJ9
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJCQUFpQztBQUNqQyxzQ0FBNEM7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ2xDLCtCQUFxQztBQUNyQywwREFBZ0U7QUFDaEUsMERBQWdFO0FBQ3JELFFBQUEsYUFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0FBQ3JELHlDQUErQztBQUNwQyxRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDbEMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDIn0=
|
14
dist/smartfile.remote.d.ts
vendored
14
dist/smartfile.remote.d.ts
vendored
@ -1,22 +1,12 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./smartfile.plugins');
|
||||
export declare let toFs: (from: string, toPath: string) => plugins.q.Promise<{}>;
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @returns {*}
|
||||
*/
|
||||
export declare let toGulpStreamSync: (filePathArg: string, baseArg: string) => any;
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let toObject: (fromArg: string) => plugins.q.Promise<{}>;
|
||||
export declare let toObject: (fromArg: string) => Promise<{}>;
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
export declare let toString: (fromArg: string) => plugins.q.Promise<{}>;
|
||||
export declare let toString: (fromArg: string) => Promise<{}>;
|
||||
|
59
dist/smartfile.remote.js
vendored
59
dist/smartfile.remote.js
vendored
@ -1,43 +1,32 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./smartfile.plugins");
|
||||
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||
exports.toFs = function (from, toPath) {
|
||||
let done = plugins.q.defer();
|
||||
let stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath));
|
||||
/* 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 filePathArg
|
||||
* @returns {*}
|
||||
*/
|
||||
exports.toGulpStreamSync = function (filePathArg, baseArg) {
|
||||
let stream = plugins.g.remoteSrc(filePathArg, {
|
||||
base: baseArg
|
||||
});
|
||||
return stream;
|
||||
};
|
||||
done.resolve(toPath)
|
||||
})
|
||||
return done.promise
|
||||
} */
|
||||
/**
|
||||
*
|
||||
* @param fromArg
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.toObject = function (fromArg) {
|
||||
let done = plugins.q.defer();
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
let returnObject;
|
||||
if (!error && response.statusCode === 200) {
|
||||
returnObject = SmartfileInterpreter.objectFile(bodyString, SmartfileInterpreter.filetype(fromArg));
|
||||
done.resolve(returnObject);
|
||||
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);
|
||||
returnObject = undefined;
|
||||
done.reject(returnObject);
|
||||
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||
}
|
||||
});
|
||||
return done.promise;
|
||||
@ -48,17 +37,15 @@ exports.toObject = function (fromArg) {
|
||||
* @returns {any}
|
||||
*/
|
||||
exports.toString = (fromArg) => {
|
||||
let done = plugins.q.defer();
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
if (!error && response.statusCode === 200) {
|
||||
done.resolve(bodyString);
|
||||
let done = plugins.smartpromise.defer();
|
||||
plugins.smartrequest.get(fromArg).then((res) => {
|
||||
if (res.statusCode === 200) {
|
||||
done.resolve(res.body);
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.error('could not get remote file from ' + fromArg);
|
||||
bodyString = undefined;
|
||||
done.reject(bodyString);
|
||||
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||
}
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQ0FBK0M7QUFDL0MsZ0VBQWdFO0FBRXJELFFBQUEsSUFBSSxHQUFHLFVBQVMsSUFBWSxFQUFDLE1BQWM7SUFDbEQsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7SUFDbEYsTUFBTSxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUM7UUFDZixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7QUFDdkIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsZ0JBQWdCLEdBQUcsVUFBUyxXQUFtQixFQUFDLE9BQWU7SUFDdEUsSUFBSSxNQUFNLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsV0FBVyxFQUFFO1FBQzFDLElBQUksRUFBRSxPQUFPO0tBQ2hCLENBQUMsQ0FBQTtJQUNGLE1BQU0sQ0FBQyxNQUFNLENBQUE7QUFDakIsQ0FBQyxDQUFBO0FBRUQ7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZTtJQUMxQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxVQUFVLEtBQUssRUFBRSxRQUFRLEVBQUUsVUFBVTtRQUM5RCxJQUFJLFlBQVksQ0FBQTtRQUNoQixFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsWUFBWSxHQUFHLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxVQUFVLEVBQUMsb0JBQW9CLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUE7WUFDakcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM5QixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsR0FBRyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3hELFlBQVksR0FBRyxTQUFTLENBQUE7WUFDeEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUM3QixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUE7QUFFRDs7OztHQUlHO0FBQ1EsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUFlO0lBQ2xDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDNUIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFVBQVUsS0FBSyxFQUFFLFFBQVEsRUFBRSxVQUFVO1FBQzlELEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLFFBQVEsQ0FBQyxVQUFVLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQzVCLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFBO1lBQ3BFLFVBQVUsR0FBRyxTQUFTLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUMzQixDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUEifQ==
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwrQ0FBZ0Q7QUFHaEQ7Ozs7Ozs7SUFPSTtBQUVKOzs7O0dBSUc7QUFDUSxRQUFBLFFBQVEsR0FBRyxVQUFTLE9BQWU7SUFDNUMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWTtTQUNqQixPQUFPLENBQUMsT0FBTyxFQUFFO1FBQ2hCLE1BQU0sRUFBRSxLQUFLO0tBQ2QsQ0FBQztTQUNELElBQUksQ0FBQyxDQUFDLEdBQVEsRUFBRSxFQUFFO1FBQ2pCLElBQUksR0FBRyxDQUFDLFVBQVUsS0FBSyxHQUFHLEVBQUU7WUFDMUIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDeEI7YUFBTTtZQUNMLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUM7WUFDekQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxpQ0FBaUMsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDO1NBQ3JFO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFDTCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDdEIsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFFLEVBQUU7SUFDeEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFRLEVBQUUsRUFBRTtRQUNsRCxJQUFJLEdBQUcsQ0FBQyxVQUFVLEtBQUssR0FBRyxFQUFFO1lBQzFCLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ3hCO2FBQU07WUFDTCxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDckU7SUFDSCxDQUFDLENBQUMsQ0FBQztJQUNILE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN0QixDQUFDLENBQUMifQ==
|
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)
|
@ -5,5 +5,9 @@
|
||||
},
|
||||
"npmdocker":{
|
||||
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
}
|
||||
}
|
1022
package-lock.json
generated
Normal file
1022
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -1,15 +1,17 @@
|
||||
{
|
||||
"name": "smartfile",
|
||||
"version": "4.0.20",
|
||||
"name": "@pushrocks/smartfile",
|
||||
"private": false,
|
||||
"version": "6.0.6",
|
||||
"description": "offers smart ways to work with files in nodejs",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
"test": "(npmts)",
|
||||
"test": "(tstest test/)",
|
||||
"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)",
|
||||
"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": {
|
||||
"type": "git",
|
||||
@ -26,27 +28,22 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/smartfile",
|
||||
"dependencies": {
|
||||
"@types/fs-extra": "0.x.x",
|
||||
"@types/q": "0.x.x",
|
||||
"@types/vinyl": "^1.1.29",
|
||||
"beautylog": "^5.0.23",
|
||||
"fs-extra": "^0.30.0",
|
||||
"glob": "^7.0.6",
|
||||
"gulp": "^3.9.1",
|
||||
"gulp-remote-src": "^0.4.1",
|
||||
"js-yaml": "^3.6.1",
|
||||
"q": "^1.4.1",
|
||||
"request": "^2.75.0",
|
||||
"require-reload": "0.2.2",
|
||||
"typings-global": "^1.0.14",
|
||||
"vinyl": "^1.2.0",
|
||||
"vinyl-file": "^2.0.0"
|
||||
"@pushrocks/smartpath": "^4.0.1",
|
||||
"@pushrocks/smartpromise": "^2.0.5",
|
||||
"@pushrocks/smartrequest": "^1.1.12",
|
||||
"@types/fs-extra": "^5.0.4",
|
||||
"@types/vinyl": "^2.0.2",
|
||||
"fs-extra": "^7.0.0",
|
||||
"glob": "^7.1.2",
|
||||
"js-yaml": "^3.10.0",
|
||||
"vinyl-file": "^3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/should": "^8.1.30",
|
||||
"gulp-function": "^1.3.6",
|
||||
"npmts-g": "^5.2.8",
|
||||
"should": "^11.1.0",
|
||||
"typings-test": "^1.0.3"
|
||||
"@gitzone/tsbuild": "^2.0.21",
|
||||
"@gitzone/tsrun": "^1.1.9",
|
||||
"@gitzone/tstest": "^1.0.12",
|
||||
"@types/node": "^10.5.7",
|
||||
"gulp-function": "^2.2.14",
|
||||
"tapbundle": "^2.0.2"
|
||||
}
|
||||
}
|
||||
|
1
test/test.d.ts
vendored
1
test/test.d.ts
vendored
@ -1 +0,0 @@
|
||||
import 'typings-test';
|
206
test/test.js
206
test/test.js
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
393
test/test.ts
393
test/test.ts
@ -1,227 +1,194 @@
|
||||
import 'typings-test'
|
||||
import * as smartfile from '../dist/index'
|
||||
import beautylog = require('beautylog')
|
||||
let gulp = require('gulp')
|
||||
let gFunction = require('gulp-function')
|
||||
import path = require('path')
|
||||
import * as should from 'should'
|
||||
let vinyl = require('vinyl')
|
||||
import * as smartfile from '../ts/index';
|
||||
import path = require('path');
|
||||
|
||||
describe('smartfile'.yellow, function () {
|
||||
describe('.fs'.yellow, function () {
|
||||
describe('.fileExistsSync'.yellow, function () {
|
||||
it('should return an accurate boolean', function () {
|
||||
should(smartfile.fs.fileExistsSync('./test/mytest.json')).be.true()
|
||||
should(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false()
|
||||
})
|
||||
})
|
||||
describe('.fileExists'.yellow, function () {
|
||||
it('should return a working promise', function () {
|
||||
should(smartfile.fs.fileExists('./test/mytest.json')).be.Promise()
|
||||
should(smartfile.fs.fileExists('./test/mytest.json')).be.fulfilled()
|
||||
should(smartfile.fs.fileExists('./test/notthere.json')).not.be.fulfilled()
|
||||
})
|
||||
})
|
||||
describe('.listFoldersSync()', function () {
|
||||
it('should get the file type from a string', function () {
|
||||
should(smartfile.fs.listFoldersSync('./test/')).containDeep(['testfolder'])
|
||||
should(smartfile.fs.listFoldersSync('./test/')).not.containDeep(['notExistentFolder'])
|
||||
})
|
||||
})
|
||||
describe('.listFolders()', function () {
|
||||
it('should get the file type from a string', function (done) {
|
||||
smartfile.fs.listFolders('./test/')
|
||||
.then(function (folderArrayArg) {
|
||||
should(folderArrayArg).containDeep(['testfolder'])
|
||||
should(folderArrayArg).not.containDeep(['notExistentFolder'])
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
describe('.listFilesSync()', function () {
|
||||
it('should get the file type from a string', function () {
|
||||
should(smartfile.fs.listFilesSync('./test/')).containDeep(['mytest.json'])
|
||||
should(smartfile.fs.listFilesSync('./test/')).not.containDeep(['notExistentFile'])
|
||||
should(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).containDeep(['mytest.json'])
|
||||
should(smartfile.fs.listFilesSync('./test/', /mytests.json/)).not.containDeep(['mytest.json'])
|
||||
})
|
||||
})
|
||||
describe('.listFiles()', function () {
|
||||
it('should get the file type from a string', function (done) {
|
||||
smartfile.fs.listFiles('./test/')
|
||||
.then(function (folderArrayArg) {
|
||||
should(folderArrayArg).containDeep(['mytest.json'])
|
||||
should(folderArrayArg).not.containDeep(['notExistentFile'])
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
describe('.listFileTree()', function () {
|
||||
it('should get a file tree', function (done) {
|
||||
smartfile.fs.listFileTree(path.resolve('./test/'), '**/*.txt')
|
||||
.then(function (folderArrayArg) {
|
||||
should(folderArrayArg).containDeep(['testfolder/testfile1.txt'])
|
||||
should(folderArrayArg).not.containDeep(['mytest.json'])
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
describe('.copy()'.yellow, function () {
|
||||
it('should copy a directory', function () {
|
||||
smartfile.fs.copy('./test/testfolder/', './test/temp/')
|
||||
})
|
||||
it('should copy a file', function () {
|
||||
smartfile.fs.copy('./test/mytest.yaml', './test/temp/')
|
||||
})
|
||||
it('should copy a file and rename it', function () {
|
||||
smartfile.fs.copy('./test/mytest.yaml', './test/temp/mytestRenamed.yaml')
|
||||
})
|
||||
})
|
||||
describe('.remove()', function () {
|
||||
it('should remove an entire directory', function () {
|
||||
import { expect, tap } from 'tapbundle';
|
||||
|
||||
})
|
||||
it('should remove single files', function () {
|
||||
// ---------------------------
|
||||
// smartfile.fs
|
||||
// ---------------------------
|
||||
|
||||
})
|
||||
})
|
||||
})
|
||||
tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
|
||||
expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true;
|
||||
expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false;
|
||||
});
|
||||
|
||||
describe('.interpreter', function () {
|
||||
describe('.filetype()', function () {
|
||||
it('should get the file type from a string', function () {
|
||||
should(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json')
|
||||
})
|
||||
})
|
||||
})
|
||||
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'"
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('.fs'.yellow, function () {
|
||||
describe('toGulpStreamSync() and toGulpDestSync', function () {
|
||||
it('should produce a gulp stream', function (done) {
|
||||
smartfile.fs.toGulpStreamSync('./test/my*')
|
||||
.pipe(smartfile.fs.toGulpDestSync('./test/temp/'))
|
||||
.pipe(gFunction(done, 'atEnd'))
|
||||
})
|
||||
})
|
||||
describe('.toObjectSync()'.yellow, function () {
|
||||
it('should read an ' + '.yaml'.blue + ' file to an object', function () {
|
||||
let testData = smartfile.fs.toObjectSync('./test/mytest.yaml')
|
||||
should(testData).have.property('key1', 'this works')
|
||||
should(testData).have.property('key2', 'this works too')
|
||||
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');
|
||||
});
|
||||
|
||||
})
|
||||
it('should state unknown file type for unknown file types', function () {
|
||||
let testData = smartfile.fs.toObjectSync('./test/mytest.txt')
|
||||
})
|
||||
it('should read an ' + '.json'.blue + ' file to an object', function () {
|
||||
let testData = smartfile.fs.toObjectSync('./test/mytest.json')
|
||||
should(testData).have.property('key1', 'this works')
|
||||
should(testData).have.property('key2', 'this works too')
|
||||
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');
|
||||
});
|
||||
|
||||
})
|
||||
})
|
||||
describe('.toStringSync()'.yellow, function () {
|
||||
it('should read a file to a string', function () {
|
||||
should.equal(
|
||||
smartfile.fs.toStringSync('./test/mytest.txt'),
|
||||
'Some TestString &&%$'
|
||||
)
|
||||
})
|
||||
})
|
||||
describe('.toVinylSync'.yellow, function () {
|
||||
it('should read an ' + '.json OR .yaml'.blue + ' file to an ' + 'vinyl file object'.cyan, function () {
|
||||
let testData = smartfile.fs.toVinylSync('./test/mytest.json')
|
||||
should(vinyl.isVinyl(testData)).be.true()
|
||||
})
|
||||
})
|
||||
})
|
||||
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');
|
||||
});
|
||||
|
||||
describe('.memory', function () {
|
||||
describe('.toGulpStream()', function () {
|
||||
it('should produce a valid gulp stream', function () {
|
||||
let localArray = ['test1', 'test2', 'test3']
|
||||
smartfile.memory.toGulpStream(localArray)
|
||||
.pipe(gulp.dest('./test/temp/'))
|
||||
})
|
||||
})
|
||||
describe('toVinylFileSync()', function () {
|
||||
it('should produce a vinylFile', function () {
|
||||
let localString = 'myString'
|
||||
let localOptions = { filename: 'vinylfile2', base: '/someDir' }
|
||||
should(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).be.true()
|
||||
})
|
||||
})
|
||||
describe('toVinylArraySync()', function () {
|
||||
it('should produce a an array of vinylfiles', function () {
|
||||
let localStringArray = ['string1', 'string2', 'string3']
|
||||
let localOptions = { filename: 'vinylfile2', base: '/someDir' }
|
||||
let testResult = smartfile.memory.toVinylArraySync(localStringArray, localOptions)
|
||||
should(testResult).be.Array()
|
||||
should(testResult.length === 3).be.true()
|
||||
for (let myKey in testResult) {
|
||||
should(testResult[myKey] instanceof vinyl).be.true()
|
||||
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');
|
||||
}
|
||||
})
|
||||
})
|
||||
describe('toStringSync()', function () {
|
||||
it('should produce a String from vinyl file', function () {
|
||||
let localString = smartfile.memory.toStringSync(new vinyl({
|
||||
base: '/',
|
||||
path: '/test.txt',
|
||||
contents: new Buffer('myString')
|
||||
}))
|
||||
should(localString).equal('myString')
|
||||
})
|
||||
})
|
||||
describe('toFs()', function () {
|
||||
it('should write a file to disk and return a promise', function (done) {
|
||||
let localString = 'myString'
|
||||
smartfile.memory.toFs(
|
||||
localString,
|
||||
path.join(process.cwd(), './test/temp/testMemToFs.txt')
|
||||
).then(done)
|
||||
})
|
||||
})
|
||||
describe('toFsSync()', function () {
|
||||
it('should write a file to disk and return true if successfull', function () {
|
||||
let localString = 'myString'
|
||||
);
|
||||
|
||||
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')
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
describe('.remote', function () {
|
||||
describe('toGulpStreamSync()', function () {
|
||||
it('should produce a gulp stream', function (done) {
|
||||
this.timeout(5000)
|
||||
smartfile.remote.toGulpStreamSync(
|
||||
'mytest.txt', 'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/'
|
||||
).pipe(smartfile.fs.toGulpDestSync('./test/temp/'))
|
||||
.pipe(gFunction(done, 'atEnd'))
|
||||
})
|
||||
})
|
||||
describe('.toString()', function () {
|
||||
it('should load a remote file to a variable', function (done) {
|
||||
this.timeout(5000)
|
||||
smartfile.remote.toString(
|
||||
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'
|
||||
).then(function (responseString) {
|
||||
should.equal(responseString, 'Some TestString &&%$')
|
||||
done()
|
||||
})
|
||||
})
|
||||
it('should reject a Promise when the link is false', function (done) {
|
||||
this.timeout(10000)
|
||||
smartfile.remote.toString('https://push.rocks/doesnotexist.txt')
|
||||
.then(function () {
|
||||
throw new Error('this test should not be resolved')
|
||||
}, function () {
|
||||
done()
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
);
|
||||
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
|
23
ts/index.ts
23
ts/index.ts
@ -1,15 +1,12 @@
|
||||
import 'typings-global'
|
||||
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 * as plugins from './smartfile.plugins'
|
||||
import * as SmartfileFs from './smartfile.fs'
|
||||
import * as SmartfileInterpreter from './smartfile.interpreter'
|
||||
import * as SmartfileMemory from './smartfile.memory'
|
||||
import * as SmartfileRemote from './smartfile.remote'
|
||||
export { Smartfile } from './smartfile.classes.smartfile';
|
||||
|
||||
export {Smartfile} from './smartfile.classes.smartfile'
|
||||
|
||||
export let fs = SmartfileFs
|
||||
export let interpreter = SmartfileInterpreter
|
||||
export let memory = SmartfileMemory
|
||||
export let remote = SmartfileRemote
|
||||
export let requireReload = SmartfileFs.requireReload
|
||||
export let fs = SmartfileFs;
|
||||
export let interpreter = SmartfileInterpreter;
|
||||
export let memory = SmartfileMemory;
|
||||
export let remote = SmartfileRemote;
|
||||
|
@ -1,5 +1,148 @@
|
||||
export class Smartfile {
|
||||
constructor() {
|
||||
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);
|
||||
}
|
||||
}
|
||||
|
@ -1,8 +1,9 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./smartfile.plugins');
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter');
|
||||
|
||||
import plugins = require('./smartfile.plugins')
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
import { Smartfile } from './smartfile.classes.smartfile';
|
||||
|
||||
import * as memory from './smartfile.memory';
|
||||
/*===============================================================
|
||||
============================ Checks =============================
|
||||
===============================================================*/
|
||||
@ -13,15 +14,15 @@ import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export let fileExistsSync = function(filePath): boolean {
|
||||
let fileExistsBool: boolean = false
|
||||
let fileExistsBool: boolean = false;
|
||||
try {
|
||||
plugins.fsExtra.readFileSync(filePath)
|
||||
fileExistsBool = true
|
||||
plugins.fsExtra.readFileSync(filePath);
|
||||
fileExistsBool = true;
|
||||
} catch (err) {
|
||||
fileExistsBool = false
|
||||
}
|
||||
return fileExistsBool
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
@ -29,103 +30,163 @@ export let fileExistsSync = function(filePath): boolean {
|
||||
* @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(err) : done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
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 {
|
||||
return plugins.fsExtra.statSync(pathArg).isDirectory()
|
||||
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()
|
||||
}
|
||||
return plugins.fsExtra.statSync(pathArg).isFile();
|
||||
};
|
||||
|
||||
/*===============================================================
|
||||
============================ FS ACTIONS =========================
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export let ensureDir = (dirPathArg: string) => {
|
||||
let done = plugins.q.defer()
|
||||
plugins.fsExtra.ensureDir(dirPathArg,done.resolve)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
* ensures that a directory is in place
|
||||
*/
|
||||
export let ensureDirSync = (dirPathArg: string) => {
|
||||
plugins.fsExtra.ensureDirSync(dirPathArg)
|
||||
}
|
||||
|
||||
/**
|
||||
* copies a file from A to B on the local disk
|
||||
*/
|
||||
export let copy = function(fromArg: string, toArg: string) {
|
||||
let done = plugins.q.defer()
|
||||
let done = plugins.smartpromise.defer();
|
||||
plugins.fsExtra.copy(fromArg, toArg, {}, function() {
|
||||
done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
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
|
||||
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){
|
||||
let done = plugins.q.defer()
|
||||
export let remove = function(pathArg: string): Promise<void> {
|
||||
let done = plugins.smartpromise.defer<void>();
|
||||
plugins.fsExtra.remove(pathArg, function() {
|
||||
done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
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
|
||||
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
|
||||
* @returns {*}
|
||||
*/
|
||||
export let toGulpStreamSync = function(filePathArg: string){
|
||||
let stream = plugins.gulp.src(filePathArg)
|
||||
return stream
|
||||
}
|
||||
|
||||
export let toGulpDestSync = function(folderPathArg: string){
|
||||
return plugins.gulp.dest(folderPathArg)
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
@ -133,23 +194,55 @@ export let toGulpDestSync = function(folderPathArg: string){
|
||||
* @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)
|
||||
}
|
||||
let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
|
||||
let fileType;
|
||||
fileTypeArg ? (fileType = fileTypeArg) : (fileType = SmartfileInterpreter.filetype(filePathArg));
|
||||
return SmartfileInterpreter.objectFile(fileString, fileType);
|
||||
};
|
||||
|
||||
/**
|
||||
* reads a file content to a String
|
||||
* @param filePath
|
||||
* @returns {string|Buffer|any}
|
||||
*/
|
||||
export let toStringSync = function(filePath) {
|
||||
let fileString
|
||||
fileString = plugins.fsExtra.readFileSync(filePath, 'utf8')
|
||||
return fileString
|
||||
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
|
||||
@ -157,35 +250,26 @@ export let toStringSync = function(filePath) {
|
||||
* @returns {number}
|
||||
*/
|
||||
export let toVinylSync = function(filePathArg, options = {}) {
|
||||
return plugins.vinylFile.readSync(filePathArg,options)
|
||||
}
|
||||
|
||||
/**
|
||||
* lets you reload files hot.
|
||||
* @param path
|
||||
* @returns {any}
|
||||
*/
|
||||
export let requireReload = function(path: string){
|
||||
return plugins.requireReload(path)
|
||||
}
|
||||
return plugins.vinylFile.readSync(filePathArg, options);
|
||||
};
|
||||
|
||||
/**
|
||||
* lists Folders in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listFolders = function(pathArg: string, regexFilter?: RegExp) {
|
||||
let done = plugins.q.defer()
|
||||
let done = plugins.smartpromise.defer();
|
||||
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory()
|
||||
})
|
||||
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
|
||||
folderArray = folderArray.filter(fileItem => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
}
|
||||
done.resolve(folderArray);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||
@ -193,33 +277,33 @@ export let listFolders = function(pathArg: string,regexFilter?: RegExp){
|
||||
*/
|
||||
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()
|
||||
})
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
|
||||
});
|
||||
if (regexFilter) {
|
||||
folderArray = folderArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
return folderArray
|
||||
folderArray = folderArray.filter(fileItem => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
}
|
||||
return folderArray;
|
||||
};
|
||||
|
||||
/**
|
||||
* lists Files in a directory on local disk
|
||||
* @returns Promise
|
||||
*/
|
||||
export let listFiles = function(pathArg: string, regexFilter?: RegExp) {
|
||||
let done = plugins.q.defer()
|
||||
let done = plugins.smartpromise.defer();
|
||||
let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile()
|
||||
})
|
||||
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
|
||||
fileArray = fileArray.filter(fileItem => {
|
||||
return regexFilter.test(fileItem);
|
||||
});
|
||||
}
|
||||
done.resolve(fileArray);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||
@ -227,31 +311,31 @@ export let listFiles = function(pathArg: string, regexFilter?: RegExp){
|
||||
*/
|
||||
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()
|
||||
})
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||
});
|
||||
if (regexFilter) {
|
||||
fileArray = fileArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
return fileArray
|
||||
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): plugins.q.Promise<string[]> {
|
||||
let done = plugins.q.defer<string[]>()
|
||||
let allItmesArray = plugins.fsExtra.readdirSync(pathArg)
|
||||
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
|
||||
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
|
||||
@ -260,31 +344,43 @@ export let listAllItems = function(pathArg: string, regexFilter?: RegExp): plugi
|
||||
*/
|
||||
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()
|
||||
})
|
||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||
});
|
||||
if (regexFilter) {
|
||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||
return regexFilter.test(fileItem)
|
||||
})
|
||||
}
|
||||
return allItmesArray
|
||||
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 = (dirPath: string, miniMatchFilter: string): plugins.q.Promise<string[]> => {
|
||||
let done = plugins.q.defer<string[]>()
|
||||
let options = {
|
||||
cwd: dirPath
|
||||
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
|
||||
console.log(err);
|
||||
done.reject(err);
|
||||
}
|
||||
done.resolve(files);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
@ -1,22 +1,20 @@
|
||||
import 'typings-global'
|
||||
|
||||
import plugins = require('./smartfile.plugins')
|
||||
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
|
||||
}
|
||||
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)
|
||||
return plugins.yaml.safeLoad(fileStringArg);
|
||||
case 'json':
|
||||
return JSON.parse(fileStringArg)
|
||||
return JSON.parse(fileStringArg);
|
||||
default:
|
||||
plugins.beautylog.error('file type ' + fileTypeArg.blue + ' not supported')
|
||||
break
|
||||
}
|
||||
console.error('file type ' + fileTypeArg.blue + ' not supported');
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
@ -1,46 +1,8 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./smartfile.plugins');
|
||||
import { Smartfile } from './smartfile.classes.smartfile';
|
||||
import * as smartfileFs from './smartfile.fs';
|
||||
|
||||
import plugins = require('./smartfile.plugins')
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
import vinyl = require('vinyl')
|
||||
let Readable = require('stream').Readable
|
||||
|
||||
|
||||
/**
|
||||
* allows you to create a gulp stream
|
||||
* from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
|
||||
* @param fileArg
|
||||
* @returns stream.Readable
|
||||
* @TODO: make it async;
|
||||
*/
|
||||
export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugins.vinyl[],baseArg: string = '/'){
|
||||
let fileArray = []
|
||||
|
||||
if (typeof fileArg === 'string' || fileArg instanceof plugins.vinyl) { // make sure we work with an array later on
|
||||
fileArray.push(fileArg)
|
||||
} else if (Array.isArray(fileArg)) {
|
||||
fileArray = fileArg
|
||||
} else {
|
||||
throw new Error('fileArg has unknown format')
|
||||
}
|
||||
|
||||
let vinylFileArray: plugins.vinyl[] = [] // we want to have an array of vinylFiles
|
||||
|
||||
for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
|
||||
let file = fileArray[fileIndexArg]
|
||||
file instanceof plugins.vinyl ?
|
||||
vinylFileArray.push(file) :
|
||||
vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
|
||||
};
|
||||
|
||||
let stream = new Readable({ objectMode: true })
|
||||
for (let vinylFileIndexArg in vinylFileArray) {
|
||||
let vinylFile = vinylFileArray[vinylFileIndexArg]
|
||||
stream.push(vinylFile)
|
||||
};
|
||||
stream.push(null) // signal end of stream;
|
||||
return stream
|
||||
}
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter');
|
||||
|
||||
/**
|
||||
* converts file to Object
|
||||
@ -49,91 +11,81 @@ export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugin
|
||||
* @returns {any|any}
|
||||
*/
|
||||
export let toObject = function(fileStringArg: string, fileTypeArg: string) {
|
||||
return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
|
||||
}
|
||||
|
||||
/**
|
||||
* takes a string and converts it to vinyl file
|
||||
* @param fileArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}){
|
||||
optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
|
||||
optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
|
||||
optionsArg.base ? void(0) : optionsArg.base = '/'
|
||||
optionsArg.relPath ? void('0') : optionsArg.relPath = ''
|
||||
let vinylFile = new plugins.vinyl({
|
||||
base: optionsArg.base,
|
||||
path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
|
||||
contents: new Buffer(fileArg)
|
||||
})
|
||||
return vinylFile
|
||||
return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
|
||||
};
|
||||
|
||||
/**
|
||||
* takes a string array and some options and returns a vinylfile array
|
||||
* @param arrayArg
|
||||
* @param optionsArg
|
||||
*/
|
||||
export let toVinylArraySync = function(arrayArg: string[],optionsArg?: {filename?: string,base?: string,relPath?: string}){
|
||||
let vinylArray = []
|
||||
for (let stringIndexArg in arrayArg) {
|
||||
let myString = arrayArg[stringIndexArg]
|
||||
vinylArray.push(toVinylFileSync(myString,optionsArg))
|
||||
}
|
||||
return vinylArray
|
||||
export interface IToFsOptions {
|
||||
respectRelative?: boolean;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* takes a vinylFile object and converts it to String
|
||||
*/
|
||||
export let toStringSync = function(fileArg: plugins.vinyl){
|
||||
return fileArg.contents.toString('utf8')
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* writes string or vinyl file to disk.
|
||||
* writes string or Smartfile to disk.
|
||||
* @param fileArg
|
||||
* @param fileNameArg
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export let toFs = function(fileContentArg: string|vinyl,filePathArg){
|
||||
let done = plugins.q.defer()
|
||||
export let toFs = async (
|
||||
fileContentArg: string | Smartfile,
|
||||
filePathArg,
|
||||
optionsArg: IToFsOptions = {}
|
||||
) => {
|
||||
let done = plugins.smartpromise.defer();
|
||||
|
||||
// function checks to abort if needed
|
||||
// check args
|
||||
if (!fileContentArg || !filePathArg) {
|
||||
throw new Error('expected valid arguments')
|
||||
throw new Error('expected valid arguments');
|
||||
}
|
||||
|
||||
// prepare actual write action
|
||||
let fileString: string
|
||||
let fileString: string;
|
||||
let filePath: string = filePathArg;
|
||||
if (fileContentArg instanceof plugins.vinyl) {
|
||||
fileString = toStringSync(fileContentArg)
|
||||
} else if (typeof fileContentArg === 'string') {
|
||||
fileString = fileContentArg
|
||||
}
|
||||
plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let toFsSync = function(fileArg,filePathArg: string){
|
||||
// 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')
|
||||
throw new Error('expected a valid arguments');
|
||||
}
|
||||
|
||||
// prepare actual write action
|
||||
let fileString: string
|
||||
let filePath: string = filePathArg
|
||||
let fileString: string;
|
||||
let filePath: string = filePathArg;
|
||||
|
||||
if (fileArg instanceof plugins.vinyl) {
|
||||
fileString = toStringSync(fileArg)
|
||||
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,'utf8')
|
||||
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,16 +1,9 @@
|
||||
import 'typings-global'
|
||||
export import beautylog = require('beautylog')
|
||||
export import fs = require('fs')
|
||||
export import fsExtra = require('fs-extra')
|
||||
export let gulp = require('gulp')
|
||||
export let glob = require('glob')
|
||||
export let g = {
|
||||
remoteSrc: require('gulp-remote-src')
|
||||
}
|
||||
export import path = require('path')
|
||||
export import q = require('q')
|
||||
export import vinyl = require('vinyl')
|
||||
export let vinylFile = require('vinyl-file')
|
||||
export let yaml = require('js-yaml')
|
||||
export let request = require('request')
|
||||
export let requireReload = require('require-reload')
|
||||
export import fs = require('fs');
|
||||
export import fsExtra = require('fs-extra');
|
||||
export let glob = require('glob');
|
||||
export import path = require('path');
|
||||
export import smartpromise = require('@pushrocks/smartpromise');
|
||||
export import smartrequest = require('@pushrocks/smartrequest');
|
||||
export import smartpath = require('@pushrocks/smartpath');
|
||||
export let vinylFile = require('vinyl-file');
|
||||
export let yaml = require('js-yaml');
|
||||
|
@ -1,27 +1,14 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./smartfile.plugins')
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter')
|
||||
import plugins = require('./smartfile.plugins');
|
||||
import SmartfileInterpreter = require('./smartfile.interpreter');
|
||||
|
||||
export let toFs = function(from: string,toPath: string) {
|
||||
/* export let toFs = function (from: string, toPath: string) {
|
||||
let done = plugins.q.defer()
|
||||
let stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath))
|
||||
let stream = plugins.smartrequest(from).pipe(plugins.fsExtra.createWriteStream(toPath))
|
||||
stream.on('finish', function () {
|
||||
done.resolve(toPath)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param filePathArg
|
||||
* @returns {*}
|
||||
*/
|
||||
export let toGulpStreamSync = function(filePathArg: string,baseArg: string){
|
||||
let stream = plugins.g.remoteSrc(filePathArg, {
|
||||
base: baseArg
|
||||
})
|
||||
return stream
|
||||
}
|
||||
} */
|
||||
|
||||
/**
|
||||
*
|
||||
@ -29,20 +16,21 @@ export let toGulpStreamSync = function(filePathArg: string,baseArg: string){
|
||||
* @returns {any}
|
||||
*/
|
||||
export let toObject = function(fromArg: string) {
|
||||
let done = plugins.q.defer()
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
let returnObject
|
||||
if (!error && response.statusCode === 200) {
|
||||
returnObject = SmartfileInterpreter.objectFile(bodyString,SmartfileInterpreter.filetype(fromArg))
|
||||
done.resolve(returnObject)
|
||||
} else {
|
||||
console.log('could not get remote file from ' + fromArg)
|
||||
returnObject = undefined
|
||||
done.reject(returnObject)
|
||||
}
|
||||
let done = plugins.smartpromise.defer();
|
||||
plugins.smartrequest
|
||||
.request(fromArg, {
|
||||
method: 'get'
|
||||
})
|
||||
return done.promise
|
||||
.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;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
@ -50,15 +38,13 @@ export let toObject = function(fromArg: string){
|
||||
* @returns {any}
|
||||
*/
|
||||
export let toString = (fromArg: string) => {
|
||||
let done = plugins.q.defer()
|
||||
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||
if (!error && response.statusCode === 200) {
|
||||
done.resolve(bodyString)
|
||||
let done = plugins.smartpromise.defer();
|
||||
plugins.smartrequest.getBinary(fromArg).then((res: any) => {
|
||||
if (res.statusCode === 200) {
|
||||
done.resolve(res.body);
|
||||
} else {
|
||||
plugins.beautylog.error('could not get remote file from ' + fromArg)
|
||||
bodyString = undefined
|
||||
done.reject(bodyString)
|
||||
}
|
||||
})
|
||||
return done.promise
|
||||
done.reject(new Error('could not get remote file from ' + fromArg));
|
||||
}
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
Reference in New Issue
Block a user