Skip to content

Commit

Permalink
docs: change husky command
Browse files Browse the repository at this point in the history
Renamed from `stop:hooks` to `husky:stop`.
  • Loading branch information
ifiokjr committed Jun 20, 2019
1 parent 4659cea commit f6078d0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
4 changes: 2 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ Remirror by default using [husky](https://github.com/typicode/husky) for git hoo
This can be annoying when attempting proof of concept work. If you'd like to turn it off run the following command.
```bash
yarn stop:hooks
yarn husky:stop
```
This copies the `support/.config.sample.json` to `.config.json`. After this change your git commits and git pushes won't be checked for errors.
If you would like to resume per-commit and per-push checking simply run
```bash
yarn start:hooks
yarn husky:start
```
<br />
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
"fix:prettier": "prettier --write \"**/*.{json,yml,yaml,md,mdx}\"",
"fix:support": "yarn lint:support --fix",
"frozen": "yarn --frozen-lockfile install",
"husky:start": "rimraf ./.config.json",
"husky:stop": "cpy support/.config.sample.json ./ --rename=\".config.json\"",
"if-clean": "node support/scripts/run-if-clean.js",
"if-config": "node support/scripts/run-if-config.js",
"integrity": "yarn check --integrity",
Expand All @@ -52,8 +54,6 @@
"next:ci": "cd examples/with-next && yarn dev:ci",
"publish:alpha": "yarn if-clean run-s ci:checks:all lerna:publish:alpha",
"publish:minor": "yarn if-clean run-s ci:checks:all lerna:publish:minor",
"start:hooks": "rimraf ./.config.json",
"stop:hooks": "cpy support/.config.sample.json ./ --rename=\".config.json\"",
"storybook": "start-storybook -p 6006 -c support/storybook",
"storybook:ci": "start-storybook -p 3002 -c support/storybook --quiet --ci",
"test": "jest --verbose",
Expand Down
13 changes: 6 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,6 @@ const EditorLayout: FunctionComponent = () => {

The above example uses hooks but you can just as easily rely on Higher Order Components (HOC's) to wrap your component.

In a similar fashion Higher Order Components (HOC's) can be used to wrap a component.

```ts
import { withRemirror } from '@remirror/react';

Expand All @@ -159,6 +157,7 @@ export const WrappedSimpleMenu = withRemirror(SimpleMenu);

```ts
import { EpicMode, heartEffect, ParticleEffect } from '@remirror/extension-epic-mode';
import { RemirrorManager, RemirrorExtension, ManagedRemirrorProvider } from '@remirror/react';

interface EpicModeComponentProps {
particleEffect: ParticleEffect;
Expand All @@ -168,7 +167,7 @@ interface EpicModeComponentProps {

const EpicModeComponent: FC<EpicModeComponentProps> = ({ particleEffect, placeholder, shake }) => {
return (
<div style={{ gridArea: 'editor' }}>
<div>
<RemirrorManager>
<RemirrorExtension Constructor={Bold} />
<RemirrorExtension Constructor={Italic} />
Expand All @@ -186,7 +185,7 @@ const EpicModeComponent: FC<EpicModeComponentProps> = ({ particleEffect, placeho
};

export const EpicModeHeart: FunctionComponent = () => (
<EpicModeComponent particleEffect={heartEffect} shake={false} placeholder='Type for hearts' />
<EpicModeComponent particleEffect={heartEffect} shake={false} placeholder='Type for hearts...' />
);
```

Expand All @@ -206,18 +205,18 @@ From the root of this repository run the following to trigger a full typecheck,
yarn checks
```

By default these checks are run on every push. To prevent these hooks from running by default simply run:
By default these checks are run on every push. To prevent these hooks from running by default simply type:

```bash
yarn stop:hooks
yarn husky:stop
```

This copies `.config.sample.json` to `.config.json`. This file is read before hooks are run and can cancel checks when configured.

To resume per-commit / per-push checks run:

```bash
yarn start:hooks
yarn husky:start
```

## Built With
Expand Down

0 comments on commit f6078d0

Please sign in to comment.