mapscreatr - npm Package Compare versions

Comparing version 0.7.1 to 0.7.2

.vscode/settings.json

@@ -6,3 +6,3 @@ {
     "tslint.autoFixOnSave": true,
-    "typescript.tsdk": "node_modules\\typescript\\lib"
+    "typescript.tsdk": "node_modules/typescript/lib"
 }

package.json

 {
-    "author": {
-        "email": "[e-mail]",
-        "name": "Josh Goldberg"
-    },
-    "bugs": {
-        "url": "https://github.com/FullScreenShenanigans/MapsCreatr/issues"
-    },
-    "dependencies": {
-        "itemsholdr": "^0.7.0",
-        "objectmakr": "^0.7.1"
-    },
-    "description": "Storage container and lazy loader for GameStartr maps.",
-    "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": "mapscreatr",
-    "repository": {
-        "type": "git",
-        "url": "ssh://[e-mail]:FullScreenShenanigans/MapsCreatr.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 -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": "tsc -p . -w"
-    },
-    "shenanigans": {
-        "name": "MapsCreatr"
-    },
-    "types": "./src/index.d.ts",
-    "version": "0.7.1"
-}
+  "author": {
+    "email": "[e-mail]",
+    "name": "Josh Goldberg"
+  },
+  "browser": "./src/index.js",
+  "bugs": {
+    "url": "https://github.com/FullScreenShenanigans/MapsCreatr/issues"
+  },
+  "dependencies": {
+    "itemsholdr": "^0.7.0",
+    "objectmakr": "^0.7.1"
+  },
+  "description": "Storage container and lazy loader for GameStartr maps.",
+  "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.5",
+    "sinon": "^4.1.2",
+    "sinon-chai": "^2.14.0",
+    "tslint": "5.8.0",
+    "tsutils": "^2.14.0",
+    "typedoc": "^0.9.0",
+    "typescript": "^2.6.2",
+    "webpack": "^3.10.0"
+  },
+  "license": "MIT",
+  "name": "mapscreatr",
+  "repository": {
+    "type": "git",
+    "url": "ssh://[e-mail]:FullScreenShenanigans/MapsCreatr.git"
+  },
+  "scripts": {
+    "dist": "npm run dist:webpack",
+    "dist:webpack": "webpack",
+    "docs": "npm run docs:typedoc",
+    "docs:typedoc": "typedoc src/ --exclude **/*.d.ts --ignoreCompilerErrors --out docs/generated",
+    "init": "npm install && npm run setup && npm run verify",
+    "setup": "npm run setup:copy && npm run setup:package && npm run setup:readme",
+    "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",
+    "setup:readme": "shenanigans-manager hydrate-readme",
+    "src": "npm run src:tsc && npm run src:tslint",
+    "src:tsc": "tsc -p .",
+    "src:tslint": "tslint -c tslint.json -e ./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": "tsc -p . -w"
+  },
+  "shenanigans": {
+    "name": "MapsCreatr"
+  },
+  "types": "./src/index.d.ts",
+  "version": "0.7.2"
+}

README.md

@@ -12,5 +12,32 @@ <!-- {{Top}} -->
 
-See [Documentation/Development](https://github.com/FullScreenShenanigans/Documentation).
+```
+git clone https://github.com/FullScreenShenanigans/MapsCreatr
+cd MapsCreatr
+npm run setup
+npm run verify
+```
 
+* `npm run setup` creates a few auto-generated setup files locally.
+* `npm run verify` builds, lints, and runs tests.
 
+### Building
+
+```shell
+npm run watch
+```
+
+Source files are written under `src/` in TypeScript and compile in-place to JavaScript files.
+`npm run watch` will directly run the TypeScript compiler on source files in watch mode.
+Use it in the background while developing to keep the compiled files up-to-date.
+
+### Running Tests
+
+```shell
+npm run test
+```
+
+Test files are alongside source files under `src/` and named `*.test.ts?`.
+Whenever you add, remove, or rename a `*.test.ts?` file under `src/`, re-run `npm run test:setup` to regenerate the list of static test files in `test/index.html`.
+You can open that file in a browser to debug through the tests.
+`npm run test` will run that setup and execute tests using [Puppeteer](https://github.com/GoogleChrome/puppeteer).
 <!-- {{/Development}} -->

No alert changes

Improved metrics

Total package byte prevSize

1118600

increased by0.08%

Number of lines in readme file

43

increased by168.75%

Worsened metrics

Dev dependency count

20

increased by5.26%

No dependency changes