Hentai Library Thingy
Go to file
Xymorot 423df953fb config: add build script to pre-commit script to test for typescript errors 2019-11-20 23:21:35 +01:00
declarations test: add test framework (spectron + mocha), combined with refactoring of the directory structures 2019-11-20 23:21:24 +01:00
mocks feat: install and use fs-extra instead of fs, implement groundwork for more sophisticated error reporting 2019-11-20 23:21:34 +01:00
resources feat: add icon/logo 2019-07-26 22:18:56 +02:00
src update: run npm update 2019-11-20 23:21:35 +01:00
templates refactor: use handlebars template engine to render the index html conditionally 2019-11-20 23:21:33 +01:00
tests fix: fix typescript errors (coming from update) 2019-11-20 23:21:35 +01:00
.editorconfig install tslint and prettier with stuff around to make them work together 2019-06-04 22:54:56 +02:00
.eslintignore test: add simple unit test with sinon and nock, also refactor 'test' directory to 'tests', split tests into integration and unit 2019-11-20 23:21:27 +01:00
.eslintrc.json config: add rules to eslint concerning arrow functions 2019-11-20 23:21:32 +01:00
.gitignore feat: install and use fs-extra instead of fs, implement groundwork for more sophisticated error reporting 2019-11-20 23:21:34 +01:00
.mocharc.yml test: remove split between integration and unit tests, use tags instead 2019-11-20 23:21:27 +01:00
.nycrc.yml config: turn off per-file coverage checking in nyc 2019-11-20 23:21:34 +01:00
.prettierrc.yml refactor: use handlebars template engine to render the index html conditionally 2019-11-20 23:21:33 +01:00
README.md doc: put update commit type above test commit type 2019-11-20 23:21:35 +01:00
forge.config.js feat: install and use fs-extra instead of fs, implement groundwork for more sophisticated error reporting 2019-11-20 23:21:34 +01:00
gulpfile.js refactor: use handlebars template engine to render the index html conditionally 2019-11-20 23:21:33 +01:00
ormconfig.yml test: add test framework (spectron + mocha), combined with refactoring of the directory structures 2019-11-20 23:21:24 +01:00
package-lock.json update: run npm update 2019-11-20 23:21:35 +01:00
package.json config: add build script to pre-commit script to test for typescript errors 2019-11-20 23:21:35 +01:00
tsconfig.json feat: install and use fs-extra instead of fs, implement groundwork for more sophisticated error reporting 2019-11-20 23:21:34 +01:00
tslint.json config: add only-arrow-functions rule to tslint 2019-11-20 23:21:33 +01:00
webpack.config.js test: add test framework (spectron + mocha), combined with refactoring of the directory structures 2019-11-20 23:21:24 +01:00

README.md

Renai

レンアイ - Hentai Library Thingy

Development

Quickstart

  • npm install, the postinstall runs
    • npm run rebuild
      • might need to install some build tools depending on your platform
  • npm run watch for code transpilation (starts watchers)
  • npm run start

Git Commits

This project uses Conventional Commits with the following types:

  • feat: features, if any part of your commit implements a new functionality or changes an existing one, use this
  • remove: removal of existing code/functionality
  • fix: bugfixes
  • refactor: code refactoring
  • update: updating dependencies and associated code changes
  • test: any of the above, but with tests/mocks
  • config: changing configuration (linters, build process)
  • doc: documentation, including comments
  • reformat: fixing code formatting

Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list.

Database Migrations

Migrations are stored in src/main/migrations and handled by typeorm. Migrations are run on app start inside database.ts.

To auto-generate a migration:
node_modules/.bin/typeorm migration:generate -n <migration name> -c <connection name>

To create an empty creation which can be filled with custom migration code:
node_modules/.bin/typeorm migration:create -n <migration name> -c <connection name>

To run migrations:
node_modules/.bin/typeorm migration:run -c <connection name>
This is also pre-defined in the npm script typeorm:migrate.

Testing

The testing framework of choice is Mocha. Call npm run test to run all tests. Tests are written in typescript and need to be transpiled before testing.

  • assertion is (mainly) done by Chai
  • Electron specific testing is done by Spectron
  • spies, stubs and mocks are provided by Sinon.JS
  • HTTP server mocking is done by nock
  • property based testing is made possible by fast-check

Mocks

There are 2 ways in which mocks are defined/used:

  1. for external modules, in mocks, uses the rewiremock package; use this only when there is some magic happening like for electron which normally runs in its own node process
  2. for own modules, just beside their test file in tests; name the file *.mock.ts and use other files for orientation; use sparingly and only when not having a mock makes it more complex e.g. for modules which interact with the file system

Tagging

Mocha does not have a seperate tagging feature, but it can filter via title. Us the following tags in your test titles:

  • @slow when the test is particularly slow

Coverage

Code coverage is provided by nyc. The detailed code coverage can be found here after running the tests (open in browser).