aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Arthur Huan <c.arthurh@outlook.com>2023-10-17 16:54:39 -0600
committerLibravatar GitHub <noreply@github.com>2023-10-17 23:54:39 +0100
commitf5e0dff47dbbd271aa1cff73a721edff7192a6c9 (patch)
treed80718976df236584e9076d1924a25dfcc91c66a
parentEnsure that links are opened according to the user's preference (#417) (diff)
downloadferdium-recipes-f5e0dff47dbbd271aa1cff73a721edff7192a6c9.tar.gz
ferdium-recipes-f5e0dff47dbbd271aa1cff73a721edff7192a6c9.tar.zst
ferdium-recipes-f5e0dff47dbbd271aa1cff73a721edff7192a6c9.zip
Make the validation checks more noticeable (#437)
* Update README.md Put the validation checks in a more noticeable place. * Required changes fix --------- Co-authored-by: AndreĢ Oliveira <oliveira.andrerodrigues95@gmail.com>
-rw-r--r--README.md4
-rw-r--r--package.json1
2 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index f412bbf..2a64793 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,9 @@
18 18
19Recipes are small scripts that are responsible for providing the connection between your services (e.g. WhatsApp, Gmail or Slack) and Ferdium. It provides Ferdium information like the number of current notifications, handles enabling dark mode and may otherwise improve your experience with the service. 19Recipes are small scripts that are responsible for providing the connection between your services (e.g. WhatsApp, Gmail or Slack) and Ferdium. It provides Ferdium information like the number of current notifications, handles enabling dark mode and may otherwise improve your experience with the service.
20 20
21## Creating and adding your own recipes 21## Creating, adding, and editing recipes
22
23**Important:** Please make sure to run `pnpm validate` before submitting.
22 24
23* [Overview / How to create a Ferdium integration](docs/integration.md) 25* [Overview / How to create a Ferdium integration](docs/integration.md)
24* [How to update/change recipes](docs/updating.md) 26* [How to update/change recipes](docs/updating.md)
diff --git a/package.json b/package.json
index 80b1a81..1c41c07 100644
--- a/package.json
+++ b/package.json
@@ -17,6 +17,7 @@
17 "scripts": { 17 "scripts": {
18 "preinstall": "npx only-allow pnpm", 18 "preinstall": "npx only-allow pnpm",
19 "prepare": "is-ci || husky install", 19 "prepare": "is-ci || husky install",
20 "validate": "pnpm lint:fix && pnpm reformat-files && pnpm package",
20 "package": "node scripts/package.js", 21 "package": "node scripts/package.js",
21 "create": "node scripts/create.js", 22 "create": "node scripts/create.js",
22 "lint": "eslint \"{recipes,scripts}/**/*.{js,jsx,ts,tsx}\"", 23 "lint": "eslint \"{recipes,scripts}/**/*.{js,jsx,ts,tsx}\"",