diff options
author | Vijay A <vraravam@users.noreply.github.com> | 2022-04-23 08:25:24 -0500 |
---|---|---|
committer | Vijay A <vraravam@users.noreply.github.com> | 2022-04-23 08:25:24 -0500 |
commit | 7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4 (patch) | |
tree | 16b255f0e57af69aa5c55c9c1201b44d0c62e60c | |
parent | build: add pnpm version to package.json#engines (diff) | |
download | ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.tar.gz ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.tar.zst ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.zip |
Use 'pnpm' instead of 'pnpm run'
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE/add_recipe.md | 2 | ||||
-rw-r--r-- | .github/workflows/builds.yml | 2 | ||||
-rw-r--r-- | .gitignore | 1 | ||||
-rwxr-xr-x | .husky/pre-commit | 2 | ||||
-rw-r--r-- | docs/integration.md | 6 | ||||
-rw-r--r-- | docs/updating.md | 2 | ||||
-rw-r--r-- | scripts/create.js | 8 |
7 files changed, 11 insertions, 12 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md index 0e35310..2ed07f6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md +++ b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md | |||
@@ -22,7 +22,7 @@ Service ID: [What ID does your recipe use?] | |||
22 | <!-- Please also accept the following checkboxes --> | 22 | <!-- Please also accept the following checkboxes --> |
23 | 23 | ||
24 | - [ ] I am the original creator of this package | 24 | - [ ] I am the original creator of this package |
25 | - [ ] I have run the `pnpm run package` and verified that there are no validation errors reported for this package | 25 | - [ ] I have run the `pnpm package` and verified that there are no validation errors reported for this package |
26 | - [ ] My recipe has been tested to work inside Ferdium | 26 | - [ ] My recipe has been tested to work inside Ferdium |
27 | 27 | ||
28 | <!-- Here you can write anything else you want to tell us. --> | 28 | <!-- Here you can write anything else you want to tell us. --> |
diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 726fa85..299ed1b 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml | |||
@@ -37,4 +37,4 @@ jobs: | |||
37 | with: | 37 | with: |
38 | version: 6.32.8 | 38 | version: 6.32.8 |
39 | - name: Install node dependencies recursively | 39 | - name: Install node dependencies recursively |
40 | run: pnpm i && pnpm run package | 40 | run: pnpm i && pnpm package |
@@ -3,7 +3,6 @@ | |||
3 | node_modules | 3 | node_modules |
4 | archives/ | 4 | archives/ |
5 | yarn-error.log | 5 | yarn-error.log |
6 | npm-debug.log | ||
7 | .pnpm-debug.log | 6 | .pnpm-debug.log |
8 | server*.log | 7 | server*.log |
9 | *.png | 8 | *.png |
diff --git a/.husky/pre-commit b/.husky/pre-commit index 8c6711a..b26458b 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit | |||
@@ -1,4 +1,4 @@ | |||
1 | #!/bin/sh | 1 | #!/bin/sh |
2 | . "$(dirname "$0")/_/husky.sh" | 2 | . "$(dirname "$0")/_/husky.sh" |
3 | 3 | ||
4 | pnpm run lint && pnpm run reformat-files && pnpm run package | 4 | pnpm lint && pnpm reformat-files && pnpm package |
diff --git a/docs/integration.md b/docs/integration.md index 87ffb40..c31e767 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
@@ -45,15 +45,15 @@ pnpm i | |||
45 | 45 | ||
46 | ```Bash | 46 | ```Bash |
47 | # Make sure you are still in the repository's folder | 47 | # Make sure you are still in the repository's folder |
48 | pnpm run create "Service Name" | 48 | pnpm create "Service Name" |
49 | ``` | 49 | ``` |
50 | 50 | ||
51 | Replace `Service Name` with the name of your service, e.g. `pnpm run create "Google Hangouts"`. | 51 | Replace `Service Name` with the name of your service, e.g. `pnpm create "Google Hangouts"`. |
52 | This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdium (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe. | 52 | This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdium (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe. |
53 | 53 | ||
54 | 5. (Mandatory) Please run the following step before raising a PR: | 54 | 5. (Mandatory) Please run the following step before raising a PR: |
55 | ```Bash | 55 | ```Bash |
56 | pnpm run package | 56 | pnpm package |
57 | ``` | 57 | ``` |
58 | Fix any issues that are reported. | 58 | Fix any issues that are reported. |
59 | 59 | ||
diff --git a/docs/updating.md b/docs/updating.md index b5d35c3..3b835df 100644 --- a/docs/updating.md +++ b/docs/updating.md | |||
@@ -31,6 +31,6 @@ Ferdium uses this version to determine if it should update the local copy of the | |||
31 | 31 | ||
32 | ## 5. Running the validation checks | 32 | ## 5. Running the validation checks |
33 | 33 | ||
34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm run package` command to ensure that all validation checks are run. | 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm package` command to ensure that all validation checks are run. |
35 | 35 | ||
36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> | 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> |
diff --git a/scripts/create.js b/scripts/create.js index e143b00..4939431 100644 --- a/scripts/create.js +++ b/scripts/create.js | |||
@@ -6,13 +6,13 @@ const path = require('path'); | |||
6 | const open = require('open'); | 6 | const open = require('open'); |
7 | 7 | ||
8 | if (process.argv.length < 3) { | 8 | if (process.argv.length < 3) { |
9 | console.log(`Usage: pnpm run create <Recipe name> [Folder name] | 9 | console.log(`Usage: pnpm create <Recipe name> [Folder name] |
10 | For example: | 10 | For example: |
11 | pnpm run create WhatsApp | 11 | pnpm create WhatsApp |
12 | pnpm run create "Google Hangouts" | 12 | pnpm create "Google Hangouts" |
13 | You can set "Folder name" to "FerdiDev" to use Ferdium's development instance instead: | 13 | You can set "Folder name" to "FerdiDev" to use Ferdium's development instance instead: |
14 | 14 | ||
15 | pnpm run create WhatsApp FerdiDev | 15 | pnpm create WhatsApp FerdiDev |
16 | `); | 16 | `); |
17 | throw new Error('Please provide the correct number of args!'); | 17 | throw new Error('Please provide the correct number of args!'); |
18 | } | 18 | } |