Skip to content

Commit

Permalink
Add the alex tool to check insensitive words in our documentation (PR #…
Browse files Browse the repository at this point in the history
…2004)

This also adds the alex check to the CI and the prepush hook.

Fixes #1015.
  • Loading branch information
sam-clulow authored and julienw committed May 17, 2019
1 parent 4813071 commit a15e007
Show file tree
Hide file tree
Showing 7 changed files with 663 additions and 13 deletions.
4 changes: 4 additions & 0 deletions .alexrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"allow": ["hostesses-hosts", "host-hostess", "special", "savage"],
"profanitySureness": 2
}
1 change: 1 addition & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
- node_modules
key: v1-dependencies-{{ checksum "package.json" }}-{{ checksum "yarn.lock" }}
- run: yarn license-check
- run: yarn test-alex
- run: yarn lint
- run: yarn flow --quiet
- run: yarn flow-stop # stop flow to recover some memory
Expand Down
1 change: 1 addition & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ test_script:
- yarn versions
# run tests
- yarn license-check
- yarn test-alex
- yarn lint
- yarn flow --quiet
# stop flow to recover some memory
Expand Down
2 changes: 1 addition & 1 deletion docs-user/guide-remote-profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ At the moment, Firefox Nightly Desktop doesn't support symbolicating profiles th
* Avoid opening any other panels besides the Performance panel, to reduce the overhead of activated panels.
* After connecting to the device, do not select *Main Process* or any of the open tabs from the list of targets on the left.
* If WebIDE automatically reconnects to a debugging target from a previous session, disconnect, uncheck the two checkboxes in the WebIDE preferences (*Project* > *Preferences*) and reconnect to the device.
* If the recording doesn't start after clicking the start button, or if the button is disabled or in an otherwise confused state, it might be necessary to close and restart WebIDE to reset some internal state.
* If the recording doesn't start after clicking the start button, or if the button is inactive or in an otherwise confused state, it might be necessary to close and restart WebIDE to reset some internal state.
2 changes: 1 addition & 1 deletion docs-user/guide-ui-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Clicking and dragging in the timeline creates a new range selection. The selecti

## The committed range selections

![A screenshot highlighting the commit ranges int he top toolbar](images/ui-tour-ranges.jpg)
![A screenshot highlighting the commit ranges in the top toolbar](images/ui-tour-ranges.jpg)

Committing a range selection by clicking the zoom button is a useful way to zoom in on a useful selection. It can be helpful to commit several ranges to hone in on specific parts of a profile.

Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,11 @@
"start-docs": "docsify serve ./docs-user",
"start-photon": "node res/photon/server",
"test": "cross-env LC_ALL=C NODE_ENV=test NODE_OPTIONS=--experimental-worker jest",
"test-all": "run-p flow license-check lint test",
"test-all": "run-p flow license-check lint test test-alex",
"test-build-coverage": "jest --coverage --coverageReporters=html",
"test-serve-coverage": "ws -d coverage/ -p 4343",
"test-coverage": "run-s test-build-coverage test-serve-coverage"
"test-coverage": "run-s test-build-coverage test-serve-coverage",
"test-alex": "alex ./docs-* *.md"
},
"author": "Markus Stange <[email protected]>",
"license": "MPL-2.0",
Expand Down Expand Up @@ -89,6 +90,7 @@
"@babel/preset-env": "7.3.4",
"@babel/preset-flow": "7.0.0",
"@babel/preset-react": "7.0.0",
"alex": "^7.1.0",
"babel-eslint": "^10.0.1",
"babel-jest": "^24.3.1",
"babel-loader": "^8.0.5",
Expand Down
Loading

0 comments on commit a15e007

Please sign in to comment.