Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
00611e9492 | |||
77c7af46b6 |
24
.gitignore
vendored
24
.gitignore
vendored
@ -1,20 +1,12 @@
|
|||||||
.nogit/
|
|
||||||
|
|
||||||
# artifacts
|
|
||||||
coverage/
|
|
||||||
public/
|
|
||||||
pages/
|
|
||||||
|
|
||||||
# installs
|
|
||||||
node_modules/
|
node_modules/
|
||||||
|
.settings/
|
||||||
|
.idea/
|
||||||
|
coverage/
|
||||||
|
docs/
|
||||||
|
|
||||||
# caches
|
ts/*.js
|
||||||
.yarn/
|
ts/*.js.map
|
||||||
.cache/
|
ts/typings/
|
||||||
.rpt2_cache
|
|
||||||
|
|
||||||
# builds
|
test/temp/
|
||||||
dist/
|
|
||||||
dist_*/
|
|
||||||
|
|
||||||
# custom
|
|
124
.gitlab-ci.yml
124
.gitlab-ci.yml
@ -1,137 +1,37 @@
|
|||||||
# gitzone ci_default
|
image: hosttoday/ht-docker-node:npmts
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
|
|
||||||
cache:
|
|
||||||
paths:
|
|
||||||
- .npmci_cache/
|
|
||||||
key: '$CI_BUILD_STAGE'
|
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- test
|
||||||
- test
|
- release
|
||||||
- release
|
|
||||||
- metadata
|
|
||||||
|
|
||||||
# ====================
|
testLEGACY:
|
||||||
# security stage
|
stage: test
|
||||||
# ====================
|
|
||||||
mirror:
|
|
||||||
stage: security
|
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci test legacy
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
auditProductionDependencies:
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --production --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high --only=prod --production
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
auditDevDependencies:
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high --only=dev
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
testLTS:
|
||||||
# test stage
|
|
||||||
# ====================
|
|
||||||
|
|
||||||
testStable:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci test lts
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
testBuild:
|
testSTABLE:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci test stable
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command npm run build
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
|
environment: npm_registry
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci publish
|
||||||
- npmci npm publish
|
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# metadata stage
|
|
||||||
# ====================
|
|
||||||
codequality:
|
|
||||||
stage: metadata
|
|
||||||
allow_failure: true
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
script:
|
|
||||||
- npmci command npm install -g tslint typescript
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- priv
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
stage: metadata
|
|
||||||
script:
|
|
||||||
- npmci trigger
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
pages:
|
|
||||||
stage: metadata
|
|
||||||
script:
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command tsdoc
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
artifacts:
|
|
||||||
expire_in: 1 week
|
|
||||||
paths:
|
|
||||||
- public
|
|
||||||
allow_failure: true
|
|
||||||
|
4
.snyk
4
.snyk
@ -1,4 +0,0 @@
|
|||||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
|
||||||
version: v1.13.1
|
|
||||||
ignore: {}
|
|
||||||
patch: {}
|
|
15
.travis.yml
Normal file
15
.travis.yml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
language: node_js
|
||||||
|
node_js:
|
||||||
|
- 4
|
||||||
|
- stable
|
||||||
|
deploy:
|
||||||
|
provider: npm
|
||||||
|
email: npm@lossless.digital
|
||||||
|
api_key:
|
||||||
|
secure: wIOQHE7Jbck2j5lcv1Rc8T9/1wbHNGLxqJ6pttNZ+hG1+w77TYnjNYuGtM2xQCXitXSFDoogU8MpiYieOQHYypFgJ6Ns8MTeKIzNJSnlOWdCSN/lVptscT8pyC6qD4IBAyi8m5F2HoGQR+IzcdDBPjXLaPbH7jn8hc9rNY+LNktmYOXfOr37P40pxYrf16GLwrkjQIK8pbkdIbNA0D0k3apTGqw+HsneN2D/O/zAYaB3ojm40ttgPAGYF5PO5t6uqIbPFgIPkMWsO1HbV6I+vOAuIf0KYUqnR/YZd5yFcxFt3c+bfyc8/LP4vy5FyKMLXHe4IXIjXPYetOSiVHgMMYaxawU51OqwIKO+87FJ1TdaVmacMFO0wagl2QS0ceQBn8KBUhljHu/fDInK82uy15Iddk44EhnTx1MIxxgH5WMM6aQB2vuqnViPghs4nA0Y/Dz2U69267fhvmZvEWWUndz058EksHdZsIt5WCqQErI/dWLXMGom94CuZv6nkoVHCw8CO5dqVvfqUFL7Qyw59kRbiUPItFVoiV8ptLUX9tnQ5xBukNRkFX34ViM9YvBRlGt5e//f+cWjUpXFvbrwkqusXArplpxIaUSsQKh7XaMB5DcZ5jDDdjKzIMDf6QWsMTU1rjfQS5ZS3eV5LPy0UlfpDGK28oK2/o8fM+yydVk=
|
||||||
|
on:
|
||||||
|
tags: true
|
||||||
|
repo: pushrocks/smartfile
|
||||||
|
notifications:
|
||||||
|
slack:
|
||||||
|
secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=
|
29
.vscode/launch.json
vendored
29
.vscode/launch.json
vendored
@ -1,29 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "current file",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"args": [
|
|
||||||
"${relativeFile}"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "test.ts",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"args": [
|
|
||||||
"test/test.ts"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"json.schemas": [
|
|
||||||
{
|
|
||||||
"fileMatch": ["/npmextra.json"],
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"npmci": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for npmci"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for gitzone",
|
|
||||||
"properties": {
|
|
||||||
"projectType": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2015 Lossless GmbH
|
Copyright (c) 2015 Push.Rocks
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
13
README.md
Normal file
13
README.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# smartfile
|
||||||
|
make files easily accessible for processing in javascript.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
||||||
|
[](https://david-dm.org/pushrocks/smartfile)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/smartfile)
|
||||||
|
[](https://codecov.io/github/pushrocks/smartfile?branch=master)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
smartfile is an approach of being one tool to handle files in diverse environments.
|
||||||
|
It can fetch files from remote locations, work with local disks and do pure memory operations.
|
10
appveyor.yml
Normal file
10
appveyor.yml
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
environment:
|
||||||
|
nodejs_version: "4"
|
||||||
|
install:
|
||||||
|
- ps: Install-Product node $env:nodejs_version
|
||||||
|
- npm install
|
||||||
|
test_script:
|
||||||
|
- node --version
|
||||||
|
- npm --version
|
||||||
|
- npm test
|
||||||
|
build: off
|
11
dist/index.d.ts
vendored
Normal file
11
dist/index.d.ts
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
import "typings-global";
|
||||||
|
import * as SmartfileFs from "./smartfile.fs";
|
||||||
|
import * as SmartfileInterpreter from "./smartfile.interpreter";
|
||||||
|
import * as SmartfileMemory from "./smartfile.memory";
|
||||||
|
import * as SmartfileRemote from "./smartfile.remote";
|
||||||
|
export { Smartfile } from "./smartfile.classes.smartfile";
|
||||||
|
export declare let fs: typeof SmartfileFs;
|
||||||
|
export declare let interpreter: typeof SmartfileInterpreter;
|
||||||
|
export declare let memory: typeof SmartfileMemory;
|
||||||
|
export declare let remote: typeof SmartfileRemote;
|
||||||
|
export declare let requireReload: (path: string) => any;
|
14
dist/index.js
vendored
Normal file
14
dist/index.js
vendored
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
const SmartfileFs = require("./smartfile.fs");
|
||||||
|
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||||
|
const SmartfileMemory = require("./smartfile.memory");
|
||||||
|
const SmartfileRemote = require("./smartfile.remote");
|
||||||
|
var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
|
||||||
|
exports.Smartfile = smartfile_classes_smartfile_1.Smartfile;
|
||||||
|
exports.fs = SmartfileFs;
|
||||||
|
exports.interpreter = SmartfileInterpreter;
|
||||||
|
exports.memory = SmartfileMemory;
|
||||||
|
exports.remote = SmartfileRemote;
|
||||||
|
exports.requireReload = SmartfileFs.requireReload;
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBR3hCLE1BQVksV0FBVyxXQUFNLGdCQUFnQixDQUFDLENBQUE7QUFDOUMsTUFBWSxvQkFBb0IsV0FBTSx5QkFDdEMsQ0FBQyxDQUQ4RDtBQUMvRCxNQUFZLGVBQWUsV0FBTSxvQkFBb0IsQ0FBQyxDQUFBO0FBQ3RELE1BQVksZUFBZSxXQUFNLG9CQUFvQixDQUFDLENBQUE7QUFFdEQsNENBQXdCLCtCQUErQixDQUFDO0FBQWhELDREQUFnRDtBQUU3QyxVQUFFLEdBQUcsV0FBVyxDQUFDO0FBQ2pCLG1CQUFXLEdBQUcsb0JBQW9CLENBQUM7QUFDbkMsY0FBTSxHQUFHLGVBQWUsQ0FBQztBQUN6QixjQUFNLEdBQUcsZUFBZSxDQUFDO0FBQ3pCLHFCQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyJ9
|
3
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
3
dist/smartfile.classes.smartfile.d.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
export declare class Smartfile {
|
||||||
|
constructor();
|
||||||
|
}
|
8
dist/smartfile.classes.smartfile.js
vendored
Normal file
8
dist/smartfile.classes.smartfile.js
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
"use strict";
|
||||||
|
class Smartfile {
|
||||||
|
constructor() {
|
||||||
|
}
|
||||||
|
;
|
||||||
|
}
|
||||||
|
exports.Smartfile = Smartfile;
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTtJQUNJO0lBRUEsQ0FBQzs7QUFDTCxDQUFDO0FBSlksaUJBQVMsWUFJckIsQ0FBQSJ9
|
111
dist/smartfile.fs.d.ts
vendored
Normal file
111
dist/smartfile.fs.d.ts
vendored
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import "typings-global";
|
||||||
|
import plugins = require("./smartfile.plugins");
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePath
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
export declare let fileExistsSync: (filePath: any) => boolean;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePath
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let fileExists: (filePath: any) => plugins.Q.Promise<{}>;
|
||||||
|
/**
|
||||||
|
* Checks if given path points to an existing directory
|
||||||
|
*/
|
||||||
|
export declare let isDirectory: (pathArg: any) => boolean;
|
||||||
|
/**
|
||||||
|
* Checks if a given path points to an existing file
|
||||||
|
*/
|
||||||
|
export declare let isFile: (pathArg: any) => boolean;
|
||||||
|
/**
|
||||||
|
* 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<{}>;
|
||||||
|
/**
|
||||||
|
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
||||||
|
*/
|
||||||
|
export declare let copySync: (fromArg: string, toArg: string) => boolean;
|
||||||
|
/**
|
||||||
|
* removes a file or folder from local disk
|
||||||
|
*/
|
||||||
|
export declare let remove: (pathArg: string) => plugins.Q.Promise<{}>;
|
||||||
|
/**
|
||||||
|
* removes a file SYNCHRONOUSLY from local disk
|
||||||
|
*/
|
||||||
|
export declare let removeSync: (pathArg: string) => boolean;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @returns {*}
|
||||||
|
*/
|
||||||
|
export declare let toGulpStreamSync: (filePathArg: string) => any;
|
||||||
|
export declare let toGulpDestSync: (folderPathArg: string) => any;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @param fileTypeArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let toObjectSync: (filePathArg: any, fileTypeArg?: any) => any;
|
||||||
|
/**
|
||||||
|
* reads a file content to a String
|
||||||
|
* @param filePath
|
||||||
|
* @returns {string|Buffer|any}
|
||||||
|
*/
|
||||||
|
export declare let toStringSync: (filePath: any) => any;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @param options
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
export declare let toVinylSync: (filePathArg: any, options?: {}) => any;
|
||||||
|
/**
|
||||||
|
* lets you reload files hot.
|
||||||
|
* @param path
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let requireReload: (path: string) => any;
|
||||||
|
/**
|
||||||
|
* lists Folders in a directory on local disk
|
||||||
|
* @returns Promise
|
||||||
|
*/
|
||||||
|
export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => plugins.Q.Promise<{}>;
|
||||||
|
/**
|
||||||
|
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||||
|
* @returns an array with the folder names as strings
|
||||||
|
*/
|
||||||
|
export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||||
|
/**
|
||||||
|
* lists Files in a directory on local disk
|
||||||
|
* @returns Promise
|
||||||
|
*/
|
||||||
|
export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => plugins.Q.Promise<{}>;
|
||||||
|
/**
|
||||||
|
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||||
|
* @returns an array with the folder names as strings
|
||||||
|
*/
|
||||||
|
export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||||
|
/**
|
||||||
|
* lists all items (folders AND files) in a directory on local disk
|
||||||
|
* @returns Promise
|
||||||
|
*/
|
||||||
|
export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => plugins.Q.Promise<{}>;
|
||||||
|
/**
|
||||||
|
* lists all items (folders AND files) SYNCHRONOUSLY in a directory on local disk
|
||||||
|
* @returns an array with the folder names as strings
|
||||||
|
*/
|
||||||
|
export declare let listAllItemsSync: (pathArg: string, regexFilter?: RegExp) => string[];
|
||||||
|
export declare let listFileTree: (dirPath: string, miniMatchFilter: string) => plugins.Q.Promise<{}>;
|
267
dist/smartfile.fs.js
vendored
Normal file
267
dist/smartfile.fs.js
vendored
Normal file
File diff suppressed because one or more lines are too long
3
dist/smartfile.interpreter.d.ts
vendored
Normal file
3
dist/smartfile.interpreter.d.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import "typings-global";
|
||||||
|
export declare let filetype: (pathArg: string) => string;
|
||||||
|
export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any;
|
21
dist/smartfile.interpreter.js
vendored
Normal file
21
dist/smartfile.interpreter.js
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
const plugins = require("./smartfile.plugins");
|
||||||
|
exports.filetype = (pathArg) => {
|
||||||
|
let extName = plugins.path.extname(pathArg);
|
||||||
|
let fileType = extName.replace(/\.([a-z]*)/, "$1"); //remove . form fileType
|
||||||
|
return fileType;
|
||||||
|
};
|
||||||
|
exports.objectFile = (fileStringArg, fileTypeArg) => {
|
||||||
|
switch (fileTypeArg) {
|
||||||
|
case "yml":
|
||||||
|
case "yaml":
|
||||||
|
return plugins.yaml.safeLoad(fileStringArg);
|
||||||
|
case "json":
|
||||||
|
return JSON.parse(fileStringArg);
|
||||||
|
default:
|
||||||
|
plugins.beautylog.error("file type " + fileTypeArg.blue + " not supported");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFFeEIsTUFBTyxPQUFPLFdBQVcscUJBQXFCLENBQUMsQ0FBQztBQUVyQyxnQkFBUSxHQUFHLENBQUMsT0FBYztJQUNqQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUM1QyxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLHdCQUF3QjtJQUMzRSxNQUFNLENBQUMsUUFBUSxDQUFDO0FBQ3BCLENBQUMsQ0FBQztBQUVTLGtCQUFVLEdBQUcsQ0FBQyxhQUFvQixFQUFFLFdBQVc7SUFDdEQsTUFBTSxDQUFDLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQztRQUNsQixLQUFLLEtBQUssQ0FBRTtRQUNaLEtBQUssTUFBTTtZQUNQLE1BQU0sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNoRCxLQUFLLE1BQU07WUFDUCxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNyQztZQUNJLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUM7WUFDNUUsS0FBSyxDQUFDO0lBQ2QsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9
|
51
dist/smartfile.memory.d.ts
vendored
Normal file
51
dist/smartfile.memory.d.ts
vendored
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
/// <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;
|
||||||
|
/**
|
||||||
|
* converts file to Object
|
||||||
|
* @param fileStringArg
|
||||||
|
* @param fileTypeArg
|
||||||
|
* @returns {any|any}
|
||||||
|
*/
|
||||||
|
export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
|
||||||
|
/**
|
||||||
|
* takes a string and converts it to vinyl file
|
||||||
|
* @param fileArg
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
|
||||||
|
filename?: string;
|
||||||
|
base?: string;
|
||||||
|
relPath?: string;
|
||||||
|
}) => 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) => string;
|
||||||
|
/**
|
||||||
|
* writes string or vinyl file 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;
|
124
dist/smartfile.memory.js
vendored
Normal file
124
dist/smartfile.memory.js
vendored
Normal file
File diff suppressed because one or more lines are too long
16
dist/smartfile.plugins.d.ts
vendored
Normal file
16
dist/smartfile.plugins.d.ts
vendored
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
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 import glob = require("glob");
|
||||||
|
export declare let g: {
|
||||||
|
remoteSrc: any;
|
||||||
|
};
|
||||||
|
export import path = require("path");
|
||||||
|
export import Q = require("q");
|
||||||
|
export import vinyl = require("vinyl");
|
||||||
|
export declare let vinylFile: any;
|
||||||
|
export declare let yaml: any;
|
||||||
|
export declare let request: any;
|
||||||
|
export declare let requireReload: any;
|
18
dist/smartfile.plugins.js
vendored
Normal file
18
dist/smartfile.plugins.js
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
exports.beautylog = require("beautylog");
|
||||||
|
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.vinylFile = require("vinyl-file");
|
||||||
|
exports.yaml = require("js-yaml");
|
||||||
|
exports.request = require("request");
|
||||||
|
exports.requireReload = require("require-reload");
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ1YsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNqQyxVQUFFLFdBQVcsSUFBSSxDQUFDLENBQUM7QUFDbkIsZUFBTyxXQUFXLFVBQVUsQ0FBQyxDQUFDO0FBQ2pDLFlBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDcEIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQzFCLFNBQUMsR0FBRztJQUNYLFNBQVMsRUFBRSxPQUFPLENBQUMsaUJBQWlCLENBQUM7Q0FDeEMsQ0FBQztBQUNZLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixTQUFDLFdBQVcsR0FBRyxDQUFDLENBQUM7QUFDakIsYUFBSyxXQUFXLE9BQU8sQ0FBQyxDQUFDO0FBQzVCLGlCQUFTLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ2xDLFlBQUksR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDMUIsZUFBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUM3QixxQkFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDIn0=
|
22
dist/smartfile.remote.d.ts
vendored
Normal file
22
dist/smartfile.remote.d.ts
vendored
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
/// <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<{}>;
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
export declare let toString: (fromArg: string) => plugins.Q.Promise<{}>;
|
66
dist/smartfile.remote.js
vendored
Normal file
66
dist/smartfile.remote.js
vendored
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
const plugins = require("./smartfile.plugins");
|
||||||
|
const SmartfileInterpreter = require("./smartfile.interpreter");
|
||||||
|
exports.toFs = function (from, toPath) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var stream = plugins.request(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;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
exports.toObject = function (fromArg) {
|
||||||
|
let done = plugins.Q.defer();
|
||||||
|
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||||
|
let returnObject;
|
||||||
|
if (!error && response.statusCode == 200) {
|
||||||
|
returnObject = SmartfileInterpreter.objectFile(bodyString, SmartfileInterpreter.filetype(fromArg));
|
||||||
|
done.resolve(returnObject);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
console.log('could not get remote file from ' + fromArg);
|
||||||
|
returnObject = undefined;
|
||||||
|
done.reject(returnObject);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param fromArg
|
||||||
|
* @returns {any}
|
||||||
|
*/
|
||||||
|
exports.toString = (fromArg) => {
|
||||||
|
let done = plugins.Q.defer();
|
||||||
|
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||||
|
if (!error && response.statusCode == 200) {
|
||||||
|
done.resolve(bodyString);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.error('could not get remote file from ' + fromArg);
|
||||||
|
bodyString = undefined;
|
||||||
|
done.reject(bodyString);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFPLE9BQU8sV0FBVyxxQkFBcUIsQ0FBQyxDQUFDO0FBQ2hELE1BQU8sb0JBQW9CLFdBQVcseUJBQXlCLENBQUMsQ0FBQztBQUV0RCxZQUFJLEdBQUcsVUFBUyxJQUFXLEVBQUMsTUFBYTtJQUNoRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLElBQUksTUFBTSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsaUJBQWlCLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNuRixNQUFNLENBQUMsRUFBRSxDQUFDLFFBQVEsRUFBQztRQUNmLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDekIsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFRjs7OztHQUlHO0FBQ1Esd0JBQWdCLEdBQUcsVUFBUyxXQUFrQixFQUFDLE9BQWM7SUFDcEUsSUFBSSxNQUFNLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsV0FBVyxFQUFFO1FBQzFDLElBQUksRUFBRSxPQUFPO0tBQ2hCLENBQUMsQ0FBQztJQUNILE1BQU0sQ0FBQyxNQUFNLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLGdCQUFRLEdBQUcsVUFBUyxPQUFjO0lBQ3pDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFVBQVUsS0FBSyxFQUFFLFFBQVEsRUFBRSxVQUFVO1FBQzlELElBQUksWUFBWSxDQUFDO1FBQ2pCLEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLFFBQVEsQ0FBQyxVQUFVLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQztZQUN2QyxZQUFZLEdBQUcsb0JBQW9CLENBQUMsVUFBVSxDQUFDLFVBQVUsRUFBQyxvQkFBb0IsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztZQUNsRyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQy9CLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUM7WUFDekQsWUFBWSxHQUFHLFNBQVMsQ0FBQztZQUN6QixJQUFJLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQzlCLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFRjs7OztHQUlHO0FBQ1EsZ0JBQVEsR0FBRyxDQUFDLE9BQWM7SUFDakMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixPQUFPLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsVUFBVSxLQUFLLEVBQUUsUUFBUSxFQUFFLFVBQVU7UUFDOUQsRUFBRSxDQUFDLENBQUMsQ0FBQyxLQUFLLElBQUksUUFBUSxDQUFDLFVBQVUsSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ3ZDLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDN0IsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUM7WUFDckUsVUFBVSxHQUFHLFNBQVMsQ0FBQztZQUN2QixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQzVCLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUMifQ==
|
@ -1,22 +1,9 @@
|
|||||||
{
|
{
|
||||||
"npmts": {
|
"npmts":{
|
||||||
"mode": "default",
|
"mode":"default",
|
||||||
"coverageTreshold": 70
|
"coverageTreshold":70
|
||||||
},
|
},
|
||||||
"npmdocker": {},
|
"npmdocker":{
|
||||||
"npmci": {
|
|
||||||
"npmGlobalTools": [],
|
|
||||||
"npmAccessLevel": "public"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"projectType": "npm",
|
|
||||||
"module": {
|
|
||||||
"githost": "gitlab.com",
|
|
||||||
"gitscope": "pushrocks",
|
|
||||||
"gitrepo": "smartfile",
|
|
||||||
"shortDescription": "smart ways to work with files in nodejs",
|
|
||||||
"npmPackagename": "@pushrocks/smartfile",
|
|
||||||
"license": "MIT"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
10446
package-lock.json
generated
10446
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
72
package.json
72
package.json
@ -1,13 +1,15 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartfile",
|
"name": "smartfile",
|
||||||
"private": false,
|
"version": "4.0.14",
|
||||||
"version": "8.0.2",
|
|
||||||
"description": "offers smart ways to work with files in nodejs",
|
"description": "offers smart ways to work with files in nodejs",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(npmts)",
|
||||||
"build": "(tsbuild --web)"
|
"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)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -17,48 +19,32 @@
|
|||||||
"filesystem",
|
"filesystem",
|
||||||
"json"
|
"json"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH <hello@lossless.com> (https://lossless.com)",
|
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/smartfile/issues"
|
"url": "https://gitlab.com/pushrocks/smartfile/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartfile",
|
"homepage": "https://gitlab.com/pushrocks/smartfile",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smarthash": "^2.1.6",
|
"@types/fs-extra": "0.x.x",
|
||||||
"@pushrocks/smartmime": "^1.0.3",
|
"@types/q": "0.x.x",
|
||||||
"@pushrocks/smartpath": "^4.0.3",
|
"beautylog": "^5.0.22",
|
||||||
"@pushrocks/smartpromise": "^3.0.6",
|
"fs-extra": "^0.30.0",
|
||||||
"@pushrocks/smartrequest": "^1.1.51",
|
"glob": "^7.0.6",
|
||||||
"@types/fs-extra": "^9.0.1",
|
"gulp": "^3.9.1",
|
||||||
"@types/glob": "^7.1.3",
|
"gulp-remote-src": "^0.4.1",
|
||||||
"@types/js-yaml": "^3.12.5",
|
"js-yaml": "^3.6.1",
|
||||||
"fs-extra": "^9.0.1",
|
"q": "^1.4.1",
|
||||||
"glob": "^7.1.6",
|
"request": "^2.74.0",
|
||||||
"js-yaml": "^3.14.0"
|
"require-reload": "0.2.2",
|
||||||
|
"typings-global": "^1.0.14",
|
||||||
|
"vinyl": "^1.2.0",
|
||||||
|
"vinyl-file": "^2.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.25",
|
"gulp-function": "^1.3.6",
|
||||||
"@gitzone/tsrun": "^1.2.12",
|
"npmts-g": "^5.2.8",
|
||||||
"@gitzone/tstest": "^1.0.52",
|
"should": "^11.1.0",
|
||||||
"@pushrocks/tapbundle": "^3.2.9",
|
"typings-test": "^1.0.2"
|
||||||
"@types/node": "^14.11.2",
|
}
|
||||||
"gulp-function": "^2.2.14",
|
|
||||||
"tslint": "^6.1.3",
|
|
||||||
"tslint-config-prettier": "^1.18.0"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"ts/**/*",
|
|
||||||
"ts_web/**/*",
|
|
||||||
"dist/**/*",
|
|
||||||
"dist_*/**/*",
|
|
||||||
"dist_ts/**/*",
|
|
||||||
"dist_ts_web/**/*",
|
|
||||||
"assets/**/*",
|
|
||||||
"cli.js",
|
|
||||||
"npmextra.json",
|
|
||||||
"readme.md"
|
|
||||||
],
|
|
||||||
"browserslist": [
|
|
||||||
"last 1 chrome versions"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
51
readme.md
51
readme.md
@ -1,51 +0,0 @@
|
|||||||
# @pushrocks/smartfile
|
|
||||||
smart ways to work with files in nodejs
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfile)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfile)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartfile)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartfile/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
|
|
||||||
Status Category | Status Badge
|
|
||||||
-- | --
|
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
||||||
npm | [](https://lossless.cloud)
|
|
||||||
Snyk | [](https://lossless.cloud)
|
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
1
test/test.d.ts
vendored
Normal file
1
test/test.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
import "typings-test";
|
207
test/test.js
Normal file
207
test/test.js
Normal file
File diff suppressed because one or more lines are too long
1
test/test.js.map
Normal file
1
test/test.js.map
Normal file
File diff suppressed because one or more lines are too long
423
test/test.ts
423
test/test.ts
@ -1,229 +1,226 @@
|
|||||||
import * as smartfile from '../ts/index';
|
import "typings-test";
|
||||||
import path = require('path');
|
import * as smartfile from "../dist/index";
|
||||||
|
import beautylog = require("beautylog");
|
||||||
|
let gulp = require("gulp");
|
||||||
|
let gFunction = require("gulp-function");
|
||||||
|
import path = require("path");
|
||||||
|
import should = require("should");
|
||||||
|
let vinyl = require("vinyl");
|
||||||
|
|
||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
describe("smartfile".yellow,function(){
|
||||||
|
describe(".fs".yellow,function(){
|
||||||
|
describe(".fileExistsSync".yellow,function(){
|
||||||
|
it("should return an accurate boolean",function(){
|
||||||
|
(smartfile.fs.fileExistsSync("./test/mytest.json")).should.be.true();
|
||||||
|
(smartfile.fs.fileExistsSync("./test/notthere.json")).should.be.false();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".fileExists".yellow,function(){
|
||||||
|
it("should return a working promise",function(){
|
||||||
|
(smartfile.fs.fileExists("./test/mytest.json")).should.be.Promise();
|
||||||
|
(smartfile.fs.fileExists("./test/mytest.json")).should.be.fulfilled();
|
||||||
|
(smartfile.fs.fileExists("./test/notthere.json")).should.not.be.fulfilled();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".listFoldersSync()",function(){
|
||||||
|
it("should get the file type from a string",function(){
|
||||||
|
smartfile.fs.listFoldersSync("./test/").should.containDeep([ "testfolder"]);
|
||||||
|
smartfile.fs.listFoldersSync("./test/").should.not.containDeep([ "notExistentFolder"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".listFolders()",function(){
|
||||||
|
it("should get the file type from a string",function(done){
|
||||||
|
smartfile.fs.listFolders("./test/")
|
||||||
|
.then(function(folderArrayArg){
|
||||||
|
folderArrayArg.should.containDeep([ "testfolder"]);
|
||||||
|
folderArrayArg.should.not.containDeep([ "notExistentFolder"]);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".listFilesSync()",function(){
|
||||||
|
it("should get the file type from a string",function(){
|
||||||
|
smartfile.fs.listFilesSync("./test/").should.containDeep([ "mytest.json"]);
|
||||||
|
smartfile.fs.listFilesSync("./test/").should.not.containDeep([ "notExistentFile"]);
|
||||||
|
smartfile.fs.listFilesSync("./test/",/mytest\.json/).should.containDeep([ "mytest.json"]);
|
||||||
|
smartfile.fs.listFilesSync("./test/",/mytests.json/).should.not.containDeep([ "mytest.json"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".listFiles()",function(){
|
||||||
|
it("should get the file type from a string",function(done){
|
||||||
|
smartfile.fs.listFiles("./test/")
|
||||||
|
.then(function(folderArrayArg){
|
||||||
|
folderArrayArg.should.containDeep([ "mytest.json"]);
|
||||||
|
folderArrayArg.should.not.containDeep([ "notExistentFile"]);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".listFileTree()",function(){
|
||||||
|
it("should get a file tree",function(done){
|
||||||
|
smartfile.fs.listFileTree(path.resolve("./test/"),"**/*.txt")
|
||||||
|
.then(function(folderArrayArg){
|
||||||
|
folderArrayArg.should.containDeep([ "testfolder/testfile1.txt"]);
|
||||||
|
folderArrayArg.should.not.containDeep([ "mytest.json"]);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".copy()".yellow,function(){
|
||||||
|
it("should copy a directory",function(){
|
||||||
|
smartfile.fs.copy("./test/testfolder/","./test/temp/")
|
||||||
|
});
|
||||||
|
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(){
|
||||||
|
|
||||||
// ---------------------------
|
});
|
||||||
// smartfile.fs
|
it("should remove single files",function(){
|
||||||
// ---------------------------
|
|
||||||
|
|
||||||
tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
|
});
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/mytest.json')).to.be.true;
|
});
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/notthere.json')).be.false;
|
});
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.fileExists -> should resolve or reject a promise', async () => {
|
describe(".interpreter",function(){
|
||||||
expect(smartfile.fs.fileExists('./test/testassets/mytest.json')).to.be.instanceof(Promise);
|
describe(".filetype()",function(){
|
||||||
await smartfile.fs.fileExists('./test/testassets/mytest.json');
|
it("should get the file type from a string",function(){
|
||||||
await smartfile.fs.fileExists('./test/testassets/notthere.json').catch((err) => {
|
smartfile.interpreter.filetype("./somefolder/data.json").should.equal("json");
|
||||||
return expect(err.message).to.equal(
|
});
|
||||||
"ENOENT: no such file or directory, access './test/testassets/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");
|
||||||
|
testData.should.have.property("key1","this works");
|
||||||
|
testData.should.have.property("key2","this works too");
|
||||||
|
|
||||||
|
});
|
||||||
|
it("should state unknown file type for unknown file types",function(){
|
||||||
|
let testData = smartfile.fs.toObjectSync("./test/mytest.txt");
|
||||||
|
});
|
||||||
|
it("should read an " + ".json".blue + " file to an object",function(){
|
||||||
|
let testData = smartfile.fs.toObjectSync("./test/mytest.json");
|
||||||
|
testData.should.have.property("key1","this works");
|
||||||
|
testData.should.have.property("key2","this works too");
|
||||||
|
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".toStringSync()".yellow,function(){
|
||||||
|
it("should read a file to a string",function(){
|
||||||
|
should.equal(
|
||||||
|
smartfile.fs.toStringSync("./test/mytest.txt"),
|
||||||
|
"Some TestString &&%$"
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.listFoldersSync() -> should get the file type from a string', async () => {
|
|
||||||
expect(smartfile.fs.listFoldersSync('./test/testassets/')).to.include('testfolder');
|
|
||||||
expect(smartfile.fs.listFoldersSync('./test/testassets/')).to.not.include('notExistentFolder');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.listFolders() -> should get the file type from a string', async () => {
|
|
||||||
const folderArrayArg = await smartfile.fs.listFolders('./test/testassets/');
|
|
||||||
expect(folderArrayArg).to.include('testfolder');
|
|
||||||
expect(folderArrayArg).to.not.include('notExistentFolder');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.listFilesSync() -> should get the file type from a string', async () => {
|
|
||||||
expect(smartfile.fs.listFilesSync('./test/testassets/')).to.include('mytest.json');
|
|
||||||
expect(smartfile.fs.listFilesSync('./test/testassets/')).to.not.include('notExistentFile');
|
|
||||||
expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).to.include(
|
|
||||||
'mytest.json'
|
|
||||||
);
|
|
||||||
expect(smartfile.fs.listFilesSync('./test/testassets/', /mytests.json/)).to.not.include(
|
|
||||||
'mytest.json'
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.listFiles() -> should get the file type from a string', async () => {
|
|
||||||
const folderArrayArg = await smartfile.fs.listFiles('./test/testassets/');
|
|
||||||
expect(folderArrayArg).to.include('mytest.json');
|
|
||||||
expect(folderArrayArg).to.not.include('notExistentFile');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.listFileTree() -> should get a file tree', async () => {
|
|
||||||
const folderArrayArg = await smartfile.fs.listFileTree(
|
|
||||||
path.resolve('./test/testassets/'),
|
|
||||||
'**/*.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 () => {
|
|
||||||
const fileArrayArg = await smartfile.fs.fileTreeToObject(
|
|
||||||
path.resolve('./test/testassets/'),
|
|
||||||
'**/*.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 () => {
|
|
||||||
await smartfile.fs.copy('./test/testassets/testfolder/', './test/testassets/temp/');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.copy() -> should copy a file', async () => {
|
|
||||||
await smartfile.fs.copy('./test/testassets/mytest.yaml', './test/testassets/temp/mytest.yaml');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.copy() -> should copy a file and rename it', async () => {
|
|
||||||
await smartfile.fs.copy(
|
|
||||||
'./test/testassets/mytest.yaml',
|
|
||||||
'./test/testassets/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/testassets/temp/mytestRenamed.yaml');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
|
|
||||||
smartfile.fs.removeSync('./test/testassets/temp/testfile1.txt');
|
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.removeMany -> should remove and array of files', async () => {
|
|
||||||
smartfile.fs
|
|
||||||
.removeMany(['./test/testassets/temp/testfile1.txt', './test/testassets/temp/testfile2.txt'])
|
|
||||||
.then(() => {
|
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
|
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).to.be.false;
|
|
||||||
});
|
});
|
||||||
});
|
describe(".toVinylSync".yellow,function(){
|
||||||
|
it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan,function(){
|
||||||
|
let testData = smartfile.fs.toVinylSync("./test/mytest.json");
|
||||||
|
(vinyl.isVinyl(testData)).should.be.true();
|
||||||
|
|
||||||
tap.test('.fs.removeManySync -> should remove and array of single files synchronouly', async () => {
|
});
|
||||||
smartfile.fs.removeManySync([
|
});
|
||||||
'./test/testassets/temp/testfile1.txt',
|
});
|
||||||
'./test/testassets/temp/testfile2.txt',
|
|
||||||
]);
|
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
|
|
||||||
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).to.be.false;
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.fs.toObjectSync() -> should read an ' + '.yaml' + ' file to an object', async () => {
|
describe(".memory",function(){
|
||||||
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.yaml');
|
describe(".toGulpStream()",function(){
|
||||||
expect(testData).to.include({ key1: 'this works' });
|
it("should produce a valid gulp stream",function(){
|
||||||
expect(testData).to.include({ key2: 'this works too' });
|
let localArray = ["test1","test2","test3"];
|
||||||
});
|
smartfile.memory.toGulpStream(localArray)
|
||||||
tap.test(
|
.pipe(gulp.dest("./test/temp/"));
|
||||||
'.fs.toObjectSync() -> should state unknown file type for unknown file types',
|
});
|
||||||
async () => {
|
});
|
||||||
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.txt');
|
describe("toVinylFileSync()",function(){
|
||||||
|
it("should produce a vinylFile",function(){
|
||||||
|
let localString = "myString";
|
||||||
|
let localOptions = {filename:"vinylfile2",base:"/someDir"};
|
||||||
|
(smartfile.memory.toVinylFileSync(localString,localOptions) instanceof vinyl).should.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);
|
||||||
|
testResult.should.be.Array();
|
||||||
|
(testResult.length === 3).should.be.true();
|
||||||
|
for (let myKey in testResult){
|
||||||
|
(testResult[myKey] instanceof vinyl).should.be.true();
|
||||||
}
|
}
|
||||||
);
|
});
|
||||||
|
});
|
||||||
tap.test('.fs.toObjectSync() -> should read an ' + '.json' + ' file to an object', async () => {
|
describe("toStringSync()",function(){
|
||||||
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.json');
|
it("should produce a String from vinyl file",function(){
|
||||||
expect(testData).to.include({ key1: 'this works' });
|
let localString = smartfile.memory.toStringSync(new vinyl({
|
||||||
expect(testData).to.include({ key2: 'this works too' });
|
base:"/",
|
||||||
});
|
path:"/test.txt",
|
||||||
|
contents: new Buffer("myString")
|
||||||
tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
|
}));
|
||||||
expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).to.equal(
|
localString.should.equal("myString");
|
||||||
'Some TestString &&%$'
|
});
|
||||||
);
|
});
|
||||||
});
|
describe("toFs()",function(){
|
||||||
|
it("should write a file to disk and return a promise",function(done){
|
||||||
// ---------------------------
|
let localString = "myString";
|
||||||
// smartfile.interpreter
|
smartfile.memory.toFs(
|
||||||
// ---------------------------
|
|
||||||
|
|
||||||
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 () => {
|
|
||||||
const localString = 'myString';
|
|
||||||
await smartfile.memory.toFs(
|
|
||||||
localString,
|
localString,
|
||||||
path.join(process.cwd(), './test/testassets/temp/testMemToFs.txt')
|
path.join(process.cwd(),"./test/temp/testMemToFs.txt")
|
||||||
);
|
).then(done);
|
||||||
});
|
});
|
||||||
|
});
|
||||||
tap.test(
|
describe("toFsSync()",function(){
|
||||||
'.memory.toFsSync() -> should write a file to disk and return true if successfull',
|
it("should write a file to disk and return true if successfull",function(){
|
||||||
async () => {
|
let localString = "myString";
|
||||||
const localString = 'myString';
|
|
||||||
smartfile.memory.toFsSync(
|
smartfile.memory.toFsSync(
|
||||||
localString,
|
localString,
|
||||||
path.join(process.cwd(), './test/testassets/temp/testMemToFsSync.txt')
|
path.join(process.cwd(),"./test/temp/testMemToFsSync.txt")
|
||||||
);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
tap.test('.remote.toString() -> should load a remote file to a variable', async () => {
|
|
||||||
const responseString = await smartfile.remote.toString(
|
|
||||||
'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/testassets/mytest.txt'
|
|
||||||
);
|
|
||||||
expect(responseString).to.equal('Some TestString &&%$');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('.remote.toString() -> should reject a Promise when the link is false', async (tools) => {
|
|
||||||
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'
|
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe(".remote",function(){
|
||||||
|
describe("toGulpStreamSync()",function(){
|
||||||
|
it("should produce a gulp stream",function(done){
|
||||||
|
smartfile.remote.toGulpStreamSync("mytest.txt","https://raw.githubusercontent.com/pushrocks/smartfile/master/test/")
|
||||||
|
.pipe(smartfile.fs.toGulpDestSync("./test/temp/"))
|
||||||
|
.pipe(gFunction(done,"atEnd"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe(".toString()",function(){
|
||||||
|
it("should load a remote file to a variable",function(done){
|
||||||
|
this.timeout(5000);
|
||||||
|
smartfile.remote.toString("https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt")
|
||||||
|
.then(function(responseString){
|
||||||
|
should.equal(responseString,"Some TestString &&%$");
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
it("should reject a Promise when the link is false",function(done){
|
||||||
|
this.timeout(10000);
|
||||||
|
smartfile.remote.toString("https://push.rocks/doesnotexist.txt")
|
||||||
|
.then(function(){
|
||||||
|
throw new Error("this test should not be resolved");
|
||||||
|
},function(){
|
||||||
|
done();
|
||||||
|
})
|
||||||
|
});
|
||||||
|
});
|
||||||
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
// ---------------------------
|
|
||||||
// smartfile.Smartfile
|
|
||||||
// ---------------------------
|
|
||||||
|
|
||||||
tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
|
|
||||||
const smartfileArray = await smartfile.fs.fileTreeToObject(
|
|
||||||
process.cwd(),
|
|
||||||
'./test/testassets/testfolder/**/*'
|
|
||||||
);
|
|
||||||
const 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 () => {
|
|
||||||
const smartfileArray = await smartfile.fs.fileTreeToObject('./test/testassets/testfolder/', '*');
|
|
||||||
for (const smartfileInstance of smartfileArray) {
|
|
||||||
console.log(smartfileInstance.relative);
|
|
||||||
console.log(smartfileInstance.path);
|
|
||||||
console.log(smartfileInstance.base);
|
|
||||||
console.log(smartfileInstance.parsedPath);
|
|
||||||
}
|
|
||||||
await smartfile.memory.smartfileArrayToFs(
|
|
||||||
smartfileArray,
|
|
||||||
path.resolve('./test/testassets/temp/testoutput/')
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should create, store and retrieve valid smartfiles', async () => {
|
|
||||||
const fileString = 'hi there';
|
|
||||||
const filePath = './test/testassets/utf8.txt';
|
|
||||||
const smartfileInstance = await smartfile.Smartfile.fromString(filePath, fileString, 'utf8');
|
|
||||||
smartfileInstance.write();
|
|
||||||
const smartfileInstance2 = await smartfile.Smartfile.fromFilePath(filePath);
|
|
||||||
const retrievedString = smartfileInstance.contents.toString();
|
|
||||||
expect(retrievedString).to.equal(fileString);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
key1: this works
|
|
||||||
key2: this works too
|
|
||||||
key3:
|
|
||||||
nestedkey1: hello
|
|
@ -1 +0,0 @@
|
|||||||
okidoks
|
|
@ -1 +0,0 @@
|
|||||||
hi
|
|
@ -1 +0,0 @@
|
|||||||
myString
|
|
@ -1 +0,0 @@
|
|||||||
myString
|
|
@ -1 +0,0 @@
|
|||||||
okidoks
|
|
@ -1 +0,0 @@
|
|||||||
hi
|
|
@ -1 +0,0 @@
|
|||||||
hi there
|
|
15
ts/index.ts
15
ts/index.ts
@ -1,12 +1,15 @@
|
|||||||
import * as plugins from './smartfile.plugins';
|
import "typings-global";
|
||||||
import * as SmartfileFs from './smartfile.fs';
|
|
||||||
import * as SmartfileInterpreter from './smartfile.interpreter';
|
|
||||||
import * as SmartfileMemory from './smartfile.memory';
|
|
||||||
import * as SmartfileRemote from './smartfile.remote';
|
|
||||||
|
|
||||||
export { Smartfile } from './smartfile.classes.smartfile';
|
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 let fs = SmartfileFs;
|
export let fs = SmartfileFs;
|
||||||
export let interpreter = SmartfileInterpreter;
|
export let interpreter = SmartfileInterpreter;
|
||||||
export let memory = SmartfileMemory;
|
export let memory = SmartfileMemory;
|
||||||
export let remote = SmartfileRemote;
|
export let remote = SmartfileRemote;
|
||||||
|
export let requireReload = SmartfileFs.requireReload;
|
||||||
|
@ -1,188 +1,5 @@
|
|||||||
import * as plugins from './smartfile.plugins';
|
|
||||||
import * as fs from './smartfile.fs';
|
|
||||||
import * as memory from './smartfile.memory';
|
|
||||||
|
|
||||||
export interface ISmartfileConstructorOptions {
|
|
||||||
path?: string;
|
|
||||||
contentBuffer?: Buffer;
|
|
||||||
base?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* class Smartfile
|
|
||||||
* -> is vinyl file compatible
|
|
||||||
*/
|
|
||||||
export class Smartfile {
|
export class Smartfile {
|
||||||
// ======
|
constructor(){
|
||||||
// STATIC
|
|
||||||
// ======
|
|
||||||
|
|
||||||
/**
|
};
|
||||||
* creates a Smartfile from a filePath
|
|
||||||
* @param filePath
|
|
||||||
*/
|
|
||||||
public static async fromFilePath(filePath: string) {
|
|
||||||
filePath = plugins.path.resolve(filePath);
|
|
||||||
const fileBuffer = fs.toBufferSync(filePath);
|
|
||||||
const smartfile = new Smartfile({
|
|
||||||
path: filePath,
|
|
||||||
contentBuffer: fileBuffer,
|
|
||||||
});
|
|
||||||
return smartfile;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static async fromBuffer(filePath: string, contentBufferArg: Buffer) {
|
|
||||||
const smartfile = new Smartfile({
|
|
||||||
contentBuffer: contentBufferArg,
|
|
||||||
path: filePath,
|
|
||||||
});
|
|
||||||
|
|
||||||
return smartfile;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static async fromString(
|
|
||||||
filePath: string,
|
|
||||||
contentStringArg: string,
|
|
||||||
encodingArg: 'utf8' | 'binary'
|
|
||||||
) {
|
|
||||||
const smartfile = new Smartfile({
|
|
||||||
contentBuffer: Buffer.from(contentStringArg, encodingArg),
|
|
||||||
path: filePath,
|
|
||||||
});
|
|
||||||
|
|
||||||
return smartfile;
|
|
||||||
}
|
|
||||||
|
|
||||||
// ========
|
|
||||||
// INSTANCE
|
|
||||||
// ========
|
|
||||||
/**
|
|
||||||
* the full path of the file on disk
|
|
||||||
*/
|
|
||||||
public path: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
public parsedPath: plugins.path.ParsedPath;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* the content of the file as Buffer
|
|
||||||
*/
|
|
||||||
public contentBuffer: Buffer;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The current working directory of the file
|
|
||||||
* Note:this is similar to gulp and different from native node path base
|
|
||||||
*/
|
|
||||||
public base: string;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* sync the file with disk
|
|
||||||
*/
|
|
||||||
public sync: boolean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* the constructor of Smartfile
|
|
||||||
* @param optionsArg
|
|
||||||
*/
|
|
||||||
|
|
||||||
constructor(optionsArg: ISmartfileConstructorOptions) {
|
|
||||||
if (optionsArg.contentBuffer) {
|
|
||||||
this.contentBuffer = optionsArg.contentBuffer;
|
|
||||||
} 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
|
|
||||||
*/
|
|
||||||
public setContentsFromString(contentString: string, encodingArg: 'utf8' | 'binary' = 'utf8') {
|
|
||||||
this.contents = new Buffer(contentString, encodingArg);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* write file to disk
|
|
||||||
* Behaviours:
|
|
||||||
* - no argument write to exactly where the file was picked up
|
|
||||||
*/
|
|
||||||
public async write(pathArg?: string) {
|
|
||||||
const stringToWrite = this.contentBuffer.toString();
|
|
||||||
await memory.toFs(stringToWrite, this.path);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* read file from disk
|
|
||||||
*/
|
|
||||||
public async read() {}
|
|
||||||
|
|
||||||
// -----------------------------------------------
|
|
||||||
// vinyl compatibility
|
|
||||||
// -----------------------------------------------
|
|
||||||
/**
|
|
||||||
* vinyl-compatibility: alias of this.contentBuffer
|
|
||||||
*/
|
|
||||||
get contents(): Buffer {
|
|
||||||
return this.contentBuffer;
|
|
||||||
}
|
|
||||||
set contents(contentsArg) {
|
|
||||||
this.contentBuffer = contentsArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* vinyl-compatibility
|
|
||||||
*/
|
|
||||||
public get cwd() {
|
|
||||||
return process.cwd();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return relative path of file
|
|
||||||
*/
|
|
||||||
public get relative(): string {
|
|
||||||
return plugins.path.relative(this.base, this.path);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return truw when the file has content
|
|
||||||
*/
|
|
||||||
public isNull(): boolean {
|
|
||||||
if (!this.contentBuffer) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* return true if contents are Buffer
|
|
||||||
*/
|
|
||||||
public isBuffer(): boolean {
|
|
||||||
if (this.contents instanceof Buffer) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
public isDirectory() {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
public isStream() {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
public isSymbolic() {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// update things
|
|
||||||
public updateFileName(fileNameArg: string) {
|
|
||||||
const oldFileName = this.parsedPath.base;
|
|
||||||
this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
|
|
||||||
}
|
|
||||||
}
|
}
|
@ -1,31 +0,0 @@
|
|||||||
import { Smartfile } from './smartfile.classes.smartfile';
|
|
||||||
import * as plugins from './smartfile.plugins';
|
|
||||||
import * as fs from './smartfile.fs';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* a virtual directory exposes a fs api
|
|
||||||
*/
|
|
||||||
export class VirtualDirectory {
|
|
||||||
private fileArray: Smartfile[] = [];
|
|
||||||
public static async fromFsDirPath(pathArg: string) {
|
|
||||||
const newVirtualDir = new VirtualDirectory();
|
|
||||||
newVirtualDir.addSmartfiles(await fs.fileTreeToObject(pathArg, '**/*'));
|
|
||||||
}
|
|
||||||
|
|
||||||
constructor() {}
|
|
||||||
|
|
||||||
public addSmartfiles(smartfileArrayArg: Smartfile[]) {
|
|
||||||
this.fileArray = this.fileArray.concat(smartfileArrayArg);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async getFileByPath(pathArg: string) {
|
|
||||||
for (const smartfile of this.fileArray) {
|
|
||||||
if (smartfile.path === pathArg) {
|
|
||||||
return smartfile;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO implement root shifting to get subdirectories as new virtual directories
|
|
||||||
// TODO implement root shifting to combine VirtualDirecotries in a parent virtual directory
|
|
||||||
}
|
|
@ -1,9 +1,8 @@
|
|||||||
import plugins = require('./smartfile.plugins');
|
import "typings-global";
|
||||||
import SmartfileInterpreter = require('./smartfile.interpreter');
|
|
||||||
|
|
||||||
import { Smartfile } from './smartfile.classes.smartfile';
|
import plugins = require("./smartfile.plugins");
|
||||||
|
import SmartfileInterpreter = require("./smartfile.interpreter");
|
||||||
|
|
||||||
import * as memory from './smartfile.memory';
|
|
||||||
/*===============================================================
|
/*===============================================================
|
||||||
============================ Checks =============================
|
============================ Checks =============================
|
||||||
===============================================================*/
|
===============================================================*/
|
||||||
@ -13,12 +12,13 @@ import * as memory from './smartfile.memory';
|
|||||||
* @param filePath
|
* @param filePath
|
||||||
* @returns {boolean}
|
* @returns {boolean}
|
||||||
*/
|
*/
|
||||||
export const fileExistsSync = (filePath): boolean => {
|
export let fileExistsSync = function(filePath):boolean {
|
||||||
let fileExistsBool: boolean = false;
|
let fileExistsBool:boolean = false;
|
||||||
try {
|
try {
|
||||||
plugins.fsExtra.readFileSync(filePath);
|
plugins.fsExtra.readFileSync(filePath);
|
||||||
fileExistsBool = true;
|
fileExistsBool = true
|
||||||
} catch (err) {
|
}
|
||||||
|
catch(err){
|
||||||
fileExistsBool = false;
|
fileExistsBool = false;
|
||||||
}
|
}
|
||||||
return fileExistsBool;
|
return fileExistsBool;
|
||||||
@ -29,10 +29,10 @@ export const fileExistsSync = (filePath): boolean => {
|
|||||||
* @param filePath
|
* @param filePath
|
||||||
* @returns {any}
|
* @returns {any}
|
||||||
*/
|
*/
|
||||||
export const fileExists = async (filePath): Promise<boolean> => {
|
export let fileExists = function(filePath){
|
||||||
const done = plugins.smartpromise.defer<boolean>();
|
let done = plugins.Q.defer();
|
||||||
plugins.fs.access(filePath, 4, (err) => {
|
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||||
err ? done.resolve(false) : done.resolve(true);
|
err ? done.reject(err) : done.resolve();
|
||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
@ -40,18 +40,14 @@ export const fileExists = async (filePath): Promise<boolean> => {
|
|||||||
/**
|
/**
|
||||||
* Checks if given path points to an existing directory
|
* Checks if given path points to an existing directory
|
||||||
*/
|
*/
|
||||||
export const isDirectory = (pathArg): boolean => {
|
export let isDirectory = function(pathArg):boolean{
|
||||||
try {
|
|
||||||
return plugins.fsExtra.statSync(pathArg).isDirectory();
|
return plugins.fsExtra.statSync(pathArg).isDirectory();
|
||||||
} catch (err) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if a given path points to an existing file
|
* Checks if a given path points to an existing file
|
||||||
*/
|
*/
|
||||||
export const isFile = (pathArg): boolean => {
|
export let isFile = function(pathArg):boolean{
|
||||||
return plugins.fsExtra.statSync(pathArg).isFile();
|
return plugins.fsExtra.statSync(pathArg).isFile();
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -59,16 +55,29 @@ export const isFile = (pathArg): boolean => {
|
|||||||
============================ FS ACTIONS =========================
|
============================ 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
|
* copies a file from A to B on the local disk
|
||||||
*/
|
*/
|
||||||
export const copy = async (fromArg: string, toArg: string): Promise<boolean> => {
|
export let copy = function(fromArg:string, toArg:string){
|
||||||
const done = plugins.smartpromise.defer<boolean>();
|
var done = plugins.Q.defer();
|
||||||
plugins.fsExtra.copy(fromArg, toArg, {}, (err) => {
|
plugins.fsExtra.copy(fromArg,toArg,{},function(){
|
||||||
if (err) {
|
done.resolve();
|
||||||
throw new Error(`Could not copy from ${fromArg} to ${toArg}: ${err}`);
|
|
||||||
}
|
|
||||||
done.resolve(true);
|
|
||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
@ -76,293 +85,204 @@ export const copy = async (fromArg: string, toArg: string): Promise<boolean> =>
|
|||||||
/**
|
/**
|
||||||
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
* copies a file SYNCHRONOUSLY from A to B on the local disk
|
||||||
*/
|
*/
|
||||||
export const copySync = (fromArg: string, toArg: string): boolean => {
|
export let copySync = function(fromArg:string,toArg:string):boolean{
|
||||||
plugins.fsExtra.copySync(fromArg, toArg);
|
plugins.fsExtra.copySync(fromArg,toArg);
|
||||||
return true;
|
return true;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ensures that a directory is in place
|
|
||||||
*/
|
|
||||||
export const ensureDir = async (dirPathArg: string) => {
|
|
||||||
await plugins.fsExtra.ensureDir(dirPathArg);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ensures that a directory is in place
|
|
||||||
*/
|
|
||||||
export const ensureDirSync = (dirPathArg: string) => {
|
|
||||||
plugins.fsExtra.ensureDirSync(dirPathArg);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ensure an empty directory
|
|
||||||
* @executes ASYNC
|
|
||||||
*/
|
|
||||||
export const ensureEmptyDir = async (dirPathArg: string) => {
|
|
||||||
await plugins.fsExtra.ensureDir(dirPathArg);
|
|
||||||
await plugins.fsExtra.emptyDir(dirPathArg);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ensure an empty directory
|
|
||||||
* @executes SYNC
|
|
||||||
*/
|
|
||||||
export const 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 const ensureFile = async (filePathArg, initFileStringArg): Promise<void> => {
|
|
||||||
ensureFileSync(filePathArg, initFileStringArg);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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 const ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
|
|
||||||
if (fileExistsSync(filePathArg)) {
|
|
||||||
return null;
|
|
||||||
} else {
|
|
||||||
memory.toFsSync(initFileStringArg, filePathArg);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* removes a file or folder from local disk
|
* removes a file or folder from local disk
|
||||||
*/
|
*/
|
||||||
export const remove = async (pathArg: string): Promise<void> => {
|
export let remove = function(pathArg:string){
|
||||||
await plugins.fsExtra.remove(pathArg);
|
var done = plugins.Q.defer();
|
||||||
|
plugins.fsExtra.remove(pathArg,function(){
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* removes a file SYNCHRONOUSLY from local disk
|
* removes a file SYNCHRONOUSLY from local disk
|
||||||
*/
|
*/
|
||||||
export const removeSync = (pathArg: string): void => {
|
export let removeSync = function(pathArg:string):boolean{
|
||||||
plugins.fsExtra.removeSync(pathArg);
|
plugins.fsExtra.removeSync(pathArg);
|
||||||
|
return true;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* removes an array of filePaths from disk
|
|
||||||
*/
|
|
||||||
export const removeMany = async (filePathArrayArg: string[]) => {
|
|
||||||
const promiseArray: Array<Promise<void>> = [];
|
|
||||||
for (const filePath of filePathArrayArg) {
|
|
||||||
promiseArray.push(remove(filePath));
|
|
||||||
}
|
|
||||||
await Promise.all(promiseArray);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* like removeFilePathArray but SYNCHRONOUSLY
|
|
||||||
*/
|
|
||||||
export const removeManySync = (filePathArrayArg: string[]): void => {
|
|
||||||
for (const filePath of filePathArrayArg) {
|
|
||||||
removeSync(filePath);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/*===============================================================
|
/*===============================================================
|
||||||
============================ Write/Read =========================
|
============================ Write/Read =========================
|
||||||
===============================================================*/
|
===============================================================*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @returns {*}
|
||||||
|
*/
|
||||||
|
export let toGulpStreamSync = function(filePathArg:string){
|
||||||
|
let stream = plugins.gulp.src(filePathArg);
|
||||||
|
return stream;
|
||||||
|
};
|
||||||
|
|
||||||
|
export let toGulpDestSync = function(folderPathArg:string){
|
||||||
|
return plugins.gulp.dest(folderPathArg);
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param filePathArg
|
* @param filePathArg
|
||||||
* @param fileTypeArg
|
* @param fileTypeArg
|
||||||
* @returns {any}
|
* @returns {any}
|
||||||
*/
|
*/
|
||||||
export const toObjectSync = (filePathArg, fileTypeArg?) => {
|
export let toObjectSync = function(filePathArg,fileTypeArg?) {
|
||||||
const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
|
let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
|
||||||
let fileType;
|
let fileType;
|
||||||
fileTypeArg ? (fileType = fileTypeArg) : (fileType = SmartfileInterpreter.filetype(filePathArg));
|
fileTypeArg ? fileType = fileTypeArg : fileType = SmartfileInterpreter.filetype(filePathArg);
|
||||||
return SmartfileInterpreter.objectFile(fileString, fileType);
|
return SmartfileInterpreter.objectFile(fileString,fileType);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* reads a file content to a String
|
* reads a file content to a String
|
||||||
|
* @param filePath
|
||||||
|
* @returns {string|Buffer|any}
|
||||||
*/
|
*/
|
||||||
export const toStringSync = (filePath: string): string => {
|
export let toStringSync = function(filePath) {
|
||||||
const encoding = plugins.smartmime.getEncoding(filePath);
|
let fileString;
|
||||||
const fileString: string = plugins.fsExtra.readFileSync(filePath, encoding);
|
fileString = plugins.fsExtra.readFileSync(filePath, "utf8");
|
||||||
return fileString;
|
return fileString;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const toBufferSync = (filePath: string): Buffer => {
|
/**
|
||||||
return plugins.fsExtra.readFileSync(filePath);
|
*
|
||||||
};
|
* @param filePathArg
|
||||||
|
* @param options
|
||||||
export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string) => {
|
* @returns {number}
|
||||||
const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
|
*/
|
||||||
let combinedString = '';
|
export let toVinylSync = function(filePathArg,options = {}) {
|
||||||
for (const smartfile of fileTreeObject) {
|
return plugins.vinylFile.readSync(filePathArg,options);
|
||||||
combinedString += smartfile.contentBuffer.toString();
|
|
||||||
}
|
|
||||||
const hash = await plugins.smarthash.sha256FromString(combinedString);
|
|
||||||
return hash;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* creates a smartfile array from a directory
|
* lets you reload files hot.
|
||||||
* @param dirPathArg the directory to start from
|
* @param path
|
||||||
* @param miniMatchFilter a minimatch filter of what files to include
|
* @returns {any}
|
||||||
*/
|
*/
|
||||||
export const fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
|
export let requireReload = function(path:string){
|
||||||
// handle absolute miniMatchFilter
|
return plugins.requireReload(path);
|
||||||
let dirPath: string;
|
|
||||||
if (plugins.path.isAbsolute(miniMatchFilter)) {
|
|
||||||
dirPath = '/';
|
|
||||||
} else {
|
|
||||||
dirPath = dirPathArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
const fileTree = await listFileTree(dirPath, miniMatchFilter);
|
|
||||||
const smartfileArray: Smartfile[] = [];
|
|
||||||
for (const filePath of fileTree) {
|
|
||||||
const readPath = ((): string => {
|
|
||||||
if (!plugins.path.isAbsolute(filePath)) {
|
|
||||||
return plugins.path.join(dirPath, filePath);
|
|
||||||
} else {
|
|
||||||
return filePath;
|
|
||||||
}
|
|
||||||
})();
|
|
||||||
const fileContentString = toStringSync(readPath);
|
|
||||||
|
|
||||||
// push a read file as Smartfile
|
|
||||||
smartfileArray.push(
|
|
||||||
new Smartfile({
|
|
||||||
contentBuffer: Buffer.from(fileContentString),
|
|
||||||
base: dirPath,
|
|
||||||
path: filePath,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return smartfileArray;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists Folders in a directory on local disk
|
* lists Folders in a directory on local disk
|
||||||
* @returns Promise with an array that contains the folder names
|
* @returns Promise
|
||||||
*/
|
*/
|
||||||
export const listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
|
export let listFolders = function(pathArg:string,regexFilter?:RegExp){
|
||||||
return listFoldersSync(pathArg, regexFilter);
|
let done = plugins.Q.defer();
|
||||||
|
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||||
|
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
|
||||||
|
});
|
||||||
|
if(regexFilter){
|
||||||
|
folderArray = folderArray.filter((fileItem) => {
|
||||||
|
return regexFilter.test(fileItem);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
done.resolve(folderArray);
|
||||||
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
* lists Folders SYNCHRONOUSLY in a directory on local disk
|
||||||
* @returns an array with the folder names as strings
|
* @returns an array with the folder names as strings
|
||||||
*/
|
*/
|
||||||
export const listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
|
export let listFoldersSync = function(pathArg:string,regexFilter?:RegExp):string[]{
|
||||||
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
|
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) {
|
if(regexFilter){
|
||||||
folderArray = folderArray.filter((fileItem) => {
|
folderArray = folderArray.filter((fileItem) => {
|
||||||
return regexFilter.test(fileItem);
|
return regexFilter.test(fileItem);
|
||||||
});
|
});
|
||||||
}
|
};
|
||||||
return folderArray;
|
return folderArray;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists Files in a directory on local disk
|
* lists Files in a directory on local disk
|
||||||
* @returns Promise
|
* @returns Promise
|
||||||
*/
|
*/
|
||||||
export const listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
|
export let listFiles = function(pathArg:string, regexFilter?:RegExp){
|
||||||
return listFilesSync(pathArg, regexFilter);
|
let done = plugins.Q.defer();
|
||||||
|
let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||||
|
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||||
|
});
|
||||||
|
if(regexFilter){
|
||||||
|
fileArray = fileArray.filter((fileItem) => {
|
||||||
|
return regexFilter.test(fileItem);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
done.resolve(fileArray);
|
||||||
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists Files SYNCHRONOUSLY in a directory on local disk
|
* lists Files SYNCHRONOUSLY in a directory on local disk
|
||||||
* @returns an array with the folder names as strings
|
* @returns an array with the folder names as strings
|
||||||
*/
|
*/
|
||||||
export const listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
|
export let listFilesSync = function(pathArg:string, regexFilter?:RegExp):string[]{
|
||||||
let fileArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
|
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) {
|
if(regexFilter){
|
||||||
fileArray = fileArray.filter((fileItem) => {
|
fileArray = fileArray.filter((fileItem) => {
|
||||||
return regexFilter.test(fileItem);
|
return regexFilter.test(fileItem);
|
||||||
});
|
});
|
||||||
}
|
};
|
||||||
return fileArray;
|
return fileArray;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists all items (folders AND files) in a directory on local disk
|
* lists all items (folders AND files) in a directory on local disk
|
||||||
* @returns Promise<string[]>
|
* @returns Promise
|
||||||
*/
|
*/
|
||||||
export const listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
|
export let listAllItems = function(pathArg:string, regexFilter?:RegExp){
|
||||||
return listAllItemsSync(pathArg, regexFilter);
|
let done = plugins.Q.defer();
|
||||||
};
|
let allItmesArray = plugins.fsExtra.readdirSync(pathArg);
|
||||||
|
if(regexFilter){
|
||||||
/**
|
|
||||||
* lists all items (folders AND files) in a directory on local disk
|
|
||||||
* @returns an array with the folder names as strings
|
|
||||||
* @executes SYNC
|
|
||||||
*/
|
|
||||||
export const listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
|
|
||||||
let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
|
|
||||||
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
|
|
||||||
});
|
|
||||||
if (regexFilter) {
|
|
||||||
allItmesArray = allItmesArray.filter((fileItem) => {
|
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||||
return regexFilter.test(fileItem);
|
return regexFilter.test(fileItem);
|
||||||
});
|
});
|
||||||
}
|
};
|
||||||
return allItmesArray;
|
done.resolve(allItmesArray);
|
||||||
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* lists a file tree using a miniMatch filter
|
* lists all items (folders AND files) SYNCHRONOUSLY in a directory on local disk
|
||||||
* note: if the miniMatch Filter is an absolute path, the cwdArg will be omitted
|
* @returns an array with the folder names as strings
|
||||||
* @returns Promise<string[]> string array with the absolute paths of all matching files
|
|
||||||
*/
|
*/
|
||||||
export const listFileTree = async (
|
export let listAllItemsSync = function(pathArg:string, regexFilter?:RegExp):string[]{
|
||||||
dirPathArg: string,
|
let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
|
||||||
miniMatchFilter: string,
|
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
|
||||||
absolutePathsBool: boolean = false
|
});
|
||||||
): Promise<string[]> => {
|
if(regexFilter){
|
||||||
const done = plugins.smartpromise.defer<string[]>();
|
allItmesArray = allItmesArray.filter((fileItem) => {
|
||||||
|
return regexFilter.test(fileItem);
|
||||||
// handle absolute miniMatchFilter
|
});
|
||||||
let dirPath: string;
|
|
||||||
if (plugins.path.isAbsolute(miniMatchFilter)) {
|
|
||||||
dirPath = '/';
|
|
||||||
} else {
|
|
||||||
dirPath = dirPathArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
const options = {
|
|
||||||
cwd: dirPath,
|
|
||||||
nodir: true,
|
|
||||||
dot: true,
|
|
||||||
};
|
};
|
||||||
plugins.glob(miniMatchFilter, options, (err, files: string[]) => {
|
return allItmesArray;
|
||||||
if (err) {
|
};
|
||||||
|
|
||||||
|
export let listFileTree = (dirPath:string, miniMatchFilter:string) => {
|
||||||
|
let done = plugins.Q.defer();
|
||||||
|
let options = {
|
||||||
|
cwd:dirPath
|
||||||
|
}
|
||||||
|
plugins.glob(miniMatchFilter,options,(err,files:string[]) => {
|
||||||
|
if(err){
|
||||||
console.log(err);
|
console.log(err);
|
||||||
done.reject(err);
|
done.reject(err);
|
||||||
}
|
};
|
||||||
done.resolve(files);
|
done.resolve(files);
|
||||||
});
|
});
|
||||||
|
return done.promise;
|
||||||
let fileList = await done.promise;
|
|
||||||
if (absolutePathsBool) {
|
|
||||||
fileList = fileList.map((filePath) => {
|
|
||||||
return plugins.path.resolve(plugins.path.join(dirPath, filePath));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return fileList;
|
|
||||||
};
|
};
|
@ -1,20 +1,22 @@
|
|||||||
import plugins = require('./smartfile.plugins');
|
import "typings-global";
|
||||||
|
|
||||||
export let filetype = (pathArg: string): string => {
|
import plugins = require("./smartfile.plugins");
|
||||||
const extName = plugins.path.extname(pathArg);
|
|
||||||
const fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
|
export let filetype = (pathArg:string):string => {
|
||||||
|
let extName = plugins.path.extname(pathArg);
|
||||||
|
let fileType = extName.replace(/\.([a-z]*)/,"$1"); //remove . form fileType
|
||||||
return fileType;
|
return fileType;
|
||||||
};
|
};
|
||||||
|
|
||||||
export let objectFile = (fileStringArg: string, fileTypeArg) => {
|
export let objectFile = (fileStringArg:string, fileTypeArg) => {
|
||||||
switch (fileTypeArg) {
|
switch (fileTypeArg) {
|
||||||
case 'yml':
|
case "yml" :
|
||||||
case 'yaml':
|
case "yaml":
|
||||||
return plugins.yaml.safeLoad(fileStringArg);
|
return plugins.yaml.safeLoad(fileStringArg);
|
||||||
case 'json':
|
case "json":
|
||||||
return JSON.parse(fileStringArg);
|
return JSON.parse(fileStringArg);
|
||||||
default:
|
default:
|
||||||
console.error('file type ' + fileTypeArg.blue + ' not supported');
|
plugins.beautylog.error("file type " + fileTypeArg.blue + " not supported");
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
};
|
}
|
@ -1,8 +1,44 @@
|
|||||||
import plugins = require('./smartfile.plugins');
|
import "typings-global";
|
||||||
import { Smartfile } from './smartfile.classes.smartfile';
|
|
||||||
import * as smartfileFs from './smartfile.fs';
|
|
||||||
|
|
||||||
import SmartfileInterpreter = require('./smartfile.interpreter');
|
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;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* converts file to Object
|
* converts file to Object
|
||||||
@ -10,85 +46,88 @@ import SmartfileInterpreter = require('./smartfile.interpreter');
|
|||||||
* @param fileTypeArg
|
* @param fileTypeArg
|
||||||
* @returns {any|any}
|
* @returns {any|any}
|
||||||
*/
|
*/
|
||||||
export let toObject = function (fileStringArg: string, fileTypeArg: string) {
|
export let toObject = function(fileStringArg:string,fileTypeArg:string){
|
||||||
return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
|
return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg);
|
||||||
};
|
};
|
||||||
|
|
||||||
export interface IToFsOptions {
|
/**
|
||||||
respectRelative?: boolean;
|
* 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;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* writes string or Smartfile to disk.
|
* takes a string array and some options and returns a vinylfile array
|
||||||
|
* @param arrayArg
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
export let toVinylArraySync = function(arrayArg:string[],optionsArg?:{filename?:string,base?:string,relPath?:string}){
|
||||||
|
let vinylArray = [];
|
||||||
|
for(let stringIndexArg in arrayArg){
|
||||||
|
let myString = arrayArg[stringIndexArg];
|
||||||
|
vinylArray.push(toVinylFileSync(myString,optionsArg));
|
||||||
|
}
|
||||||
|
return vinylArray;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* takes a vinylFile object and converts it to String
|
||||||
|
*/
|
||||||
|
export let toStringSync = function(fileArg:plugins.vinyl){
|
||||||
|
return fileArg.contents.toString("utf8");
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* writes string or vinyl file to disk.
|
||||||
* @param fileArg
|
* @param fileArg
|
||||||
* @param fileNameArg
|
* @param fileNameArg
|
||||||
* @param fileBaseArg
|
* @param fileBaseArg
|
||||||
*/
|
*/
|
||||||
export let toFs = async (
|
export let toFs = function(fileContentArg:string|vinyl,filePathArg){
|
||||||
fileContentArg: string | Buffer | Smartfile,
|
let done = plugins.Q.defer();
|
||||||
filePathArg: string,
|
|
||||||
optionsArg: IToFsOptions = {}
|
|
||||||
) => {
|
|
||||||
const done = plugins.smartpromise.defer();
|
|
||||||
|
|
||||||
// check args
|
//function checks to abort if needed
|
||||||
if (!fileContentArg || !filePathArg) {
|
if (!fileContentArg || !filePathArg) throw new Error("expected valid arguments");
|
||||||
throw new Error('expected valid arguments');
|
|
||||||
}
|
|
||||||
|
|
||||||
// prepare actual write action
|
// prepare actual write action
|
||||||
let fileContent: string | Buffer;
|
let fileString:string;
|
||||||
let fileEncoding: 'utf8' | 'binary' = 'utf8';
|
let filePath:string = filePathArg;
|
||||||
let filePath: string = filePathArg;
|
if (fileContentArg instanceof plugins.vinyl){
|
||||||
|
fileString = toStringSync(fileContentArg);
|
||||||
// handle Smartfile
|
} else if (typeof fileContentArg === "string") {
|
||||||
if (fileContentArg instanceof Smartfile) {
|
fileString = fileContentArg;
|
||||||
fileContent = fileContentArg.contentBuffer;
|
|
||||||
// handle options
|
|
||||||
if (optionsArg.respectRelative) {
|
|
||||||
filePath = plugins.path.join(filePath, fileContentArg.path);
|
|
||||||
}
|
}
|
||||||
} else if (Buffer.isBuffer(fileContentArg)) {
|
plugins.fsExtra.writeFile(filePath,fileString,"utf8",done.resolve);
|
||||||
fileContent = fileContentArg;
|
return done.promise;
|
||||||
fileEncoding = 'binary';
|
|
||||||
} else if (typeof fileContentArg === 'string') {
|
|
||||||
fileContent = fileContentArg;
|
|
||||||
} else {
|
|
||||||
throw new Error('fileContent is neither string nor Smartfile');
|
|
||||||
}
|
|
||||||
await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
|
|
||||||
plugins.fsExtra.writeFile(filePath, fileContent, { encoding: fileEncoding }, done.resolve);
|
|
||||||
return await done.promise;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
export let toFsSync = function(fileArg,filePathArg:string){
|
||||||
* writes a string or a Smartfile to disk synchronously, only supports string
|
//function checks to abort if needed
|
||||||
* @param fileArg
|
if (!fileArg || !filePathArg) throw new Error("expected a valid arguments");
|
||||||
* @param filePathArg
|
|
||||||
*/
|
|
||||||
export const toFsSync = (fileArg: string, filePathArg: string) => {
|
|
||||||
// function checks to abort if needed
|
|
||||||
if (!fileArg || !filePathArg) {
|
|
||||||
throw new Error('expected a valid arguments');
|
|
||||||
}
|
|
||||||
|
|
||||||
// prepare actual write action
|
// prepare actual write action
|
||||||
let fileString: string;
|
let fileString:string;
|
||||||
const filePath: string = filePathArg;
|
let filePath:string = filePathArg;
|
||||||
|
|
||||||
if (typeof fileArg !== 'string') {
|
if (fileArg instanceof plugins.vinyl){
|
||||||
throw new Error('fileArg is not of type String.');
|
fileString = toStringSync(fileArg);
|
||||||
} else if (typeof fileArg === 'string') {
|
} else if (typeof fileArg === "string") {
|
||||||
fileString = fileArg;
|
fileString = fileArg;
|
||||||
}
|
}
|
||||||
plugins.fsExtra.writeFileSync(filePath, fileString, { encoding: 'utf8' });
|
plugins.fsExtra.writeFileSync(filePath,fileString,"utf8");
|
||||||
};
|
};
|
||||||
|
|
||||||
export let smartfileArrayToFs = async (smartfileArrayArg: Smartfile[], dirArg: string) => {
|
|
||||||
await smartfileFs.ensureDir(dirArg);
|
|
||||||
for (const smartfile of smartfileArrayArg) {
|
|
||||||
await toFs(smartfile, dirArg, {
|
|
||||||
respectRelative: true,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
@ -1,21 +1,16 @@
|
|||||||
// node native scope
|
import "typings-global";
|
||||||
import * as fs from 'fs';
|
export import beautylog = require("beautylog");
|
||||||
import * as path from 'path';
|
export import fs = require("fs");
|
||||||
|
export import fsExtra = require("fs-extra");
|
||||||
export { fs, path };
|
export let gulp = require("gulp");
|
||||||
|
export let glob = require("glob");
|
||||||
// @pushrocks scope
|
export let g = {
|
||||||
import * as smarthash from '@pushrocks/smarthash';
|
remoteSrc: require("gulp-remote-src")
|
||||||
import * as smartmime from '@pushrocks/smartmime';
|
};
|
||||||
import * as smartpath from '@pushrocks/smartpath';
|
export import path = require("path");
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
export import Q = require("q");
|
||||||
import * as smartrequest from '@pushrocks/smartrequest';
|
export import vinyl = require("vinyl");
|
||||||
|
export let vinylFile = require("vinyl-file");
|
||||||
export { smarthash, smartmime, smartpath, smartpromise, smartrequest };
|
export let yaml = require("js-yaml");
|
||||||
|
export let request = require("request");
|
||||||
// third party scope
|
export let requireReload = require("require-reload");
|
||||||
import * as fsExtra from 'fs-extra';
|
|
||||||
import glob from 'glob';
|
|
||||||
import yaml from 'js-yaml';
|
|
||||||
|
|
||||||
export { fsExtra, glob, yaml };
|
|
||||||
|
@ -1,33 +1,45 @@
|
|||||||
import plugins = require('./smartfile.plugins');
|
import "typings-global";
|
||||||
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()
|
var done = plugins.Q.defer();
|
||||||
let stream = plugins.smartrequest(from).pipe(plugins.fsExtra.createWriteStream(toPath))
|
var stream = plugins.request(from).pipe(plugins.fsExtra.createWriteStream(toPath));
|
||||||
stream.on('finish', function () {
|
stream.on('finish',function(){
|
||||||
done.resolve(toPath)
|
done.resolve(toPath);
|
||||||
})
|
});
|
||||||
return done.promise
|
return done.promise;
|
||||||
} */
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param filePathArg
|
||||||
|
* @returns {*}
|
||||||
|
*/
|
||||||
|
export let toGulpStreamSync = function(filePathArg:string,baseArg:string){
|
||||||
|
let stream = plugins.g.remoteSrc(filePathArg, {
|
||||||
|
base: baseArg
|
||||||
|
});
|
||||||
|
return stream;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param fromArg
|
* @param fromArg
|
||||||
* @returns {any}
|
* @returns {any}
|
||||||
*/
|
*/
|
||||||
export let toObject = (fromArg: string) => {
|
export let toObject = function(fromArg:string){
|
||||||
const done = plugins.smartpromise.defer();
|
let done = plugins.Q.defer();
|
||||||
plugins.smartrequest
|
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||||
.request(fromArg, {
|
let returnObject;
|
||||||
method: 'get',
|
if (!error && response.statusCode == 200) {
|
||||||
})
|
returnObject = SmartfileInterpreter.objectFile(bodyString,SmartfileInterpreter.filetype(fromArg));
|
||||||
.then((res: any) => {
|
done.resolve(returnObject);
|
||||||
if (res.statusCode === 200) {
|
|
||||||
done.resolve(res.body);
|
|
||||||
} else {
|
} else {
|
||||||
console.log('could not get remote file from ' + fromArg);
|
console.log('could not get remote file from ' + fromArg);
|
||||||
done.reject(new Error('could not get remote file from ' + fromArg));
|
returnObject = undefined;
|
||||||
}
|
done.reject(returnObject);
|
||||||
|
};
|
||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
@ -37,15 +49,17 @@ export let toObject = (fromArg: string) => {
|
|||||||
* @param fromArg
|
* @param fromArg
|
||||||
* @returns {any}
|
* @returns {any}
|
||||||
*/
|
*/
|
||||||
export let toString = (fromArg: string): Promise<string> => {
|
export let toString = (fromArg:string) => {
|
||||||
const done = plugins.smartpromise.defer<string>();
|
let done = plugins.Q.defer();
|
||||||
plugins.smartrequest.getBinary(fromArg).then((res: any) => {
|
plugins.request.get(fromArg, function (error, response, bodyString) {
|
||||||
if (res.statusCode === 200) {
|
if (!error && response.statusCode == 200) {
|
||||||
const encoding = plugins.smartmime.getEncoding(fromArg);
|
done.resolve(bodyString);
|
||||||
done.resolve(res.body.toString(encoding));
|
|
||||||
} else {
|
} else {
|
||||||
done.reject(new Error('could not get remote file from ' + fromArg));
|
plugins.beautylog.error('could not get remote file from ' + fromArg);
|
||||||
}
|
bodyString = undefined;
|
||||||
|
done.reject(bodyString);
|
||||||
|
};
|
||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
|
||||||
"rules": {
|
|
||||||
"semicolon": [true, "always"],
|
|
||||||
"no-console": false,
|
|
||||||
"ordered-imports": false,
|
|
||||||
"object-literal-sort-keys": false,
|
|
||||||
"member-ordering": {
|
|
||||||
"options":{
|
|
||||||
"order": [
|
|
||||||
"static-method"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"defaultSeverity": "warning"
|
|
||||||
}
|
|
Reference in New Issue
Block a user