feat: tinyjobs package init + example app

apps/example/.gitignore

@@ -0,0 +1,175 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# 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/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# 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.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

apps/example/README.md

@@ -0,0 +1,15 @@
+# @tinyjobs/example
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run src/index.ts
+```
+
+This project was created using `bun init` in bun v1.1.26. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

apps/example/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@tinyjobs/example",
+  "module": "src/index.ts",
+  "type": "module",
+  "scripts": {
+    "dev": "bun src/index.ts --watch"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "tinyjobs": "*"
+  }
+}

apps/example/src/index.ts

@@ -0,0 +1,11 @@
+import TinyJob from "tinyjobs";
+import type TinyJobsTypes from "./jobs/jobs.types";
+
+const JobHandler = new TinyJob<TinyJobsTypes>();
+JobHandler.loadJobs();
+
+const runExample = await JobHandler.queueJob("ExampleJob", {
+  name: "World",
+});
+
+console.log("ExampleJob queued:", runExample.id);

apps/example/src/jobs/ExampleJob.ts

@@ -0,0 +1,12 @@
+import { Job } from "tinyjobs";
+
+export default class ExampleJob extends Job {
+  constructor() {
+    super();
+    this.name = "ExampleJob";
+  }
+
+  async run({ name }: { name: string }) {
+    console.log(`Hello from ExampleJob ${name}!`);
+  }
+}

apps/example/src/jobs/jobs.types.d.ts

@@ -0,0 +1,8 @@
+
+interface ExampleJobParams { name: string };
+
+type TinyJobsTypes = {
+  'ExampleJob': ExampleJobParams
+};
+
+export default TinyJobsTypes;

apps/example/tinyjobs.json

@@ -0,0 +1,4 @@
+{
+	"language": "typescript",
+	"jobsDir": "src/jobs"
+}

apps/example/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+    "paths": {
+      "tinyjobs": ["../../packages/tinyjobs/src/index.ts"],
+    }
+  }
+}

package.json

@@ -1,14 +1,5 @@
 {
   "name": "tinyjobs",
-  "private": true,
-  "scripts": {
-    "build": "turbo build",
-    "dev": "turbo dev",
-    "lint": "turbo lint",
-    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
-    "ci:version": "bunx changeset version && bun install",
-    "ci:publish": "bunx changeset publish"
-  },
   "devDependencies": {
     "prettier": "^3.3.3",
     "turbo": "^2.0.14",
@@ -19,6 +10,15 @@
     "node": ">=18"
   },
   "packageManager": "bun@1.1.26",
+  "private": true,
+  "scripts": {
+    "build": "turbo build",
+    "dev": "turbo dev",
+    "lint": "turbo lint",
+    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
+    "ci:version": "bunx changeset version && bun install",
+    "ci:publish": "bunx changeset publish"
+  },
   "workspaces": [
     "apps/*",
     "packages/*"

packages/tinyjobs/package.json

@@ -42,6 +42,7 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "bun run build --watch",
     "prepack": "bun run build"
   },
   "devDependencies": {
@@ -54,6 +55,6 @@
   },
   "peerDependencies": {},
   "dependencies": {
-
+    "bullmq": "^5.12.11"
   }
 }

packages/tinyjobs/src/index.ts

@@ -0,0 +1,5 @@
+import TinyJobsHandler from "./lib/TinyJobsHandler";
+import Job from "./structures/Job";
+
+export default TinyJobsHandler;
+export { Job };