https://github.com/pipedreamhq/eslint-plugin-pipedream
ESLint plugin for Pipedream components: https://pipedream.com/docs/components/api/
https://github.com/pipedreamhq/eslint-plugin-pipedream
Last synced: 6 months ago
JSON representation
ESLint plugin for Pipedream components: https://pipedream.com/docs/components/api/
- Host: GitHub
- URL: https://github.com/pipedreamhq/eslint-plugin-pipedream
- Owner: PipedreamHQ
- Created: 2021-08-25T05:36:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-25T19:17:52.000Z (7 months ago)
- Last Synced: 2025-06-25T19:37:44.006Z (7 months ago)
- Language: JavaScript
- Size: 477 KB
- Stars: 3
- Watchers: 9
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-plugin-pipedream
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.
For example, all components should have a `name`:
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/).
We will gladly accept issues and PRs in this repo.
## Installation
In the repo where you manage Pipedream components, run:
```bash
npm install @pipedream/eslint-plugin-pipedream --save-dev
```
Then add the Pipedream plugin to the `plugins` section of your [ESLint config file](https://eslint.org/docs/user-guide/configuring/):
```javascript
"plugins": [
"pipedream"
],
```
## Developing the plugin
When you're contributing to this plugin, first install dependencies:
```bash
npm i
```
You can run tests with:
```bash
npm run test
```
All rules are exported from `index.js`. Tests can be found in the `tests` directory. Each new rule should have associated tests.
If this is your first time creating ESLint rules, see these helpful resouces:
* [ESLint Developer Guide](https://eslint.org/docs/developer-guide/)
* [AST Explorer](https://astexplorer.net/). Useful for examining the AST of any code snippet.
* [How To Write Your First ESLint Plugin](https://dev.to/spukas/how-to-write-your-first-eslint-plugin-145)