You've already forked StringFilr
mirror of
https://github.com/FullScreenShenanigans/StringFilr.git
synced 2026-04-28 13:00:51 -07:00
Josh Goldberg
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
<!-- Top -->
|
|
# StringFilr
|
|
[](https://greenkeeper.io/)
|
|
[](https://travis-ci.org/FullScreenShenanigans/StringFilr)
|
|
[](http://badge.fury.io/js/stringfilr)
|
|
|
|
A path-based cache for quick lookups in nested data structures.
|
|
<!-- /Top -->
|
|
|
|
<!-- Development -->
|
|
## Development
|
|
|
|
After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo/):
|
|
|
|
```
|
|
git clone https://github.com/<your-name-here>/StringFilr
|
|
cd StringFilr
|
|
npm install
|
|
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
|
|
```
|
|
|
|
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.
|
|
|
|
<!-- Maps -->
|
|
<!-- /Maps -->
|
|
<!-- /Development -->
|