mapscreenr - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

gulpfile.js

@@ -1,4 +0,1 @@
-require("gulp-shenanigans").initialize({
-    gulp: require("gulp"),
-    packageName: "MapScreenr"
-});
+require("gulp-shenanigans").initialize(require("gulp"));

lib/MapScreenr.d.ts

@@ -81,2 +81,14 @@ declare namespace MapScreenr {
         /**
+         * 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.
+         */
+        variables: IVariables;
+        /**
          * Completely clears the MapScreenr for use in a new Area. Positioning is
@@ -125,14 +137,2 @@ * reset to (0,0) and user-configured variables are recalculated.
         shiftY(dy: number): void;
-        /**
-         * 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.
-         */
-        variables: IVariables;
     }
@@ -139,0 +139,0 @@ /**

lib/MapScreenr.ts

@@ -0,1 +1,3 @@
+
+
 namespace MapScreenr {
@@ -97,2 +99,17 @@ /**
         /**
+         * 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.
+         */
+        variables: IVariables;
+
+        /**
          * Completely clears the MapScreenr for use in a new Area. Positioning is
@@ -148,17 +165,2 @@ * reset to (0,0) and user-configured variables are recalculated.
         shiftY(dy: number): void;
-
-        /**
-         * 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.
-         */
-        variables: IVariables;
     }
@@ -165,0 +167,0 @@

package.json

 {
   "name": "mapscreenr",
   "description": "A flexible container for map attributes and viewport.",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "author": {
     "name": "Josh Goldberg",
-    "email": "[e-mail]"
+    "email": "[e-mail]"
   },
@@ -18,4 +18,4 @@ "repository": {
   "devDependencies": {
-    "gulp-shenanigans": "^0.3.1"
+    "gulp-shenanigans": "^0.5.1"
   }
 }

README.md

@@ -15,2 +15,3 @@ # MapScreenr
 ```
+npm install -g gulp
 npm install
@@ -20,8 +21,2 @@ 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.

src/IMapScreenr.ts

@@ -96,2 +96,17 @@ /**
     /**
+     * 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.
+     */
+    variables: IVariables;
+
+    /**
      * Completely clears the MapScreenr for use in a new Area. Positioning is
@@ -147,17 +162,2 @@ * reset to (0,0) and user-configured variables are recalculated.
     shiftY(dy: number): void;
-
-    /**
-     * 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.
-     */
-    variables: IVariables;
 }

src/MapScreenr.ts

@@ -1,2 +0,4 @@
-import { IMapScreenr, IMapScreenrSettings, IVariables, IVariableFunctions } from "./IMapScreenr";
+import {
+    IMapScreenr, IMapScreenrSettings, IVariableFunctions, IVariables
+} from "./IMapScreenr";
 
@@ -3,0 +5,0 @@ /**

test/utils/MochaLoader.js

@@ -12,4 +12,5 @@ /* This file was auto-generated by gulp-shenanigans */
      * @param mocha   The underlying mocha instance.
+     * @param require   The global require instance.
      */
-    function MochaLoader(mocha) {
+    function MochaLoader(mocha, require) {
         /**
@@ -24,2 +25,5 @@ * Root grouping of test hierarchies.
         this.mocha.setup("bdd");
+        require.config({
+            baseUrl: "../lib"
+        });
     }
@@ -26,0 +30,0 @@ /**

test/utils/MochaLoader.ts

@@ -50,6 +50,11 @@ /* This file was auto-generated by gulp-shenanigans */
      * @param mocha   The underlying mocha instance.
+     * @param require   The global require instance.
      */
-    public constructor(mocha: any) {
+    public constructor(mocha: any, require: any) {
         this.mocha = mocha;
         this.mocha.setup("bdd");
+
+        require.config({
+            baseUrl: "../lib"
+        });
     }
@@ -72,3 +77,3 @@
      */
-    public addTest(testName: string, test: () => void): void {
+    public addTest(testName: string, test: (done?: Function) => void): void {
         if (!this.currentTestPath) {
@@ -75,0 +80,0 @@ throw new Error(`No test path defined before adding test '${testName}'.`);

tslint.json

 {
     "rules": {
-        "align": true,
-        "class-name": true,
-        "comment-format": [
+        "align": [
             true,
-            "check-space"
+            "parameters",
+            "arguments",
+            "statements"
         ],
+        "class-name": true,
+        "comment-format": [true, "check-space"],
+        "curly": true,
         "eofline": true,
-        "indent": [
+        "forin": true,
+        "indent": [true, 4],
+        "interface-name": [true, "always-prefix"],
+        "jsdoc-format": true,
+        "label-position": true,
+        "label-undefined": true,
+        "max-line-length": [true, 140],
+        "member-access": true,
+        "member-ordering": [
             true,
-            "spaces"
+            "public-before-private",
+            "static-before-instance",
+            "variables-before-functions"
         ],
-        "jsdoc-format": true,
-        "max-line-length": 140,
-        "member-access": true,
-        "member-ordering": "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-constructor-vars": true,
-        "no-construct": true,
+        "no-debugger": true,
         "no-duplicate-key": true,
@@ -28,7 +48,3 @@ "no-duplicate-variable": 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,
@@ -38,5 +54,15 @@ "no-string-literal": 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",
@@ -46,14 +72,16 @@ "check-whitespace"
         "one-variable-per-declaration": true,
-        "quotemark": [
+        "ordered-imports": true,
+        "quotemark": [true, "double"],
+        "semicolon": [true, "always"],
+        "switch-default": true,
+        "trailing-comma": true,
+        "triple-equals": [true, "allow-null-check"],
+        "typedef": [
             true,
-            "double"
+            "call-signature",
+            "parameter",
+            "property-declaration",
+            "variable-declaration",
+            "member-variable-declaration"
         ],
-        "semicolon": [
-            true,
-            "always"
-        ],
-        "switch-default": true,
-        "trailing-comma": true,
-        "triple-equals": true,
-        "typedef": true,
         "typedef-whitespace": [
@@ -69,5 +97,7 @@ true,
         ],
-        "variable-name": [
+        "use-isnan": true,
+        "use-strict": [
             true,
-            "ban-keywords"
+            "check-module",
+            "check-function"
         ],
@@ -74,0 +104,0 @@ "whitespace": [

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

51907

increased by2.75%

Number of package files

24

increased by4.35%

Lines of code

1482

increased by3.06%

Worsened metrics

Number of lines in readme file

21

decreased by-19.23%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes