Merge pull request #35 from hlqviet/feat/npm-scripts

Add npm scripts for convenience

auto_update_github_action.yml

@@ -33,20 +33,18 @@ jobs:
       - name: Install npm dependencies
         run: npm ci
 
-      - name: Download recommended whitelist
+      - name: Download allowlists
-        run: bash ./get_recommended_whitelist.sh
+        run: npm run download:allowlist
         env:
           ALLOWLIST_URLS: ${{ vars.ALLOWLIST_URLS }}
 
-      - name: Download recommended filters
+      - name: Download blocklists
-        run: bash ./get_recommended_filters.sh
+        run: npm run download:blocklist
         env:
           BLOCKLIST_URLS: ${{ vars.BLOCKLIST_URLS }}
 
       - name: Delete old rules and lists
-        run: |
+        run: npm run cloudflare-delete
-          node cf_gateway_rule_delete.js
-          node cf_list_delete.js
         env:
           CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
           CLOUDFLARE_ACCOUNT_EMAIL: ${{ secrets.CLOUDFLARE_ACCOUNT_EMAIL }}
@@ -55,9 +53,7 @@ jobs:
           FAST_MODE: ${{ vars.FAST_MODE }}
 
       - name: Create new rules and lists
-        run: |
+        run: npm run cloudflare-create
-          node cf_list_create.js
-          node cf_gateway_rule_create.js
         env:
           CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
           CLOUDFLARE_ACCOUNT_EMAIL: ${{ secrets.CLOUDFLARE_ACCOUNT_EMAIL }}

cf_list_create.js

@@ -125,9 +125,7 @@ console.log(`Number of unnecessary domains: ${unnecessaryDomainCount}`);
 console.log(`Number of blocked domains: ${domains.length}`);
 console.log(`Number of allowed domains: ${allowedDomainCount}`);
 console.log(
-  `Number of lists which will be created: ${Math.ceil(
+  `Number of lists to be created: ${Math.ceil(domains.length / LIST_ITEM_SIZE)}`
-    domains.length / LIST_ITEM_SIZE
-  )}`
 );
 console.log("\n\n");
 

download_lists.js

@@ -1,3 +1,5 @@
+import { existsSync } from "fs";
+import { unlink } from "fs/promises";
 import { resolve } from "path";
 
 import {
@@ -15,16 +17,28 @@ const blocklistUrls = USER_DEFINED_BLOCKLIST_URLS || RECOMMENDED_BLOCKLIST_URLS;
 const listType = process.argv[2];
 
 const downloadLists = async (filename, urls) => {
-  await downloadFiles(resolve(`./${filename}`), urls);
+  const filePath = resolve(`./${filename}`);
-  console.log(
+
-    `Done. The ${filename} file contains merged data from the following list(s):`
+  if (existsSync(filePath)) {
-  );
+    await unlink(filePath);
-  console.log(
+  }
-    urls.reduce(
+
-      (previous, current, index) => previous + `${index + 1}. ${current}\n`,
+  try {
-      ""
+    await downloadFiles(filePath, urls);
-    )
+
-  );
+    console.log(
+      `Done. The ${filename} file contains merged data from the following list(s):`
+    );
+    console.log(
+      urls.reduce(
+        (previous, current, index) => previous + `${index + 1}. ${current}\n`,
+        ""
+      )
+    );
+  } catch (err) {
+    console.error(`An error occurred while processing ${filename}:\n`, err);
+    console.error("URLs:\n", urls);
+  }
 };
 
 switch (listType) {

lib/helpers.js

@@ -20,6 +20,12 @@ if (!globalThis.fetch) {
  * @returns {Promise}
  */
 const request = async (url, options) => {
+  if (!API_TOKEN || !ACCOUNT_ID || !ACCOUNT_EMAIL) {
+    throw new Error(
+      "One or more required secrets have not been added: CLOUDFLARE_API_KEY, CLOUDFLARE_ACCOUNT_ID, and CLOUDFLARE_ACCOUNT_EMAIL"
+    );
+  }
+
   const response = await fetch(url, {
     headers: {
       Authorization: `Bearer ${API_TOKEN}`,

package.json

@@ -1,4 +1,17 @@
 {
+  "scripts": {
+    "start": "npm run download && npm run cloudflare-delete && npm run cloudflare-create",
+    "dry": "npm run download && DRY_RUN=1 npm run cloudflare-create:list",
+    "download": "node download_lists.js",
+    "download:allowlist": "node download_lists.js allowlist",
+    "download:blocklist": "node download_lists.js blocklist",
+    "cloudflare-create": "npm run cloudflare-create:list && npm run cloudflare-create:rule",
+    "cloudflare-delete": "npm run cloudflare-delete:rule && npm run cloudflare-delete:list",
+    "cloudflare-create:rule": "node cf_gateway_rule_create.js",
+    "cloudflare-create:list": "node cf_list_create.js",
+    "cloudflare-delete:rule": "node cf_gateway_rule_delete.js",
+    "cloudflare-delete:list": "node cf_list_delete.js"
+  },
   "type": "module",
   "dependencies": {
     "dotenv": "^16.0.3",