Skip to content

Commit 2af299b

Browse files
committed
Adding README, revving version
1 parent 6bf9479 commit 2af299b

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# `eslint-plugin-pipedream`
2+
3+
This ESLint plugin implements rules that validate the [Pipedream component guidelines](https://pipedream.com/docs/components/guidelines/#guidelines-patterns). Only a subset of the guidelines are mapped to rules: those that can be statically-analyzed.
4+
5+
Learn more about Pipedream at [https://pipedream.com/docs](https://pipedream.com/docs), and read more about Pipedream components in [the component API docs](https://pipedream.com/docs/components/api/).
6+
7+
We will gladly accept issues and PRs in this repo.
8+
9+
## Installation
10+
11+
In the repo where you manage Pipedream components, run:
12+
13+
```bash
14+
npm install eslint-plugin-pipedream --save-dev
15+
```
16+
17+
Then add the Pipedream plugin to the `plugins` section of your [ESLint config file](https://eslint.org/docs/user-guide/configuring/):
18+
19+
```javascript
20+
"plugins": [
21+
"pipedream"
22+
],
23+
```
24+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-pipedream",
3-
"version": "0.0.4",
3+
"version": "0.0.5",
44
"description": "ESLint plugin for Pipedream components: https://pipedream.com/docs/components/api/",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)