mapscreenr - npm Package Compare versions

Comparing version 0.6.2 to 0.7.0

package.json

 {
-  "name": "mapscreenr",
-  "description": "A flexible container for map attributes and viewport.",
-  "version": "0.6.2",
-  "author": {
-    "name": "Josh Goldberg",
-    "email": "[e-mail]"
-  },
-  "repository": {
-    "type": "git",
-    "url": "ssh://[e-mail]:FullScreenShenanigans/MapScreenr.git"
-  },
-  "bugs": {
-    "url": "https://github.com/FullScreenShenanigans/MapScreenr/issues"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "gulp-shenanigans": "0.6.X"
-  }
+    "author": {
+        "email": "[e-mail]",
+        "name": "Josh Goldberg"
+    },
+    "bugs": {
+        "url": "https://github.com/FullScreenShenanigans/MapScreenr/issues"
+    },
+    "dependencies": {},
+    "description": "A flexible container for map attributes and viewport.",
+    "devDependencies": {
+        "@types/chai": "^4.0.4",
+        "@types/lolex": "^1.5.32",
+        "@types/mocha": "^2.2.44",
+        "@types/sinon": "^4.0.0",
+        "@types/sinon-chai": "^2.7.29",
+        "chai": "^4.1.2",
+        "glob": "^7.1.2",
+        "lolex": "^2.3.0",
+        "mocha": "^4.0.1",
+        "mocha-headless-chrome": "^1.7.1",
+        "requirejs": "^2.3.5",
+        "run-for-every-file": "^1.1.0",
+        "shenanigans-manager": "^0.2.0",
+        "sinon": "^4.1.2",
+        "sinon-chai": "^2.14.0",
+        "tslint": "5.8.0",
+        "typedoc": "^0.9.0",
+        "typescript": "^2.6.2",
+        "webpack": "^3.10.0"
+    },
+    "license": "MIT",
+    "name": "mapscreenr",
+    "repository": {
+        "type": "git",
+        "url": "ssh://[e-mail]:FullScreenShenanigans/MapScreenr.git"
+    },
+    "scripts": {
+        "dist": "npm run dist:webpack",
+        "dist:webpack": "webpack --config webpack.config.js",
+        "docs": "npm run docs:typedoc",
+        "docs:typedoc": "typedoc src/ --out docs/generated",
+        "init": "npm install && npm run setup && npm run verify",
+        "setup": "npm run setup:copy && npm run setup:package",
+        "setup:copy": "npm run setup:copy:default",
+        "setup:copy:default": "run-for-every-file --dot --src \"node_modules/shenanigans-manager/setup/default/\" --file \"**/*\" --run \"mustache package.json {{src-file}} {{file}}\" --dest \".\" --only-files",
+        "setup:package": "shenanigans-manager hydrate-package-json",
+        "src": "npm run src:tsc && npm run src:tslint",
+        "src:tsc": "tsc -p .",
+        "src:tslint": "tslint -c tslint.json --exclude ./node_modules/**/*.ts* -p tsconfig.json -t stylish",
+        "test": "npm run test:setup && npm run test:run",
+        "test:run": "mocha-headless-chrome --file test/index.html",
+        "test:setup": "npm run test:setup:copy && npm run test:setup:html && npm run test:setup:tsc",
+        "test:setup:copy": "npm run test:setup:copy:default",
+        "test:setup:copy:default": "run-for-every-file --dot --src \"node_modules/shenanigans-manager/setup/test/\" --file \"**/*\" --run \"mustache package.json {{src-file}} ./test/{{file}}\" --dest \".\" --only-files",
+        "test:setup:html": "shenanigans-manager generate-test-html",
+        "test:setup:tsc": "tsc -p test",
+        "verify": "npm run src && npm run test && npm run dist && npm run docs",
+        "watch": "run-p \"tsc -p . -w\" \"echo sup\""
+    },
+    "shenanigans": {
+        "name": "MapScreenr"
+    },
+    "types": "./src/index.d.ts",
+    "version": "0.7.0"
 }

README.md

@@ -0,1 +1,2 @@
+<!-- {{Top}} -->
 # MapScreenr
@@ -6,17 +7,10 @@ [![Build Status](https://travis-ci.org/FullScreenShenanigans/MapScreenr.svg?branch=master)](https://travis-ci.org/FullScreenShenanigans/MapScreenr)
 A flexible container for map attributes and viewport.
+<!-- {{/Top}} -->
 
+<!-- {{Development}} -->
+## Development
 
+See [Documentation/Development](https://github.com/FullScreenShenanigans/Documentation).
 
-## Build Process
 
-MapScreenr uses [Gulp](http://gulpjs.com/) to automate building, which requires [Node.js](http://node.js.org).
-
-To build from scratch, install NodeJS and run the following commands:
-
-```
-npm install -g gulp
-npm install
-gulp
-```
-
-See [Build Details](https://github.com/FullScreenShenanigans/Documentation/blob/master/Build%20Details.md) for detailed Gulp usage.
+<!-- {{/Development}} -->

src/IMapScreenr.d.ts

 /**
- * Functions to compute new variable values, keyed by their variable's names.
+ * functions to compute new variable values, keyed by their variable's names.
  */
 export interface IVariableFunctions {
-    [i: string]: Function;
+    [i: string]: () => any;
 }
@@ -31,6 +31,2 @@ /**
     /**
-     * Arguments to be passed to variable Functions.
-     */
-    variableArgs?: any[];
-    /**
      * Assorted known variables, keyed by name.
@@ -77,10 +73,6 @@ */
     /**
-     * A listing of variable Functions to be calculated on screen resets.
+     * A listing of variable functions to be calculated on screen resets.
      */
     variableFunctions: IVariableFunctions;
     /**
-     * Arguments to be passed into variable computation Functions.
-     */
-    variableArgs: any[];
-    /**
      * Known variables, keyed by name.
@@ -103,10 +95,10 @@ */
     /**
-     * Recalculates all variables by passing variableArgs to their Functions.
+     * Recalculates all variables.
      */
     setVariables(): void;
     /**
-     * Recalculates a variable by passing variableArgs to its Function.
+     * Recalculates a variable by passing variableArgs to its function.
      *
      * @param name   The name of the variable to recalculate.
-     * @param value   A new value for the variable instead of its Function's result.
+     * @param value   A new value for the variable instead of its function's result.
      * @returns The new value of the variable.
@@ -113,0 +105,0 @@ */

src/IMapScreenr.js

 define(["require", "exports"], function (require, exports) {
     "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
 });
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJJTWFwU2NyZWVuci5qcyIsInNvdXJjZXNDb250ZW50IjpbXX0=

src/IMapScreenr.ts

 /**
- * Functions to compute new variable values, keyed by their variable's names.
+ * functions to compute new variable values, keyed by their variable's names.
  */
 export interface IVariableFunctions {
-    [i: string]: Function;
+    [i: string]: () => any;
 }
@@ -36,7 +36,2 @@
     /**
-     * Arguments to be passed to variable Functions.
-     */
-    variableArgs?: any[];
-
-    /**
      * Assorted known variables, keyed by name.
@@ -92,3 +87,3 @@ */
     /**
-     * A listing of variable Functions to be calculated on screen resets.
+     * A listing of variable functions to be calculated on screen resets.
      */
@@ -98,7 +93,2 @@ variableFunctions: IVariableFunctions;
     /**
-     * Arguments to be passed into variable computation Functions.
-     */
-    variableArgs: any[];
-
-    /**
      * Known variables, keyed by name.
@@ -125,3 +115,3 @@ */
     /**
-     * Recalculates all variables by passing variableArgs to their Functions.
+     * Recalculates all variables.
      */
@@ -131,6 +121,6 @@ setVariables(): void;
     /**
-     * Recalculates a variable by passing variableArgs to its Function.
-     * 
+     * Recalculates a variable by passing variableArgs to its function.
+     *
      * @param name   The name of the variable to recalculate.
-     * @param value   A new value for the variable instead of its Function's result.
+     * @param value   A new value for the variable instead of its function's result.
      * @returns The new value of the variable.
@@ -142,3 +132,3 @@ */
      * Shifts the MapScreenr horizontally and vertically via shiftX and shiftY.
-     * 
+     *
      * @param dx   How far to scroll horizontally.
@@ -151,3 +141,3 @@ * @param dy   How far to scroll vertically.
      * Shifts the MapScreenr horizontally by changing left and right by the dx.
-     * 
+     *
      * @param dx   How far to scroll horizontally.
@@ -159,3 +149,3 @@ */
      * Shifts the MapScreenr vertically by changing top and bottom by the dy.
-     * 
+     *
      * @param dy   How far to scroll vertically.
@@ -162,0 +152,0 @@ */

src/MapScreenr.d.ts

@@ -9,8 +9,4 @@ import { IMapScreenr, IMapScreenrSettings, IVariableFunctions, IVariables } from "./IMapScreenr";
      */
-    variableFunctions: IVariableFunctions;
+    readonly variableFunctions: IVariableFunctions;
     /**
-     * Arguments to be passed into variable computation Functions.
-     */
-    variableArgs: any[];
-    /**
      * Top border measurement of the bounding box.
@@ -42,16 +38,15 @@ */
      */
-    width: number;
+    readonly width: number;
     /**
      * Constant height of the bounding box.
      */
-    height: number;
+    readonly height: number;
     /**
      * Assorted known variables, keyed by name.
      */
-    variables: IVariables;
+    readonly variables: IVariables;
     /**
-     * Resets the MapScreenr. All members of the settings argument are copied
-     * to the MapScreenr itself, though only width and height are required.
+     * Initializes a new instance of the MapScreenr class.
      *
-     * @param {IMapScreenrSettings} settings
+     * @param settings   Settings to be used for initialization.
      */
@@ -73,3 +68,3 @@ constructor(settings: IMapScreenrSettings);
     /**
-     * Recalculates all variables by passing variableArgs to their Functions.
+     * Recalculates all variables.
      */
@@ -76,0 +71,0 @@ setVariables(): void;

src/MapScreenr.js

 define(["require", "exports"], function (require, exports) {
     "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
     /**
      * A flexible container for map attributes and viewport.
      */
-    var MapScreenr = (function () {
+    var MapScreenr = /** @class */ (function () {
         /**
-         * Resets the MapScreenr. All members of the settings argument are copied
-         * to the MapScreenr itself, though only width and height are required.
+         * Initializes a new instance of the MapScreenr class.
          *
-         * @param {IMapScreenrSettings} settings
+         * @param settings   Settings to be used for initialization.
          */
@@ -18,14 +18,5 @@ function MapScreenr(settings) {
             this.variables = {};
-            if (typeof settings === "undefined") {
-                throw new Error("No settings object given to MapScreenr.");
-            }
-            if (!settings.width) {
-                throw new Error("No width given to MapScreenr.");
-            }
-            if (!settings.height) {
-                throw new Error("No height given to MapScreenr.");
-            }
-            if (settings.variables) {
+            if (settings.variables !== undefined) {
                 for (var name_1 in settings.variables) {
-                    if (settings.variables.hasOwnProperty(name_1)) {
+                    if ({}.hasOwnProperty.call(settings.variables, name_1)) {
                         this.variables[name_1] = settings.variables[name_1];
@@ -37,4 +28,5 @@ }
             this.width = settings.width;
-            this.variableFunctions = settings.variableFunctions || {};
-            this.variableArgs = settings.variableArgs || [];
+            this.variableFunctions = settings.variableFunctions === undefined
+                ? {}
+                : settings.variableFunctions;
         }
@@ -67,9 +59,7 @@ /**
         /**
-         * Recalculates all variables by passing variableArgs to their Functions.
+         * Recalculates all variables.
          */
         MapScreenr.prototype.setVariables = function () {
             for (var i in this.variableFunctions) {
-                if (this.variableFunctions.hasOwnProperty(i)) {
-                    this.setVariable(i);
-                }
+                this.setVariable(i);
             }
@@ -86,3 +76,3 @@ };
             this.variables[name] = arguments.length === 1
-                ? this.variableFunctions[name].apply(this, this.variableArgs)
+                ? this.variableFunctions[name]()
                 : value;
@@ -97,6 +87,6 @@ };
         MapScreenr.prototype.shift = function (dx, dy) {
-            if (dx) {
+            if (dx !== 0) {
                 this.shiftX(dx);
             }
-            if (dy) {
+            if (dy !== 0) {
                 this.shiftY(dy);
@@ -127,3 +117,1 @@ }
 });
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,{"version":3,"sources":["MapScreenr.ts"],"names":[],"mappings":";;IAIA;;OAEG;IACH;QAwDI;;;;;WAKG;QACH,oBAAmB,QAA6B;YAXhD;;eAEG;YACI,cAAS,GAAe,EAAE,CAAC;YAS9B,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC;gBAClC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC/D,CAAC;YACD,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACrD,CAAC;YACD,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACtD,CAAC;YAED,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;gBACrB,GAAG,CAAC,CAAC,IAAM,MAAI,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;oBACpC,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,MAAI,CAAC,CAAC,CAAC,CAAC;wBAC1C,IAAI,CAAC,SAAS,CAAC,MAAI,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAI,CAAC,CAAC;oBACpD,CAAC;gBACL,CAAC;YACL,CAAC;YAED,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC9B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,IAAI,EAAE,CAAC;YAC1D,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;QACpD,CAAC;QAED;;;WAGG;QACI,gCAAW,GAAlB;YACI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;YACb,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAE1B,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,IAAI,CAAC,UAAU,EAAE,CAAC;YAElB,IAAI,CAAC,YAAY,EAAE,CAAC;QACxB,CAAC;QAED;;WAEG;QACI,+BAAU,GAAjB;YACI,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC;QAED;;WAEG;QACI,+BAAU,GAAjB;YACI,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC;QAED;;WAEG;QACI,iCAAY,GAAnB;YACI,GAAG,CAAC,CAAC,IAAM,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBACrC,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC3C,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QAED;;;;;;WAMG;QACI,gCAAW,GAAlB,UAAmB,IAAY,EAAE,KAAW;YACxC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC;kBACvC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC;kBAC3D,KAAK,CAAC;QAChB,CAAC;QAED;;;;;WAKG;QACI,0BAAK,GAAZ,UAAa,EAAU,EAAE,EAAU;YAC/B,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACpB,CAAC;YAED,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACpB,CAAC;QACL,CAAC;QAED;;;;WAIG;QACI,2BAAM,GAAb,UAAc,EAAU;YACpB,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACrB,CAAC;QAED;;;;WAIG;QACI,2BAAM,GAAb,UAAc,EAAU;YACpB,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QACL,iBAAC;IAAD,CAhLA,AAgLC,IAAA;IAhLY,kBAAU,aAgLtB,CAAA","file":"MapScreenr.js","sourcesContent":["import {\r\n    IMapScreenr, IMapScreenrSettings, IVariableFunctions, IVariables\r\n} from \"./IMapScreenr\";\r\n\r\n/**\r\n * A flexible container for map attributes and viewport.\r\n */\r\nexport class MapScreenr implements IMapScreenr {\r\n    /**\r\n     * A listing of variable Functions to be calculated on screen resets.\r\n     */\r\n    public variableFunctions: IVariableFunctions;\r\n\r\n    /**\r\n     * Arguments to be passed into variable computation Functions.\r\n     */\r\n    public variableArgs: any[];\r\n\r\n    /**\r\n     * Top border measurement of the bounding box.\r\n     */\r\n    public top: number;\r\n\r\n    /**\r\n     * Right border measurement of the bounding box.\r\n     */\r\n    public right: number;\r\n\r\n    /**\r\n     * Bottom border measurement of the bounding box.\r\n     */\r\n    public bottom: number;\r\n\r\n    /**\r\n     * Left border measurement of the bounding box.\r\n     */\r\n    public left: number;\r\n\r\n    /**\r\n     * Constant horizontal midpoint of the bounding box, equal to (left + right) / 2.\r\n     */\r\n    public middleX: number;\r\n\r\n    /**\r\n     * Constant vertical midpoint of the bounding box, equal to (top + bottom) / 2.\r\n     */\r\n    public middleY: number;\r\n\r\n    /**\r\n     * Constant width of the bounding box.\r\n     */\r\n    public width: number;\r\n\r\n    /**\r\n     * Constant height of the bounding box.\r\n     */\r\n    public height: number;\r\n\r\n    /**\r\n     * Assorted known variables, keyed by name.\r\n     */\r\n    public variables: IVariables = {};\r\n\r\n    /**\r\n     * Resets the MapScreenr. All members of the settings argument are copied\r\n     * to the MapScreenr itself, though only width and height are required.\r\n     * \r\n     * @param {IMapScreenrSettings} settings\r\n     */\r\n    public constructor(settings: IMapScreenrSettings) {\r\n        if (typeof settings === \"undefined\") {\r\n            throw new Error(\"No settings object given to MapScreenr.\");\r\n        }\r\n        if (!settings.width) {\r\n            throw new Error(\"No width given to MapScreenr.\");\r\n        }\r\n        if (!settings.height) {\r\n            throw new Error(\"No height given to MapScreenr.\");\r\n        }\r\n\r\n        if (settings.variables) {\r\n            for (const name in settings.variables) {\r\n                if (settings.variables.hasOwnProperty(name)) {\r\n                    this.variables[name] = settings.variables[name];\r\n                }\r\n            }\r\n        }\r\n\r\n        this.height = settings.height;\r\n        this.width = settings.width;\r\n        this.variableFunctions = settings.variableFunctions || {};\r\n        this.variableArgs = settings.variableArgs || [];\r\n    }\r\n\r\n    /**\r\n     * Completely clears the MapScreenr for use in a new Area. Positioning is\r\n     * reset to (0,0) and user-configured variables are recalculated.\r\n     */\r\n    public clearScreen(): void {\r\n        this.left = 0;\r\n        this.top = 0;\r\n        this.right = this.width;\r\n        this.bottom = this.height;\r\n\r\n        this.setMiddleX();\r\n        this.setMiddleY();\r\n\r\n        this.setVariables();\r\n    }\r\n\r\n    /**\r\n     * Computes middleX as the midpoint between left and right.\r\n     */\r\n    public setMiddleX(): void {\r\n        this.middleX = (this.left + this.right) / 2;\r\n    }\r\n\r\n    /**\r\n     * Computes middleY as the midpoint between top and bottom.\r\n     */\r\n    public setMiddleY(): void {\r\n        this.middleY = (this.top + this.bottom) / 2;\r\n    }\r\n\r\n    /**\r\n     * Recalculates all variables by passing variableArgs to their Functions.\r\n     */\r\n    public setVariables(): void {\r\n        for (const i in this.variableFunctions) {\r\n            if (this.variableFunctions.hasOwnProperty(i)) {\r\n                this.setVariable(i);\r\n            }\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Recalculates a variable by passing variableArgs to its Function.\r\n     * \r\n     * @param name   The name of the variable to recalculate.\r\n     * @param value   A new value for the variable instead of its Function's result.\r\n     * @returns The new value of the variable.\r\n     */\r\n    public setVariable(name: string, value?: any): any {\r\n        this.variables[name] = arguments.length === 1\r\n            ? this.variableFunctions[name].apply(this, this.variableArgs)\r\n            : value;\r\n    }\r\n\r\n    /**\r\n     * Shifts the MapScreenr horizontally and vertically via shiftX and shiftY.\r\n     * \r\n     * @param dx   How far to scroll horizontally.\r\n     * @param dy   How far to scroll vertically.\r\n     */\r\n    public shift(dx: number, dy: number): void {\r\n        if (dx) {\r\n            this.shiftX(dx);\r\n        }\r\n\r\n        if (dy) {\r\n            this.shiftY(dy);\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Shifts the MapScreenr horizontally by changing left and right by the dx.\r\n     * \r\n     * @param dx   How far to scroll horizontally.\r\n     */\r\n    public shiftX(dx: number): void {\r\n        this.left += dx;\r\n        this.right += dx;\r\n    }\r\n\r\n    /**\r\n     * Shifts the MapScreenr vertically by changing top and bottom by the dy.\r\n     * \r\n     * @param dy   How far to scroll vertically.\r\n     */\r\n    public shiftY(dy: number): void {\r\n        this.top += dy;\r\n        this.bottom += dy;\r\n    }\r\n}\r\n"]}

src/MapScreenr.ts

@@ -1,4 +0,2 @@
-import {
-    IMapScreenr, IMapScreenrSettings, IVariableFunctions, IVariables
-} from "./IMapScreenr";
+import { IMapScreenr, IMapScreenrSettings, IVariableFunctions, IVariables } from "./IMapScreenr";
 
@@ -12,10 +10,5 @@ /**
      */
-    public variableFunctions: IVariableFunctions;
+    public readonly variableFunctions: IVariableFunctions;
 
     /**
-     * Arguments to be passed into variable computation Functions.
-     */
-    public variableArgs: any[];
-
-    /**
      * Top border measurement of the bounding box.
@@ -53,3 +46,3 @@ */
      */
-    public width: number;
+    public readonly width: number;
 
@@ -59,3 +52,3 @@ /**
      */
-    public height: number;
+    public readonly height: number;
 
@@ -65,24 +58,13 @@ /**
      */
-    public variables: IVariables = {};
+    public readonly variables: IVariables = {};
 
     /**
-     * Resets the MapScreenr. All members of the settings argument are copied
-     * to the MapScreenr itself, though only width and height are required.
-     * 
-     * @param {IMapScreenrSettings} settings
+     * Initializes a new instance of the MapScreenr class.
+     *
+     * @param settings   Settings to be used for initialization.
      */
     public constructor(settings: IMapScreenrSettings) {
-        if (typeof settings === "undefined") {
-            throw new Error("No settings object given to MapScreenr.");
-        }
-        if (!settings.width) {
-            throw new Error("No width given to MapScreenr.");
-        }
-        if (!settings.height) {
-            throw new Error("No height given to MapScreenr.");
-        }
-
-        if (settings.variables) {
+        if (settings.variables !== undefined) {
             for (const name in settings.variables) {
-                if (settings.variables.hasOwnProperty(name)) {
+                if ({}.hasOwnProperty.call(settings.variables, name)) {
                     this.variables[name] = settings.variables[name];
@@ -95,4 +77,5 @@ }
         this.width = settings.width;
-        this.variableFunctions = settings.variableFunctions || {};
-        this.variableArgs = settings.variableArgs || [];
+        this.variableFunctions = settings.variableFunctions === undefined
+            ? {}
+            : settings.variableFunctions;
     }
@@ -131,9 +114,7 @@
     /**
-     * Recalculates all variables by passing variableArgs to their Functions.
+     * Recalculates all variables.
      */
     public setVariables(): void {
         for (const i in this.variableFunctions) {
-            if (this.variableFunctions.hasOwnProperty(i)) {
-                this.setVariable(i);
-            }
+            this.setVariable(i);
         }
@@ -144,3 +125,3 @@ }
      * Recalculates a variable by passing variableArgs to its Function.
-     * 
+     *
      * @param name   The name of the variable to recalculate.
@@ -152,3 +133,3 @@ * @param value   A new value for the variable instead of its Function's result.
         this.variables[name] = arguments.length === 1
-            ? this.variableFunctions[name].apply(this, this.variableArgs)
+            ? this.variableFunctions[name]()
             : value;
@@ -159,3 +140,3 @@ }
      * Shifts the MapScreenr horizontally and vertically via shiftX and shiftY.
-     * 
+     *
      * @param dx   How far to scroll horizontally.
@@ -165,7 +146,7 @@ * @param dy   How far to scroll vertically.
     public shift(dx: number, dy: number): void {
-        if (dx) {
+        if (dx !== 0) {
             this.shiftX(dx);
         }
 
-        if (dy) {
+        if (dy !== 0) {
             this.shiftY(dy);
@@ -177,3 +158,3 @@ }
      * Shifts the MapScreenr horizontally by changing left and right by the dx.
-     * 
+     *
      * @param dx   How far to scroll horizontally.
@@ -188,3 +169,3 @@ */
      * Shifts the MapScreenr vertically by changing top and bottom by the dy.
-     * 
+     *
      * @param dy   How far to scroll vertically.
@@ -191,0 +172,0 @@ */

tsconfig.json

 {
     "compilerOptions": {
         "declaration": true,
+        "experimentalDecorators": true,
+        "jsx": "react",
+        "lib": ["dom", "es2015.collection", "es2015.promise", "es5"],
         "module": "amd",
@@ -10,10 +13,14 @@ "moduleResolution": "node",
         "noFallthroughCasesInSwitch": true,
-        "noUnusedLocals": true,
-        "noUnusedParameters": true,
+        "pretty": true,
         "strictNullChecks": true,
-        "target": "es3"
+        "target": "es5"
     },
+    "exclude": [
+        "dist",
+        "node_modules"
+    ],
     "include": [
-        "./src/**/*.ts"
+        "./src/**/*.ts",
+        "./src/**/*.tsx"
     ]
 }

tslint.json

 {
+    "extends": "./node_modules/shenanigans-manager/setup/tslint.json",
     "rules": {
-        "align": [
-            true,
-            "parameters",
-            "arguments",
-            "statements"
-        ],
-        "class-name": true,
-        "comment-format": [true, "check-space"],
-        "curly": true,
-        "eofline": true,
-        "forin": true,
-        "indent": [true, 4],
-        "interface-name": [true, "always-prefix"],
-        "jsdoc-format": true,
-        "label-position": true,
-        "max-line-length": [true, 140],
-        "member-access": true,
-        "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-console": [
-            true,
-            "debug",
-            "info",
-            "time",
-            "timeEnd",
-            "trace"
-        ],
-        "no-construct": true,
-        "no-debugger": true,
-        "no-duplicate-variable": true,
-        "no-empty": true,
-        "no-eval": true,
-        "no-internal-module": true,
-        "no-null-keyword": true,
-        "no-shadowed-variable": true,
-        "no-string-literal": true,
-        "no-switch-case-fall-through": true,
-        "no-trailing-whitespace": true,
-        "no-unsafe-finally": true,
-        "no-unused-expression": true,
-        "no-unused-new": true,
-        "no-use-before-declare": true,
-        "no-var-keyword": true,
-        "one-line": [
-            true,
-            "check-catch",
-            "check-else",
-            "check-finally",
-            "check-open-brace",
-            "check-whitespace"
-        ],
-        "one-variable-per-declaration": true,
-        "ordered-imports": true,
-        "quotemark": [true, "double"],
-        "semicolon": [true, "always"],
-        "switch-default": true,
-        "trailing-comma": true,
-        "triple-equals": [true, "allow-null-check"],
-        "typedef": [
-            true,
-            "call-signature",
-            "parameter",
-            "property-declaration",
-            "variable-declaration",
-            "member-variable-declaration"
-        ],
-        "typedef-whitespace": [
-            true,
-            {
-                "call-signature": "nospace",
-                "index-signature": "nospace",
-                "parameter": "nospace",
-                "property-declaration": "nospace",
-                "variable-declaration": "nospace"
-            }
-        ],
-        "use-isnan": true,
-        "whitespace": [
-            true,
-            "check-branch",
-            "check-decl",
-            "check-operator",
-            "check-separator",
-            "check-type"
-        ]
+        "no-any": false
     }
-}
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

475601

decreased by-7.33%

Dev dependency count

19

increased by1800%

Number of package files

32

decreased by-33.33%

Lines of code

2079

decreased by-20.74%

Number of lines in readme file

16

decreased by-27.27%

Number of medium supply chain risk alerts

4

increased by33.33%

No dependency changes