Install Prettier

merge-requests/31/head
Sebastian Delmont 2020-10-31 09:56:50 -04:00
rodzic 9d156c0b34
commit 7bf506ab90
6 zmienionych plików z 68 dodań i 5 usunięć

1
.gitignore vendored
Wyświetl plik

@ -8,3 +8,4 @@ debian/*-stamp
debian/*.substvars
debian/tmp
.DS_Store
node_modules

10
.prettierignore 100644
Wyświetl plik

@ -0,0 +1,10 @@
node_modules/
macos/
debian/
build/
package.nw/lib/ol.js
package.nw/lib/moment-with-locales.js
package.nw/lib/moment-timezone-with-data.js
package.nw/lib/datepicker.js
package.nw/lib/third-party.js

11
.prettierrc.json 100644
Wyświetl plik

@ -0,0 +1,11 @@
{
"printWidth": 80,
"overrides": [
{
"files": ["*.html"],
"options": {
"printWidth": 120
}
}
]
}

Wyświetl plik

@ -2,12 +2,29 @@
# Developing GridTracker
GridTracker runs using [NWJS](https://nwjs.io/), a tools that wraps both Chrome windows and node processes into a native application.
GridTracker runs using [NWJS](https://nwjs.io/), a tools that wraps both Chrome windows and node processes into
a native application.
To work on GridTracker you need to clone this git repository and then invoke NWJS with the contents of `package.nw`.
NWJS comes in two flavors, "normal" and "sdk". GridTracker is distributed with the normal flavor, but for development work
we recommend the SDK flavor because it provides access to Chrome's Developer Tools, among other things.
NWJS comes in two flavors, "normal" and "sdk". GridTracker is distributed with the normal flavor,
but for development work we recommend the SDK flavor because it provides access to Chrome's Developer Tools,
among other things.
### Code Formatting
We use `prettier` to enforce code formatting rules, and we follow
the [JavaScript Standard Style](https://standardjs.com/)
You can use all kinds of plugins and configurations in your text editor to verify these rules, and even reformat code
automatically, but if you want to run on the command line, you can (after running `npm install`) run the
`npm run prettier-check` command to verify the formatting of all files, or `npm run prettier-write` to reformat
all files to match the standard.
If you want to know more about why these tools are useful,
[watch this talk](https://www.youtube.com/watch?v=kuHfMw8j4xk)
# Developer Environment Setup
## Developing on Windows
@ -19,7 +36,7 @@ To access the Developer Tools, right-click on an unused area of a window, or pre
## Developing on Mac
We suggest using the `macos/run.sh` script to launch GridTracker while developing. It will download the sdk flavor of NWJS if needed,
and use it to run the app.
We suggest using the `macos/run.sh` script to launch GridTracker while developing. It will download the sdk flavor
of NWJS if needed, and use it to run the app.
To access the Developer Tools, right-click on an unused area of a window, or press F12.

13
package-lock.json wygenerowano 100644
Wyświetl plik

@ -0,0 +1,13 @@
{
"name": "gridtracker-development",
"requires": true,
"lockfileVersion": 1,
"dependencies": {
"prettier": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.1.2.tgz",
"integrity": "sha512-16c7K+x4qVlJg9rEbXl7HEGmQyZlG4R9AgP+oHKRMsMsuk8s+ATStlf1NpDqyBI1HpVyfjLOeMhH2LvuNvV5Vg==",
"dev": true
}
}
}

11
package.json 100644
Wyświetl plik

@ -0,0 +1,11 @@
{
"name": "gridtracker-development",
"devDependencies": {
"prettier": "2.1.2"
},
"scripts": {
"test": "npm run prettier-check",
"prettier-check": "npx prettier --check package.nw",
"prettier-write": "npx prettier --write package.nw"
}
}