Skip to content

Commit ea6d399

Browse files
committed
Update documentation.
1 parent ae4416e commit ea6d399

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

doc/development.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ npm test
4141

4242
### Coding guidelines
4343

44-
jshint
44+
ESLint
4545

46-
Uses provided .jshintrc flag file. To check source code style, type
46+
Uses the provided `.eslintrc.json` flag file. To check source code style, type
4747

4848
```bash
4949
npm run lint
@@ -97,9 +97,36 @@ npm run lint:md
9797

9898
### Documentation Spell-checking
9999

100-
Checks the markdown documentation for spelling and grammar errors, dead links & etc.
100+
Uses the provided `.textlintrc` flag file. To check the markdown documentation for spelling and grammar errors, dead links & etc.
101101

102102
```bash
103103
# Use git-bash on Windows
104104
npm run lint:text
105105
```
106+
107+
### Clean
108+
109+
Removes `node_modules` and `coverage` folders, and `package-lock.json` file so that a fresh copy of the project is
110+
restored.
111+
112+
```bash
113+
# Use git-bash on Windows
114+
npm run clean
115+
```
116+
117+
### Prettify Code
118+
119+
Runs the [prettier](https://prettier.io) code formatter to ensure consistent code style (whitespacing, parameter
120+
placement and breakup of long lines etc.) within the codebase.
121+
122+
```bash
123+
# Use git-bash on Windows
124+
npm run prettier
125+
```
126+
127+
To ensure consistent Markdown formatting run the following:
128+
129+
```bash
130+
# Use git-bash on Windows
131+
npm run prettier:text
132+
```

0 commit comments

Comments
 (0)