create-nexst-monorepo 0.1.0

package/template/bunfig.toml

@@ -0,0 +1,2 @@
+[install]
+linker = "isolated"

package/template/compose.yaml

@@ -0,0 +1,53 @@
+name: nexst
+
+configs:
+  postgres_init:
+    content: |
+      CREATE SCHEMA IF NOT EXISTS nexst_user AUTHORIZATION nexst_user;
+      ALTER ROLE nexst_user SET search_path = 'nexst_user';
+
+services:
+  postgres:
+    image: postgres:18-alpine
+    container_name: nexst_dev_postgres
+    environment:
+      POSTGRES_USER: nexst_user
+      POSTGRES_PASSWORD: test-pw
+      POSTGRES_DB: nexst_db
+      TZ: Europe/Berlin
+    ports: ["5432:5432"]
+    volumes: [nexst_dev_pgdata:/var/lib/postgresql]
+    configs:
+      [{ source: postgres_init, target: /docker-entrypoint-initdb.d/init.sql }]
+    healthcheck:
+      test: [CMD-SHELL, "pg_isready -U nexst_user -d nexst_db"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+  # @if worker
+
+  redis:
+    image: redis:8-alpine
+    container_name: nexst_dev_redis
+    command: redis-server --appendonly yes
+    ports: ["6379:6379"]
+    volumes: [nexst_dev_redis:/data]
+    healthcheck:
+      test: [CMD, redis-cli, ping]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+  # @endif
+  # @if auth
+
+  mailhog:
+    image: mailhog/mailhog:v1.0.1
+    container_name: nexst_dev_mailhog
+    ports: ["1025:1025", "8025:8025"]
+  # @endif
+
+volumes:
+  nexst_dev_pgdata:
+  # @if worker
+  nexst_dev_redis:
+  # @endif

package/template/docker-bake.hcl

@@ -0,0 +1,86 @@
+variable "BUN_VERSION" {
+  default = "1.4.2"
+}
+
+variable "NEXT_PUBLIC_HOST_URL" {
+  default = null
+}
+
+variable "NEXT_PUBLIC_API_URL" {
+  default = null
+}
+# @if auth
+
+variable "NEXT_PUBLIC_GOOGLE_CLIENT_ID" {
+  default = null
+}
+# @endif
+
+group "default" {
+  # @if worker
+  targets = ["api", "worker", "web"]
+  # @endif
+  # @if !worker
+  # targets = ["api", "web"]
+  # @endif
+}
+
+target "docker-metadata-action" {
+  tags = ["nexst:local"]
+}
+
+target "base" {
+  dockerfile = "Dockerfile.base"
+  args = {
+    BUN_VERSION = BUN_VERSION
+  }
+}
+
+target "_app" {
+  inherits = ["docker-metadata-action"]
+  contexts = {
+    toolchain = "target:base"
+  }
+  platforms = ["linux/arm64"]
+}
+
+target "api" {
+  inherits   = ["_app"]
+  dockerfile = "apps/api/Dockerfile"
+  target     = "runtime"
+  args = {
+    BUN_VERSION = BUN_VERSION
+  }
+}
+
+target "api-migrate" {
+  inherits   = ["_app"]
+  dockerfile = "apps/api/Dockerfile"
+  target     = "migrator"
+  args = {
+    BUN_VERSION = BUN_VERSION
+  }
+}
+# @if worker
+
+target "worker" {
+  inherits   = ["_app"]
+  dockerfile = "apps/worker/Dockerfile"
+  args = {
+    BUN_VERSION = BUN_VERSION
+  }
+}
+# @endif
+
+target "web" {
+  inherits   = ["_app"]
+  dockerfile = "apps/web/Dockerfile"
+  args = {
+    BUN_VERSION          = BUN_VERSION
+    NEXT_PUBLIC_HOST_URL = NEXT_PUBLIC_HOST_URL
+    NEXT_PUBLIC_API_URL  = NEXT_PUBLIC_API_URL
+    # @if auth
+    NEXT_PUBLIC_GOOGLE_CLIENT_ID = NEXT_PUBLIC_GOOGLE_CLIENT_ID
+    # @endif
+  }
+}

package/template/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "nexst",
+  "private": true,
+  "workspaces": [
+    "apps/*",
+    "packages/*"
+  ],
+  "scripts": {
+    "dev": "docker compose up -d --wait && turbo run dev",
+    "infra:down": "docker compose down",
+    "build": "turbo run build",
+    "lint": "turbo run lint",
+    "lint:fix": "turbo run lint:fix",
+    "fmt": "turbo run fmt",
+    "fmt:check": "turbo run fmt:check",
+    "lint:ts": "turbo run lint:ts",
+    "unused": "turbo run unused --continue=always",
+    "test:unit": "turbo run test:unit"
+  },
+  "devDependencies": {
+    "@nexst/lint": "workspace:*",
+    "@nexst/tsconfig": "workspace:*",
+    "@vitest/coverage-v8": "^5.0.2",
+    "@vitest/ui": "^5.0.2",
+    "eslint-plugin-perfectionist": "^5.12.1",
+    "eslint-plugin-regexp": "^3.3.1",
+    "eslint-plugin-security": "^4.0.1",
+    "eslint-plugin-sonarjs": "^4.2.1",
+    "knip": "^6.38.0",
+    "oxfmt": "^0.70.0",
+    "oxlint": "^1.85.0",
+    "oxlint-tsgolint": "^7.0.2003",
+    "turbo": "2.11.4",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.2"
+  },
+  "packageManager": "bun@1.4.2",
+  "trustedDependencies": [
+    "@nestjs/core",
+    "@prisma/engines",
+    "@swc/core",
+    "esbuild",
+    "msgpackr-extract",
+    "prisma",
+    "sharp"
+  ]
+}

package/template/packages/lint/knip.ts

@@ -0,0 +1,40 @@
+interface KnipConfigOverrides {
+  entry?: string[];
+  ignoreBinaries?: string[];
+  ignoreDependencies?: string[];
+  project?: string[];
+  vitest?: true | { config: string[] };
+}
+
+const defaults = {
+  ignoreBinaries: ["knip", "oxfmt", "oxlint", "tsc", "vitest"],
+  ignoreDependencies: [
+    "oxfmt",
+    "oxlint",
+    "vitest",
+    "@vitest/coverage-v8",
+    "pino-pretty",
+  ],
+  oxfmt: true as const,
+  oxlint: true as const,
+  project: ["src/**/*.{js,ts,tsx}", "tests/**/*.{js,ts,tsx}"],
+  typescript: true as const,
+  vitest: true as const,
+};
+
+export function createKnipConfig({
+  entry = [],
+  ignoreBinaries = [],
+  ignoreDependencies = [],
+  project = [],
+  ...overrides
+}: KnipConfigOverrides = {}) {
+  return {
+    ...defaults,
+    ...overrides,
+    ...(entry.length > 0 ? { entry } : {}),
+    ignoreBinaries: [...defaults.ignoreBinaries, ...ignoreBinaries],
+    ignoreDependencies: [...defaults.ignoreDependencies, ...ignoreDependencies],
+    project: [...defaults.project, ...project],
+  };
+}

package/template/packages/lint/oxfmt.ts

@@ -0,0 +1,8 @@
+/**
+ * oxfmt has no `extends` mechanism, so unlike oxlint.ts this is a plain object each
+ * app's oxfmt.config.ts spreads into its own `defineConfig({...})` call.
+ */
+export const baseOxfmtConfig = {
+  printWidth: 100,
+  sortImports: { newlinesBetween: false },
+};

package/template/packages/lint/oxlint.ts

@@ -0,0 +1,136 @@
+import { defineConfig } from "oxlint";
+
+/**
+ * Ignore patterns shared by every app, for both oxlint and oxfmt (see oxfmt.ts).
+ * oxlint's `extends` merges `rules`, `plugins`, `jsPlugins`, `overrides` and
+ * `options` from extended configs (last one wins on conflicting keys), but NOT
+ * `ignorePatterns` — that field is fully replaced by whichever config sets it
+ * last, so each app spreads this array into its own instead of relying on
+ * `extends` for it.
+ */
+export const baseIgnorePatterns = [
+  "public/**",
+  "dist/**",
+  "coverage/**",
+  "node_modules/**",
+  "tests/files/**",
+];
+
+export default defineConfig({
+  jsPlugins: [
+    "eslint-plugin-sonarjs",
+    "eslint-plugin-perfectionist",
+    "eslint-plugin-security",
+    "eslint-plugin-regexp",
+  ],
+  options: {
+    typeAware: true,
+    typeCheck: true,
+  },
+  plugins: [
+    "unicorn",
+    "typescript",
+    "oxc",
+    "import",
+    "promise",
+    "jsdoc",
+    "node",
+    "vitest",
+  ],
+  rules: {
+    "perfectionist/sort-array-includes": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-classes": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-decorators": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-enums": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-export-attributes": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-exports": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-heritage-clauses": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-import-attributes": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-interfaces": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-intersection-types": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-jsx-props": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-maps": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-modules": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-named-exports": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-named-imports": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-object-types": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-objects": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-sets": ["warn", { order: "asc", type: "natural" }],
+    "perfectionist/sort-switch-case": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-union-types": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+    "perfectionist/sort-variable-declarations": [
+      "warn",
+      { order: "asc", type: "natural" },
+    ],
+
+    "regexp/no-super-linear-backtracking": "warn",
+    "regexp/no-unused-capturing-group": "warn",
+    "regexp/prefer-regexp-test": "warn",
+
+    "security/detect-bidi-characters": "error",
+    "security/detect-child-process": "warn",
+    "security/detect-eval-with-expression": "error",
+    "security/detect-new-buffer": "error",
+    "security/detect-non-literal-fs-filename": "warn",
+    "security/detect-non-literal-regexp": "warn",
+    "security/detect-unsafe-regex": "warn",
+
+    "sonarjs/cognitive-complexity": "warn",
+    "sonarjs/max-switch-cases": ["warn", 30],
+    "sonarjs/no-all-duplicated-branches": "warn",
+    "sonarjs/no-collapsible-if": "warn",
+    "sonarjs/no-collection-size-mischeck": "warn",
+    "sonarjs/no-duplicate-string": ["warn", { threshold: 5 }],
+    "sonarjs/no-duplicated-branches": "warn",
+    "sonarjs/no-element-overwrite": "warn",
+    "sonarjs/no-empty-collection": "warn",
+    "sonarjs/no-extra-arguments": "warn",
+    "sonarjs/no-identical-conditions": "warn",
+    "sonarjs/no-identical-expressions": "warn",
+    "sonarjs/no-identical-functions": "warn",
+    "sonarjs/no-redundant-boolean": "warn",
+    "sonarjs/no-small-switch": "warn",
+    "sonarjs/no-unused-collection": "warn",
+    "sonarjs/no-use-of-empty-return-value": "warn",
+    "sonarjs/no-useless-catch": "warn",
+    "sonarjs/prefer-immediate-return": "warn",
+    "sonarjs/prefer-read-only-props": "warn",
+    "sonarjs/prefer-single-boolean-return": "warn",
+  },
+});

package/template/packages/lint/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@nexst/lint",
+  "private": true,
+  "type": "module",
+  "exports": {
+    "./knip": "./knip.ts",
+    "./oxfmt": "./oxfmt.ts",
+    "./oxlint": "./oxlint.ts"
+  },
+  "devDependencies": {
+    "oxlint": "^1.85.0"
+  }
+}

package/template/packages/queues/oxfmt.config.ts

@@ -0,0 +1,8 @@
+import { baseOxfmtConfig } from "@nexst/lint/oxfmt";
+import { baseIgnorePatterns } from "@nexst/lint/oxlint";
+import { defineConfig } from "oxfmt";
+
+export default defineConfig({
+  ...baseOxfmtConfig,
+  ignorePatterns: baseIgnorePatterns,
+});

package/template/packages/queues/oxlint.config.ts

@@ -0,0 +1,7 @@
+import base, { baseIgnorePatterns } from "@nexst/lint/oxlint";
+import { defineConfig } from "oxlint";
+
+export default defineConfig({
+  extends: [base],
+  ignorePatterns: baseIgnorePatterns,
+});

package/template/packages/queues/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@nexst/queues",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check",
+    "lint:ts": "tsc --noEmit"
+  }
+}

package/template/packages/queues/src/example-job.ts

@@ -0,0 +1,11 @@
+/** Payload apps/api enqueues on `EXAMPLE_QUEUE`. */
+export type ExampleJob = {
+  message: string;
+  requestedAt: string;
+};
+
+/** What apps/worker returns once an `ExampleJob` is processed. */
+export type ExampleJobResult = {
+  processedAt: string;
+  reversed: string;
+};

package/template/packages/queues/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./example-job.js";
+export * from "./queue-names.js";
+export * from "./redis-connection.js";

package/template/packages/queues/src/queue-names.ts

@@ -0,0 +1,2 @@
+/** BullMQ queue apps/api enqueues example jobs on and apps/worker consumes. */
+export const EXAMPLE_QUEUE = "example";

package/template/packages/queues/src/redis-connection.ts

@@ -0,0 +1,27 @@
+export type RedisConnectionOptions = {
+  host: string;
+  maxRetriesPerRequest: null;
+  port: number;
+  retryStrategy: (times: number) => null | number;
+};
+
+/**
+ * Shared ioredis connection options for the BullMQ producer (apps/api) and
+ * consumer (apps/worker) sides of every queue in this package. `maxRetriesPerRequest:
+ * null` is required by BullMQ; the capped exponential retry strategy keeps
+ * both sides behaving the same way during a Redis outage.
+ */
+export function createRedisConnectionOptions(config: {
+  host: string;
+  port: number;
+  retryLimit?: number;
+}): RedisConnectionOptions {
+  const retryLimit = config.retryLimit ?? 5;
+
+  return {
+    host: config.host,
+    maxRetriesPerRequest: null,
+    port: config.port,
+    retryStrategy: (times: number) => (times > retryLimit ? null : Math.min(times * 100, 2000)),
+  };
+}

package/template/packages/queues/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@nexst/tsconfig/node.json",
+  "include": ["src/**/*.ts"]
+}

package/template/packages/tsconfig/base.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ESNext",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitOverride": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "incremental": true,
+    "sourceMap": true,
+    "removeComments": true
+  }
+}

package/template/packages/tsconfig/node.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "resolvePackageJsonExports": true,
+    "verbatimModuleSyntax": true,
+    "lib": ["ESNext"]
+  }
+}

package/template/packages/tsconfig/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@nexst/tsconfig",
+  "private": true
+}

package/template/turbo.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://turborepo.com/schema.json",
+  "tasks": {
+    "transit": {
+      "dependsOn": ["^transit"]
+    },
+    "dev": {
+      "cache": false,
+      "persistent": true
+    },
+    "build": {
+      "dependsOn": ["transit"],
+      "outputs": [
+        ".next/**",
+        "!.next/cache/**"
+      ]
+    },
+    "lint": {
+      "dependsOn": ["transit"],
+      "outputs": []
+    },
+    "lint:fix": {
+      "dependsOn": ["transit"],
+      "outputs": []
+    },
+    "lint:ts": {
+      "dependsOn": ["transit"],
+      "outputs": []
+    },
+    "fmt": {
+      "dependsOn": ["transit"],
+      "outputs": [],
+      "cache": false
+    },
+    "fmt:check": {
+      "dependsOn": ["transit"],
+      "outputs": []
+    },
+    "unused": {
+      "dependsOn": ["transit"],
+      "outputs": []
+    },
+    "test:unit": {
+      "dependsOn": ["transit"],
+      "outputs": [
+        "coverage/**"
+      ]
+    }
+  }
+}