Skip to content

Commit f56c4ed

Browse files
evanshortissevanshortiss
authored
Typescript support and rewrite. 3.0 release. (#5)
* TypeScript rewrite. Support TypeScript. Expose AbstractVector. * Convert codebase to TypeScript * Add support for TypeScript * Expose AbstractVector class for extension if desired * Enforce need for new keyword when creating vectors * Publish code coverage to Coveralls * Increase code coverage * Test against multiple Node.js versions in CI * Drop Node.js v4 support
1 parent 05052f5 commit f56c4ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+16369
-2319
lines changed

‎.editorconfig

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
root = true
22

3-
[*.js]
3+
[*]
44
indent_style = space
55
indent_size = 2
66
trim_trailing_whitespace = true
77
insert_final_newline = true
8-
9-
[*.yml]
10-
indent_style = space
11-
indent_size = 2
12-
trim_trailing_whitespace = true
13-
insert_final_newline = true

‎.gitignore

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
node_modules
22
.DS_Store
3-
npm-debug.log
4-
coverage.html
5-
.idea
3+
*.log
4+
.idea
5+
.vscode
6+
coverage
7+
8+
dist/*.js
9+
10+
src/*.js
11+
src/*.js.map
12+
src/*.d.ts

‎.jshintrc

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.npmignore

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
test
2-
bower.json
3-
index.html
4-
performance
5-
build
6-
Gruntfile.js
1+
# No need to publish typescript source files
2+
*.ts
3+
4+
# These are ignored by Git, but we DO want to publish them to npm
5+
!src/*.js
6+
!src/*.d.ts
7+
8+
# Tests, examples, etc. should be ignored too
9+
__test__
10+
dist
11+
example
12+
.travis.yml
13+
.editorconfig
14+
docs

‎.travis.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
language: node_js
22

33
node_js:
4-
- "0.10"
4+
- "10"
5+
- "9"
6+
- "8"
7+
- "6"
58

6-
branches:
7-
only:
8-
- master
9+
after_success:
10+
- npm run coveralls

‎CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# CHANGELOG
2+
3+
Dates are YYYY-MM-DD.
4+
5+
## 3.0.0 / 2018-05-24
6+
* Convert codebase to TypeScript
7+
* Add support for TypeScript
8+
* Expose `AbstractVector` class for extension if desired
9+
* Enforce need for `new` keyword when creating vectors
10+
* Publish code coverage to Coveralls
11+
* Increase code coverage
12+
* Test against multiple Node.js versions in CI
13+
* Add generated documentation
14+
15+
## 2.x
16+
* Build using browserify
17+
* Removed static methods from exposed API
18+
* Various performance improvements
19+
20+
## 1.x
21+
* Here be dragons

‎CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
All contributors are welcome! Be respectful of everyone involved and together we
4+
can all get awesome things done in the world of OSS 🤘
5+
6+
## Testing
7+
If you're adding new functions or changing functionality please create or update
8+
the unit tests. Simple.
9+
10+
## Submitting Changes
11+
When submitting a Pull Request please:
12+
13+
* Reference an Issue (if one exists)
14+
* Provide a clear description of the change
15+
* Use a clear and concise commit message
16+
17+
## Coding Conventions
18+
A style guide is enforced using
19+
[Prettier](https://www.npmjs.com/package/prettier) and it will run as part of
20+
your commit along with the unit tests. Let it do it's thing and everything will
21+
be good.

‎LICENSE

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
// Copyright (c) 2014 Evan Shortiss
2-
//
3-
// Permission is hereby granted, free of charge, to any person obtaining a copy
4-
// of this software and associated documentation files (the "Software"), to deal
5-
// in the Software without restriction, including without limitation the rights
6-
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7-
// copies of the Software, and to permit persons to whom the Software is
8-
// furnished to do so, subject to the following conditions:
9-
//
10-
// The above copyright notice and this permission notice shall be included in
11-
// all copies or substantial portions of the Software.
12-
//
13-
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14-
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15-
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16-
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17-
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18-
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19-
// THE SOFTWARE.
1+
(The MIT License)
202

3+
Copyright (c) 2018 Evan Shortiss <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
'Software'), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎Makefile

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)