terotests/evg

Elastic View Graphics

evg's Issues

package.json version bump should correspond to a git tag

Ideally each package.json version should have a corresponding git tag.

./src/test and ./src/legacy appear to be dead code

The directories ./src/test and ./src/legacy appear to be completely unused and should probably be removed.

Project relies on a global TypeScript installation

The TypeScript version used by this project should be explicitly declared in package.json. Different TypeScript versions behave differently, and the lack of a specified version can and will cause issues for contributors, as well as making the code far less portable.

Add testing as a CI step

Travis ( https://travis-ci.org/ ) offers free CI testing that easily integrates with GitHub projects. This project already has tests, so having them run automatically on push/PR would be a good idea.

Project written in typescript but no build step

package.json doesn't contain a build step for compiling typescript files into javascript.

Build files should be compiled into a separate directory

Compiled TypeScript files should be placed in a separate directory to the source files. Having the files side by side leads to confusion and additionally makes it harder to reduce payload size when installing via npm, as you have to download twice as many files.
Consider using travis to build and publish the project automatically ( https://docs.travis-ci.com/user/deployment/npm/ ) This means that the build files can be removed from the github repo.

Test output appears to be committed to repo

The contents of ./out appears to be entirely test output. If this is the case, the directory should be removed from git and added to .gitignore. If the ./out directory is required for tests to run, consider adding a bootstrapping step to your tests that scaffolds the necessary folder structure.

Add .editorconfig

Add a .editorconfig file to help maintain clean code styling between different IDEs and contributors. See http://editorconfig.org/ for more information.

README references missing directory

The README references a testfiles directory, but it doesn't appear to exist in the repo.

Add .npmignore file

https://docs.npmjs.com/misc/developers
Lots of files are unnecessarily downloaded when installing the package through npm. A .npmignore file should be added and used to blacklist any unnecessary files.