Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
8ddacf51ce | |||
3511f36b67 | |||
c5cfa79f14 | |||
32465d2556 |
1
.gitignore
vendored
1
.gitignore
vendored
@ -4,3 +4,4 @@ node_modules/
|
||||
|
||||
ts/*.js
|
||||
ts/*.js.map
|
||||
ts/typings/
|
||||
|
@ -1,11 +1,9 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- '4.1'
|
||||
before_install:
|
||||
- npm install -g tsd
|
||||
- '4.2.4'
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@smart-coordination.com
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: 3RdzAcS9d6sLJs3tHM2uCVU2wV2NsKiLiYWue98DevgijIqTFDHtYuoP29p7fbB4SV87JRbTK1y41QM2u/CCjnbB+mrAUg/Pn08dTibmzi9liom67sLczIPD4eZeMznXPRaddESQdzqrtQfc/6P+1JQO7XWexLNebgYtMrUzYcOrHPWf/Uktk2cKiYfrO8piSR+HOFh2rzC5HjVZ/7fKDIa9bqTlBETkNc7s2NgB++jKRF9LNMVGI/9EmxjBzSSE1juOz26Ahp4+/+P3Lc5LngnTFOYsPoW5iWNY+AQltZxhu9K+rrtfn90rmQDnO7RCGO5yZgMS2+0UjJedwV+4ancU3nzoNmiuoIL7DjQ7NQlt0QKMmIqZuBFBc3tdxqotxNoJDk8/Ui0yfHWzJz0Fd22OI+VdTWNH1y5Vyywsql6wwkl2+Da1WhZf/Mn2gPgLPI0lssPTIl/u3Bey+167tZ3HvX0yqlvPO/JbqK02+5VrRBaV67vT00DG+dh4nnwqcX14Umx2a3JHt3tSGkDnDKpsLbvqjhPhkMRsCIloju+wMnyKjtScMZW+2FeO2n4PgbjNhF+5SG8pDmTS8p0Vy7iohUOiGIJty7K/1r6sQ1FNluhO5Ol3mBDs6wjg6S5QCSNL9eylpV52FV0UX4cRCijmzso+n48I2BbSwjghTB8=
|
||||
on:
|
||||
|
36
index.d.ts
vendored
Normal file
36
index.d.ts
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
/// <reference path="ts/typings/main.d.ts" />
|
||||
declare module SmartfilePlugins {
|
||||
var init: () => {
|
||||
beautylog: any;
|
||||
fs: any;
|
||||
path: any;
|
||||
q: any;
|
||||
vinyl: any;
|
||||
vinylFile: any;
|
||||
yaml: any;
|
||||
requireReload: any;
|
||||
};
|
||||
}
|
||||
declare module SmartfileCheck {
|
||||
var init: (objectArg: any) => void;
|
||||
}
|
||||
declare module SmartfileSimple {
|
||||
var init: (objectArg: any) => void;
|
||||
}
|
||||
declare module SmartfileVinyl {
|
||||
var init: (objectArg: any) => void;
|
||||
}
|
||||
declare module SmartfileRequire {
|
||||
var init: (objectArg: any) => void;
|
||||
}
|
||||
declare var plugins: {
|
||||
beautylog: any;
|
||||
fs: any;
|
||||
path: any;
|
||||
q: any;
|
||||
vinyl: any;
|
||||
vinylFile: any;
|
||||
yaml: any;
|
||||
requireReload: any;
|
||||
};
|
||||
declare var smartfile: any;
|
36
index.js
36
index.js
@ -1,11 +1,14 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./index.ts" />
|
||||
var SmartfilePlugins;
|
||||
(function (SmartfilePlugins) {
|
||||
SmartfilePlugins.init = function () {
|
||||
var plugins = {
|
||||
beautylog: require("beautylog")("os"),
|
||||
beautylog: require("beautylog"),
|
||||
fs: require("fs-extra"),
|
||||
path: require("path"),
|
||||
q: require("q"),
|
||||
vinyl: require("vinyl"),
|
||||
vinylFile: require("vinyl-file"),
|
||||
yaml: require("js-yaml"),
|
||||
@ -15,6 +18,33 @@ var SmartfilePlugins;
|
||||
};
|
||||
})(SmartfilePlugins || (SmartfilePlugins = {}));
|
||||
/// <reference path="./index.ts" />
|
||||
var SmartfileCheck;
|
||||
(function (SmartfileCheck) {
|
||||
var checks = {
|
||||
fileExistsSync: function (filePath) {
|
||||
var fileExistsBool = false;
|
||||
try {
|
||||
plugins.fs.readFileSync(filePath);
|
||||
fileExistsBool = true;
|
||||
}
|
||||
catch (err) {
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
},
|
||||
fileExists: function (filePath) {
|
||||
var done = plugins.q.defer();
|
||||
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||
err ? done.reject() : done.resolve();
|
||||
});
|
||||
return done.promise;
|
||||
}
|
||||
};
|
||||
SmartfileCheck.init = function (objectArg) {
|
||||
objectArg.checks = checks;
|
||||
};
|
||||
})(SmartfileCheck || (SmartfileCheck = {}));
|
||||
/// <reference path="./index.ts" />
|
||||
var SmartfileSimple;
|
||||
(function (SmartfileSimple) {
|
||||
/**
|
||||
@ -78,13 +108,15 @@ var SmartfileRequire;
|
||||
objectArg.requireReload = requireReload;
|
||||
};
|
||||
})(SmartfileRequire || (SmartfileRequire = {}));
|
||||
/// <reference path="./typings/tsd.d.ts" />
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
/// <reference path="./smartfile.plugins.ts" />
|
||||
/// <reference path="./smartfile.check.ts" />
|
||||
/// <reference path="./smartfile.simple.ts" />
|
||||
/// <reference path="./smartfile.vinyl.ts" />
|
||||
/// <reference path="./smartfile.require.ts" />
|
||||
var plugins = SmartfilePlugins.init();
|
||||
var smartfile = {};
|
||||
SmartfileCheck.init(smartfile);
|
||||
SmartfileSimple.init(smartfile);
|
||||
SmartfileVinyl.init(smartfile);
|
||||
SmartfileRequire.init(smartfile);
|
||||
|
21
package.json
21
package.json
@ -1,10 +1,10 @@
|
||||
{
|
||||
"name": "smartfile",
|
||||
"version": "0.0.9",
|
||||
"version": "0.0.11",
|
||||
"description": "offers smart ways to work with files in nodejs",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "(cd ts/compile && node compile.js) && (node test.js)",
|
||||
"test": "(npmts)",
|
||||
"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)",
|
||||
@ -25,16 +25,17 @@
|
||||
},
|
||||
"homepage": "https://github.com/pushrocks/smartfile",
|
||||
"dependencies": {
|
||||
"beautylog": "1.0.6",
|
||||
"fs-extra": "0.26.2",
|
||||
"js-yaml": "3.4.6",
|
||||
"beautylog": "2.0.6",
|
||||
"fs-extra": "0.26.5",
|
||||
"js-yaml": "3.5.2",
|
||||
"q": "^1.4.1",
|
||||
"require-reload": "0.2.2",
|
||||
"vinyl": "^1.1.0",
|
||||
"vinyl-file": "^1.3.0"
|
||||
"vinyl": "1.1.1",
|
||||
"vinyl-file": "2.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"gulp": "3.9.0",
|
||||
"gulp-typescript": "2.10.0",
|
||||
"pushrocks": "1.0.23"
|
||||
"beautylog": "2.0.7",
|
||||
"npmts": "2.0.3",
|
||||
"should": "^8.2.1"
|
||||
}
|
||||
}
|
||||
|
9
test.js
9
test.js
@ -1,9 +0,0 @@
|
||||
/// <reference path="typings/tsd.d.ts" />
|
||||
var smartfile = require("./index.js");
|
||||
var beautylog = require("beautylog")("os");
|
||||
beautylog.info(smartfile.readFileToString("./test/mytest.txt"));
|
||||
console.log(smartfile.readFileToObject("./test/mytest.yaml"));
|
||||
console.log(smartfile.readFileToObject("./test/mytest.json"));
|
||||
console.log(smartfile.readFileToVinyl("./test/mytest.json"));
|
||||
//var thisIsAnError = smartfile.readFileToObject("./test/mytestDoesNotExist.json");
|
||||
beautylog.success("Test passed!");
|
@ -1 +1 @@
|
||||
This is some test text stored in ./test/mytest.txt -> If this is displayed when running "npm test", then the test has succeeded.
|
||||
Some TestString &&%$
|
45
test/test.js
Normal file
45
test/test.js
Normal file
@ -0,0 +1,45 @@
|
||||
/// <reference path="typings/main.d.ts" />
|
||||
var smartfile = require("../index.js");
|
||||
var beautylog = require("beautylog");
|
||||
var should = require("should");
|
||||
var vinyl = require("vinyl");
|
||||
describe("smartfile", function () {
|
||||
describe(".readFileToString".yellow, function () {
|
||||
it("should read a file to a string", function () {
|
||||
should.equal(smartfile.readFileToString("./test/mytest.txt"), "Some TestString &&%$");
|
||||
});
|
||||
});
|
||||
describe(".readFileToObject".yellow, function () {
|
||||
it("should read an " + ".yaml".blue + " file to an object", function () {
|
||||
var testData = smartfile.readFileToObject("./test/mytest.yaml");
|
||||
testData.should.have.property("key1", "this works");
|
||||
testData.should.have.property("key2", "this works too");
|
||||
});
|
||||
it("should read an " + ".json".blue + " file to an object", function () {
|
||||
var testData = smartfile.readFileToObject("./test/mytest.json");
|
||||
testData.should.have.property("key1", "this works");
|
||||
testData.should.have.property("key2", "this works too");
|
||||
});
|
||||
});
|
||||
describe(".readFileToVinyl".yellow, function () {
|
||||
it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan, function () {
|
||||
var testData = smartfile.readFileToVinyl("./test/mytest.json");
|
||||
(vinyl.isVinyl(testData)).should.be.true();
|
||||
});
|
||||
});
|
||||
describe(".checks".yellow, function () {
|
||||
describe(".fileExistsSync".yellow, function () {
|
||||
it("should return an accurate boolean", function () {
|
||||
(smartfile.checks.fileExistsSync("./test/mytest.json")).should.be.true();
|
||||
(smartfile.checks.fileExistsSync("./test/notthere.json")).should.be.false();
|
||||
});
|
||||
});
|
||||
describe(".fileExists".yellow, function () {
|
||||
it("should return a working promise", function () {
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.Promise();
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.fulfilled();
|
||||
(smartfile.checks.fileExists("./test/notthere.json")).should.not.be.fulfilled();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
@ -1,30 +0,0 @@
|
||||
// import gulp
|
||||
var gulp = require("gulp")
|
||||
var gulpTypescript = require("gulp-typescript");
|
||||
var pr = require("pushrocks");
|
||||
|
||||
gulp.task('compileTS', function() {
|
||||
var stream = gulp.src('../index.ts')
|
||||
.pipe(gulpTypescript({
|
||||
out: "index.js"
|
||||
}))
|
||||
.pipe(gulp.dest("../../"));
|
||||
return stream;
|
||||
});
|
||||
|
||||
gulp.task('compileTestTS', function() {
|
||||
var stream = gulp.src('../test.ts')
|
||||
.pipe(gulpTypescript({
|
||||
out: "test.js"
|
||||
}))
|
||||
.pipe(gulp.dest("../../"));
|
||||
return stream;
|
||||
});
|
||||
|
||||
gulp.task('default',['compileTS','compileTestTS'], function() {
|
||||
pr.beautylog.success('Typescript compiled');
|
||||
});
|
||||
|
||||
//lets tell gulp to start with the default task.
|
||||
pr.beautylog.log('Starting Gulp to compile TypeScript');
|
||||
gulp.start.apply(gulp, ['default']);
|
@ -1,2 +0,0 @@
|
||||
# How to compile.
|
||||
Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.
|
@ -1,5 +1,6 @@
|
||||
/// <reference path="./typings/tsd.d.ts" />
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
/// <reference path="./smartfile.plugins.ts" />
|
||||
/// <reference path="./smartfile.check.ts" />
|
||||
/// <reference path="./smartfile.simple.ts" />
|
||||
/// <reference path="./smartfile.vinyl.ts" />
|
||||
/// <reference path="./smartfile.require.ts" />
|
||||
@ -7,6 +8,7 @@ var plugins = SmartfilePlugins.init();
|
||||
|
||||
|
||||
var smartfile:any = {};
|
||||
SmartfileCheck.init(smartfile);
|
||||
SmartfileSimple.init(smartfile);
|
||||
SmartfileVinyl.init(smartfile);
|
||||
SmartfileRequire.init(smartfile);
|
||||
|
26
ts/smartfile.check.ts
Normal file
26
ts/smartfile.check.ts
Normal file
@ -0,0 +1,26 @@
|
||||
/// <reference path="./index.ts" />
|
||||
module SmartfileCheck {
|
||||
var checks = {
|
||||
fileExistsSync: function(filePath):boolean {
|
||||
var fileExistsBool:boolean = false;
|
||||
try {
|
||||
plugins.fs.readFileSync(filePath)
|
||||
fileExistsBool = true
|
||||
}
|
||||
catch(err){
|
||||
fileExistsBool = false;
|
||||
}
|
||||
return fileExistsBool;
|
||||
},
|
||||
fileExists: function(filePath){
|
||||
var done = plugins.q.defer();
|
||||
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
|
||||
err ? done.reject() : done.resolve();
|
||||
});
|
||||
return done.promise;
|
||||
}
|
||||
};
|
||||
export var init = function(objectArg){
|
||||
objectArg.checks = checks;
|
||||
}
|
||||
}
|
@ -2,9 +2,10 @@
|
||||
module SmartfilePlugins {
|
||||
export var init = function() {
|
||||
var plugins = {
|
||||
beautylog: require("beautylog")("os"),
|
||||
beautylog: require("beautylog"),
|
||||
fs: require("fs-extra"),
|
||||
path: require("path"),
|
||||
q: require("q"),
|
||||
vinyl: require("vinyl"),
|
||||
vinylFile: require("vinyl-file"),
|
||||
yaml: require("js-yaml"),
|
||||
|
60
ts/test.ts
60
ts/test.ts
@ -1,9 +1,51 @@
|
||||
/// <reference path="typings/tsd.d.ts" />
|
||||
var smartfile = require("./index.js");
|
||||
var beautylog = require("beautylog")("os");
|
||||
beautylog.info(smartfile.readFileToString("./test/mytest.txt"));
|
||||
console.log(smartfile.readFileToObject("./test/mytest.yaml"));
|
||||
console.log(smartfile.readFileToObject("./test/mytest.json"));
|
||||
console.log(smartfile.readFileToVinyl("./test/mytest.json"));
|
||||
//var thisIsAnError = smartfile.readFileToObject("./test/mytestDoesNotExist.json");
|
||||
beautylog.success("Test passed!");
|
||||
/// <reference path="typings/main.d.ts" />
|
||||
var smartfile = require("../index.js");
|
||||
var beautylog = require("beautylog");
|
||||
var should = require("should");
|
||||
var vinyl = require("vinyl");
|
||||
describe("smartfile",function(){
|
||||
describe(".readFileToString".yellow,function(){
|
||||
it("should read a file to a string",function(){
|
||||
should.equal(
|
||||
smartfile.readFileToString("./test/mytest.txt"),
|
||||
"Some TestString &&%$"
|
||||
);
|
||||
});
|
||||
});
|
||||
describe(".readFileToObject".yellow,function(){
|
||||
it("should read an " + ".yaml".blue + " file to an object",function(){
|
||||
var testData = smartfile.readFileToObject("./test/mytest.yaml");
|
||||
testData.should.have.property("key1","this works");
|
||||
testData.should.have.property("key2","this works too");
|
||||
|
||||
});
|
||||
it("should read an " + ".json".blue + " file to an object",function(){
|
||||
var testData = smartfile.readFileToObject("./test/mytest.json");
|
||||
testData.should.have.property("key1","this works");
|
||||
testData.should.have.property("key2","this works too");
|
||||
|
||||
});
|
||||
});
|
||||
describe(".readFileToVinyl".yellow,function(){
|
||||
it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan,function(){
|
||||
var testData = smartfile.readFileToVinyl("./test/mytest.json");
|
||||
(vinyl.isVinyl(testData)).should.be.true();
|
||||
|
||||
});
|
||||
});
|
||||
describe(".checks".yellow,function(){
|
||||
describe(".fileExistsSync".yellow,function(){
|
||||
it("should return an accurate boolean",function(){
|
||||
(smartfile.checks.fileExistsSync("./test/mytest.json")).should.be.true();
|
||||
(smartfile.checks.fileExistsSync("./test/notthere.json")).should.be.false();
|
||||
});
|
||||
});
|
||||
describe(".fileExists".yellow,function(){
|
||||
it("should return a working promise",function(){
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.Promise();
|
||||
(smartfile.checks.fileExists("./test/mytest.json")).should.be.fulfilled();
|
||||
(smartfile.checks.fileExists("./test/notthere.json")).should.not.be.fulfilled();
|
||||
});
|
||||
})
|
||||
});
|
||||
});
|
||||
|
12
ts/tsd.json
12
ts/tsd.json
@ -1,12 +0,0 @@
|
||||
{
|
||||
"version": "v4",
|
||||
"repo": "borisyankov/DefinitelyTyped",
|
||||
"ref": "master",
|
||||
"path": "typings",
|
||||
"bundle": "typings/tsd.d.ts",
|
||||
"installed": {
|
||||
"node/node.d.ts": {
|
||||
"commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
|
||||
}
|
||||
}
|
||||
}
|
8
ts/typings.json
Normal file
8
ts/typings.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"browserify": "github:DefinitelyTyped/DefinitelyTyped/browserify/browserify.d.ts",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts",
|
||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts"
|
||||
}
|
||||
}
|
2079
ts/typings/node/node.d.ts
vendored
2079
ts/typings/node/node.d.ts
vendored
File diff suppressed because it is too large
Load Diff
1
ts/typings/tsd.d.ts
vendored
1
ts/typings/tsd.d.ts
vendored
@ -1 +0,0 @@
|
||||
/// <reference path="node/node.d.ts" />
|
Reference in New Issue
Block a user