Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add symlinking example to README #383

Merged
merged 3 commits into from
Sep 4, 2022
Merged

docs: add symlinking example to README #383

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8e9bef
docs: add symlinking to installation
sjarva Sep 4, 2022
6e001a6
Update README.md
AriPerkkio Sep 4, 2022
1ed8141
Update README.md
AriPerkkio Sep 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ The underlying git integration is done via [simple-git](https://github.com/steve

## Configuration

### Linking your eslint plugin as a dependency
AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved

In order for `eslint-remote-tester`'s `eslint` to know where the definitions for the new rules or modified existing rules are, your eslint plugin folder needs to be symlinked.
AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved
In your plugin folder, dependending on which package manager you use, run:

```sh
# Using npm package manager
npm link
npm link [your-plugin-name]

# Or using yarn package manager
yarn link
yarn link [your-plugin-name]
```

### package.json

Add new script to your `package.json` file.
Expand Down