From 66a34925ec567ffd207bbc2a229d6fa215f04c4a Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 14 Aug 2016 20:28:12 -0700 Subject: [PATCH] Onboarded shenanigans.json (0.5.2) --- .travis.yml | 2 +- README.md | 11 ++---- gulpfile.js | 6 +--- package.json | 8 ++--- shenanigans.json | 7 ++++ tslint.json | 88 ++++++++++++++++++++++++++++++++---------------- 6 files changed, 75 insertions(+), 47 deletions(-) create mode 100644 shenanigans.json diff --git a/.travis.yml b/.travis.yml index 281d3b0..716dea1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,4 +7,4 @@ before_script: npm install -g gulp && npm install script: - gulp \ No newline at end of file + gulp diff --git a/README.md b/README.md index 12c1d9a..d41f9eb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/FullScreenShenanigans/InputWritr.svg?branch=master)](https://travis-ci.org/FullScreenShenanigans/InputWritr) [![NPM version](https://badge.fury.io/js/inputwritr.svg)](http://badge.fury.io/js/inputwritr) -A configurable wrapper, recorder, and playback manager around user inputs. +Configurable wrapper, recorder, and playback manager around user inputs. ## Build Process @@ -12,14 +12,9 @@ InputWritr uses [Gulp](http://gulpjs.com/) to automate building, which requires To build from scratch, install NodeJS and run the following commands: ``` +npm install -g gulp npm install gulp ``` -### Individual Gulp tasks - -* `gulp dist` - Compiles the source into `dist/`. -* `gulp tsc` - Runs the [TypeScript](https://typescriptlang.org/) compiler. -* `gulp tslint` - Runs [TSLint](https://github.com/palantir/tslint). -* `gulp test` - Runs tests in `tests/`. -* `gulp watch` - Runs the `tsc` and `tslint` tasks when a source file changes. +See [Build Details](https://github.com/FullScreenShenanigans/Documentation/blob/master/Build%20Details.md) for detailed Gulp usage. diff --git a/gulpfile.js b/gulpfile.js index 29dac4f..5b7a4f9 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1,5 +1 @@ -require("gulp-shenanigans").initialize({ - gulp: require("gulp"), - packageName: "InputWritr" -}); - +require("gulp-shenanigans").initialize(require("gulp")); diff --git a/package.json b/package.json index 21153d1..82e6c7a 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { "name": "inputwritr", - "description": "A configurable wrapper, recorder, and playback manager around user inputs.", - "version": "0.5.1", + "description": "Configurable wrapper, recorder, and playback manager around user inputs.", + "version": "0.5.2", "author": { "name": "Josh Goldberg", - "email": "josh@fullscreenmario.com" + "email": "joshuakgoldberg@outlook.com" }, "repository": { "type": "git", @@ -15,6 +15,6 @@ }, "license": "MIT", "devDependencies": { - "gulp-shenanigans": "^0.3.1" + "gulp-shenanigans": "^0.5.1" } } diff --git a/shenanigans.json b/shenanigans.json new file mode 100644 index 0000000..4bdc1d2 --- /dev/null +++ b/shenanigans.json @@ -0,0 +1,7 @@ +{ + "package": { + "description": "Configurable wrapper, recorder, and playback manager around user inputs.", + "name": "InputWritr", + "version": "0.5.2" + } +} diff --git a/tslint.json b/tslint.json index e0bb60b..5c23448 100644 --- a/tslint.json +++ b/tslint.json @@ -1,58 +1,86 @@ { "rules": { - "align": true, + "align": [ + true, + "parameters", + "arguments", + "statements" + ], "class-name": true, - "comment-format": [ - true, - "check-space" - ], + "comment-format": [true, "check-space"], + "curly": true, "eofline": true, - "indent": [ - true, - "spaces" - ], + "forin": true, + "indent": [true, 4], + "interface-name": [true, "always-prefix"], "jsdoc-format": true, - "max-line-length": 140, + "label-position": true, + "label-undefined": true, + "max-line-length": [true, 140], "member-access": true, - "member-ordering": "variables-before-functions", + "member-ordering": [ + true, + "public-before-private", + "static-before-instance", + "variables-before-functions" + ], + "new-parens": true, "no-angle-bracket-type-assertion": true, "no-arg": true, + "no-conditional-assignment": true, "no-consecutive-blank-lines": true, - "no-constructor-vars": true, + "no-console": [ + true, + "debug", + "info", + "time", + "timeEnd", + "trace" + ], "no-construct": true, + "no-constructor-vars": true, + "no-debugger": true, "no-duplicate-key": true, "no-duplicate-variable": true, "no-empty": true, "no-eval": true, "no-internal-module": true, - "no-invalid-this": true, - "no-use-before-declare": true, - "no-unreachable": true, - "no-unused-expression": true, - "no-unused-variable": true, + "no-null-keyword": true, "no-shadowed-variable": true, "no-string-literal": true, "no-switch-case-fall-through": true, "no-trailing-whitespace": true, + "no-unreachable": true, + "no-unsafe-finally": true, + "no-unused-expression": true, + "no-unused-variable": true, + "no-unused-new": true, + "no-use-before-declare": true, "no-var-keyword": true, + "no-var-requires": true, "one-line": [ true, + "check-catch", + "check-else", + "check-finally", "check-open-brace", "check-whitespace" ], "one-variable-per-declaration": true, - "quotemark": [ - true, - "double" - ], - "semicolon": [ - true, - "always" - ], + "ordered-imports": true, + "quotemark": [true, "double"], + "semicolon": [true, "always"], "switch-default": true, "trailing-comma": true, - "triple-equals": true, - "typedef": true, + "triple-equals": [true, "allow-null-check"], + "typedef": [ + true, + "call-signature", + "parameter", + "property-declaration", + "variable-declaration", + "member-variable-declaration" + ], "typedef-whitespace": [ true, { @@ -63,9 +91,11 @@ "variable-declaration": "nospace" } ], - "variable-name": [ + "use-isnan": true, + "use-strict": [ true, - "ban-keywords" + "check-module", + "check-function" ], "whitespace": [ true,