Skip to content

Commit 1dcafb3

Browse files
authored
Upgrade tooling (#75)
* Clean * Clean * Remove standard * Remove useless dev script * Clean output * Update tooling stack * Add prettier * Add travis * Fix travis config * Finish migrating from jasmine to jest * Add ESLint * Update doc
1 parent 2cf76ef commit 1dcafb3

40 files changed

+11212
-2691
lines changed

.babelrc

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"presets": [
3+
[
4+
"@babel/preset-env",
5+
{
6+
"targets": {
7+
"node": "current"
8+
}
9+
}
10+
]
11+
]
12+
}

.editorconfig

-13
This file was deleted.

.eslintrc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": ["airbnb-base", "prettier"],
3+
"plugins": ["jest", "prettier"],
4+
"env": {
5+
"jest/globals": true
6+
}
7+
}

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
node_modules/
2-
.idea
2+
dist

CONTRIBUTING.md

+8-20
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,19 @@
1-
# Setup
1+
# Installation
22

3-
Fork the repository, clone it then:
3+
1. `npm install`
44

5-
1. `cd TheaterJS`
6-
2. `npm install`
5+
## Scripts
76

8-
# Tasks
7+
- `lint`: lint the files.
8+
- `test`: run the tests.
9+
- `build`: transpile the files to ES5.
910

10-
TheaterJS' build workflow is based on npm scripts and webpack:
11-
12-
* `npm run build` - build the dist version of TheaterJS.
13-
* `npm run dev` - watch for changes and build the dist version when needed.
14-
* `npm run lint` - lint js files using [standard](http://standardjs.com/).
15-
* `npm run test` - run the tests.
16-
17-
Note: there's a git pre-commit hook that's going to run the tests when using `git commit`.
18-
19-
# Adding a keyboard
11+
## Adding a keyboard
2012

2113
The keyboards are implemented in `src/keyboards.json`.
2214
A mapped keyboard is just a list of characters, ordered after their "physical" equivalent.
2315
So for example, the english keyboard (aka `qwerty`) looks like this:
2416

2517
```javascript
26-
[
27-
"qwertyuiop",
28-
"asdfghjkl",
29-
"zxcvbnm"
30-
]
18+
["qwertyuiop", "asdfghjkl", "zxcvbnm"];
3119
```

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015-2016 Gabin Aureche <hello@gabinaureche.com>
3+
Copyright (c) 2015-present Gabin Aureche <hello@gabinaureche.com>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)