generated from n8n-io/n8n-nodes-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
7,870 additions
and
13,533 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/** | ||
* @type {import('@types/eslint').ESLint.ConfigData} | ||
*/ | ||
module.exports = { | ||
root: true, | ||
env: { | ||
browser: true, | ||
es6: true, | ||
node: true, | ||
}, | ||
ignorePatterns: ["node_modules/", "dist/"], | ||
parser: "@typescript-eslint/parser", | ||
plugins: ["@typescript-eslint/eslint-plugin"], | ||
extends: [ | ||
"plugin:@typescript-eslint/recommended", | ||
"prettier", | ||
"plugin:prettier/recommended", | ||
"plugin:import/errors", | ||
"plugin:import/warnings", | ||
"plugin:import/typescript", | ||
], | ||
rules: { | ||
"prettier/prettier": ["error", { singleQuote: false }], | ||
"@typescript-eslint/no-explicit-any": "off", | ||
"@typescript-eslint/no-unused-vars": ["error", { ignoreRestSiblings: true }], | ||
semi: ["error", "always"], | ||
quotes: [2, "double", "avoid-escape"], | ||
"comma-dangle": ["error", "always-multiline"], | ||
"eol-last": ["error", "always"], | ||
"import/order": [ | ||
"error", | ||
{ | ||
"newlines-between": "always", | ||
alphabetize: { | ||
order: "asc", | ||
}, | ||
}, | ||
], | ||
}, | ||
settings: { | ||
"import/resolver": { | ||
typescript: {}, | ||
}, | ||
}, | ||
overrides: [ | ||
{ | ||
files: ["package.json"], | ||
plugins: ["eslint-plugin-n8n-nodes-base"], | ||
extends: ["plugin:n8n-nodes-base/community"], | ||
rules: { | ||
"n8n-nodes-base/community-package-json-name-still-default": "off", | ||
}, | ||
}, | ||
{ | ||
files: ["./src/**/*.ts"], | ||
plugins: ["eslint-plugin-n8n-nodes-base"], | ||
extends: ["plugin:n8n-nodes-base/nodes"], | ||
rules: { | ||
"n8n-nodes-base/node-execute-block-missing-continue-on-fail": "off", | ||
"n8n-nodes-base/node-resource-description-filename-against-convention": "off", | ||
"n8n-nodes-base/node-param-fixed-collection-type-unsorted-items": "off", | ||
}, | ||
}, | ||
], | ||
}; |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,146 @@ | ||
node_modules | ||
.DS_Store | ||
.tmp | ||
tmp | ||
dist | ||
# Created by https://www.toptal.com/developers/gitignore/api/node | ||
# Edit at https://www.toptal.com/developers/gitignore?templates=node | ||
|
||
### Node ### | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn.lock | ||
.vscode/launch.json | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
### Node Patch ### | ||
# Serverless Webpack directories | ||
.webpack/ | ||
|
||
# Optional stylelint cache | ||
|
||
# SvelteKit build / generate output | ||
.svelte-kit | ||
|
||
# End of https://www.toptal.com/developers/gitignore/api/node | ||
|
||
ormconfig.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"$schema": "https://json.schemastore.org/swcrc", | ||
"jsc": { | ||
"parser": { | ||
"syntax": "typescript" | ||
}, | ||
"target": "es2020" | ||
}, | ||
"module": { | ||
"type": "commonjs", | ||
"strict": true | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,48 @@ | ||
![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png) | ||
# n8n-nodes-_node-name_ | ||
|
||
# n8n-nodes-starter | ||
This is an n8n community node. It lets you use _app/service name_ in your n8n workflows. | ||
|
||
This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies. | ||
_App/service name_ is _one or two sentences describing the service this node integrates with_. | ||
|
||
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry). | ||
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. | ||
|
||
## Prerequisites | ||
[Installation](#installation) | ||
[Operations](#operations) | ||
[Credentials](#credentials) <!-- delete if no auth needed --> | ||
[Compatibility](#compatibility) | ||
[Usage](#usage) <!-- delete if not using this section --> | ||
[Resources](#resources) | ||
[Version history](#version-history) <!-- delete if not using this section --> | ||
|
||
You need the following installed on your development machine: | ||
## Installation | ||
|
||
* [git](https://git-scm.com/downloads) | ||
* Node.js and npm. Minimum version Node 16. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). | ||
* Install n8n with: | ||
``` | ||
npm install n8n -g | ||
``` | ||
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). | ||
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. | ||
|
||
## Operations | ||
|
||
## Using this starter | ||
_List the operations supported by your node._ | ||
|
||
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). | ||
## Credentials | ||
|
||
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. | ||
2. Clone your new repo: | ||
``` | ||
git clone https://github.com/<your organization>/<your-repo-name>.git | ||
``` | ||
3. Run `npm i` to install dependencies. | ||
4. Open the project in your editor. | ||
5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. | ||
6. Update the `package.json` to match your details. | ||
7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible. | ||
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance. | ||
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started. | ||
10. Update the LICENSE file to use your details. | ||
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. | ||
_If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._ | ||
|
||
## More information | ||
## Compatibility | ||
|
||
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. | ||
_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._ | ||
|
||
## Usage | ||
|
||
_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._ | ||
|
||
_By the time users are looking for community nodes, they probably already know n8n basics. But if you expect new users, you can link to the [Try it out](https://docs.n8n.io/try-it-out/) documentation to help them get started._ | ||
|
||
## Resources | ||
|
||
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) | ||
* _Link to app/service documentation._ | ||
|
||
## Version history | ||
|
||
_This is another optional section. If your node has multiple versions, include a short description of available versions and what changed, as well as any compatibility impact._ | ||
|
||
## License | ||
|
||
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) |
Oops, something went wrong.