overall qol changes, added workflows, manifest control and linting

.eslintrc.cjs

@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+    es2021: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  overrides: [
+    {
+      files: ['.eslintrc.{js,cjs}'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2021,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  ignorePatterns: ['node_modules/', 'github-repo-size-extension/'],
+  rules: {},
+};

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Extension Build CI
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: |
+          bun install
+
+      - name: Build extension
+        run: |
+          bun run build

.github/workflows/format.yml

@@ -0,0 +1,27 @@
+name: Extension Format CI
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+    branches: [main]
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: |
+          bun install
+
+      - name: Check code formatting
+        run: bun run checkFormat

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Extension Lint CI
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Check code linting
+        run: bun run lint

.prettierignore

@@ -0,0 +1,5 @@
+dist
+node_modules/
+package-lock.json
+pnpm-lock.yaml
+bun.lockb

README.md

@@ -40,6 +40,7 @@ You can use Bun to quickly initialize a new project:
 ```bash
 bun create catonaut [AppName]
 ```
+
 OR
 
 ```bash
@@ -52,10 +53,10 @@ For more information, refer to [create-catonaut](https://github.com/AminoffZ/cre
 
 ![image](https://github.com/AminoffZ/catonaut/assets/55880031/261b38a7-09d5-417a-a908-807c29bf37fb)
 
-Use the template or clone the project, navigate into the project folder and run:
+Use the template, clone the project or use the create-catonaut command, navigate into the project folder and run:
 
 ```bash
-bun i
+bun install
 ```
 
 ### The manifest
@@ -174,6 +175,14 @@ To build the extension, run:
 bun run build
 ```
 
+Or
+
+```bash
+bun run build:firefox
+```
+
+This will build the extension in the dist folder.
+
 ## 🏗️ Project structure
 
 <pre>
@@ -224,6 +233,15 @@ To format with the provided configuration, run:
 bun run format
 ```
 
+## 👕 Linting
+
+There's an .eslintrc.cjs for the linting configuration.
+To lint with the provided configuration, run:
+
+```bash
+bun run lint
+```
+
 ## LICENSE
 
 Catonaut is under [MIT License](https://github.com/AminoffZ/catonaut/blob/main/LICENSE).

build-tools/create-icons.ts

@@ -14,15 +14,15 @@ const filename = 'example.png';
  * Sizes: 16, 32, 48, 128
  */
 function createIcons() {
-  for (let size of [16, 32, 48, 128]) {
+  for (const size of [16, 32, 48, 128]) {
     imagemagick.resize(
       {
         srcPath: `${root}${filename}`,
         dstPath: `${root}icon${size}.png`,
         width: size,
         height: size,
       },
-      (err, res) => {
+      (err /* ,res */) => {
         if (err) throw err;
       }
     );

build-tools/extract-inline.ts

@@ -1,6 +1,6 @@
 /* The purpose of this file is to remove inline scripts
  * and styles from the HTML files generated by Astro.
- * For more information, see: 
+ * For more information, see:
  * https://github.com/withastro/roadmap/discussions/377
  */
 

build-tools/hash.ts

@@ -1,4 +1,4 @@
-/* This file is used to generate unique hashes for the 
+/* This file is used to generate unique hashes for the
  * extracted inline scripts and styles.
  * 🤓 will 😂
  */

package.json

@@ -2,29 +2,37 @@
   "name": "catonaut",
   "module": "bundler.ts",
   "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "bun run manifest && astro build && cd build-tools && bun run csp && bun bundler.ts",
+    "build:firefox": "bun run manifest firefox && astro build && cd build-tools && bun run csp && bun bundler.ts firefox",
+    "preview": "astro preview",
+    "astro": "astro",
+    "csp": "bun -b extract-inline.ts",
+    "icons": "cd build-tools && bun create-icons.ts",
+    "manifest": "bun -b updateManifest.ts",
+    "format": "prettier --write .",
+    "check": "prettier --check .",
+    "lint": "eslint ."
+  },
   "dependencies": {
     "astro": "^3.2.1"
   },
   "devDependencies": {
     "@types/chrome": "^0.0.246",
     "@types/imagemagick": "^0.0.33",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
+    "@typescript-eslint/parser": "^7.3.1",
     "bun-types": "latest",
+    "chalk": "4.1.2",
+    "eslint": "^8.57.0",
     "imagemagick": "^0.1.3",
     "prettier": "^3.0.3",
     "tiny-glob": "^0.2.9"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
-  },
-  "scripts": {
-    "dev": "astro dev",
-    "start": "astro dev",
-    "build": "astro build && cd build-tools && bun run csp && bun bundler.ts",
-    "preview": "astro preview",
-    "astro": "astro",
-    "format": "prettier --write '**/*.{js,jsx,ts,tsx,json,md}' '!build/**' '!node_modules/**'",
-    "csp": "bun extract-inline.ts",
-    "icons": "cd build-tools && bun create-icons.ts"
-  },
-  "type": "module"
+  }
 }

updateManifest.ts

@@ -0,0 +1,50 @@
+import { join } from 'path';
+import { readFile, writeFile } from 'fs/promises';
+import chalk from 'chalk';
+
+export async function updateManifest() {
+  try {
+    const arg = process.argv[2];
+    const browser = arg && arg === 'firefox' ? 'firefox' : 'chrome';
+
+    const packageJsonPath = join(import.meta.dir, 'package.json');
+    const { version } = await import(packageJsonPath);
+
+    const manifestPath = join(import.meta.dir, 'public', 'manifest.json');
+    const manifestData = await readFile(manifestPath, 'utf-8');
+    const manifest = JSON.parse(manifestData);
+
+    manifest.version = version;
+
+    if (browser && browser === 'firefox') {
+      manifest.background = {
+        scripts: ['background.js'],
+      };
+
+      manifest.browser_specific_settings = {
+        gecko: {
+          id: 'github-repo-size@gmail.com',
+          strict_min_version: '42.0',
+        },
+      };
+    } else {
+      manifest.background = {
+        service_worker: 'background.js',
+      };
+      delete manifest.browser_specific_settings;
+    }
+    await writeFile(manifestPath, JSON.stringify(manifest, null, 2));
+
+    console.log(
+      chalk.green(
+        'Version updated successfully in manifest.json for ' +
+          browser +
+          ' Browser!'
+      )
+    );
+  } catch (error) {
+    console.error(chalk.red('Error updating version: ' + error));
+    process.exit(1);
+  }
+}
+updateManifest();