From 7c784f61cd002caf0ba0d84673af8c0af20fbac5 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 8 Apr 2018 01:24:17 -0400 Subject: [PATCH] .github --- .github/ISSUE_TEMPLATE.md | 51 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 23 ++++++++++++++ .gitignore | 1 - README.md | 17 ++++++----- package.json | 12 ++++---- 5 files changed, 90 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..98fce6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,51 @@ + + + + + + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..dda3fd0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ + + +### Summary + + + +Fixes #_(issue number here)_ + + + diff --git a/.gitignore b/.gitignore index 697d807..f3d3cf6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ dist/ docs/generated/ test/ node_modules/ -*.css *.d.ts *.js* !./*.js diff --git a/README.md b/README.md index 59ad638..3892658 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ - + # StringFilr [![Greenkeeper badge](https://badges.greenkeeper.io/FullScreenShenanigans/StringFilr.svg)](https://greenkeeper.io/) [![Build Status](https://travis-ci.org/FullScreenShenanigans/StringFilr.svg?branch=master)](https://travis-ci.org/FullScreenShenanigans/StringFilr) [![NPM version](https://badge.fury.io/js/stringfilr.svg)](http://badge.fury.io/js/stringfilr) A path-based cache for quick lookups in nested data structures. - + - + ## Development After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo/): @@ -33,14 +33,17 @@ Source files are written under `src/` in TypeScript and compile in-place to Java `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 +#### Running Tests ```shell npm run test ``` -Test files are alongside source files under `src/` and named `*.test.ts?`. +Tests are written in [Mocha](https://github.com/mochajs/mocha) and [Chai](https://github.com/chaijs/chai). +Their files are written using alongside source files under `src/` and named `*.test.ts?`. Whenever you add, remove, or rename a `*.test.t*` file under `src/`, `watch` will 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:run` will run that setup and execute tests using [Puppeteer](https://github.com/GoogleChrome/puppeteer). - + + + + diff --git a/package.json b/package.json index 61d540f..a2bebc4 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "@types/lodash": "^4.14.99", "@types/lolex": "^2.1.2", "@types/mocha": "^5.0.0", - "@types/sinon": "^4.3.0", + "@types/sinon": "^4.3.1", "@types/sinon-chai": "^2.7.29", "chai": "^4.1.2", "concurrently": "^3.5.1", @@ -27,15 +27,15 @@ "requirejs": "^2.3.5", "run-for-every-file": "^1.1.0", "shenanigans-manager": "^0.2.26", - "sinon": "^4.4.8", + "sinon": "^4.5.0", "sinon-chai": "^3.0.0", "tslint": "5.9.1", - "tsutils": "^2.22.2", + "tsutils": "^2.26.1", "typedoc": "^0.11.1", - "typescript": "^2.7.2", + "typescript": "^2.8.1", "watch": "^1.0.2", - "webpack": "^4.2.0", - "webpack-cli": "^2.0.13" + "webpack": "^4.5.0", + "webpack-cli": "^2.0.14" }, "license": "MIT", "name": "stringfilr",