@nrbx/react-tsconfig

Shared TypeScript configuration presets for roblox-ts projects using @nrbx/react.

Installation

npm install @nrbx/react-tsconfig --save-dev

Then in your tsconfig.json:

{
  "extends": "@nrbx/react-tsconfig"
}

Presets

| Preset | Extends | Description | |---|---|---| | @nrbx/react-tsconfig | tsconfig.json | Default preset. React JSX (react-jsx), strict mode, path aliases, Roblox types. | | @nrbx/react-tsconfig/tsconfig.base.json | — | Bare minimum. ESNext target, commonjs module, noLib, synthetic imports. No JSX. Use for packages or non-UI code. | | @nrbx/react-tsconfig/tsconfig.client.json | tsconfig.json | React JSX, scoped to src/client. Use when your workspace has separate client/server tsconfigs. | | @nrbx/react-tsconfig/tsconfig.server.json | tsconfig.base.json | No JSX, scoped to src/server. Use for server-only code with no React dependency. | | @nrbx/react-tsconfig/tsconfig.strict.json | tsconfig.json | Default settings plus extra strictness: noUnusedLocals, noUnusedParameters, exactOptionalPropertyTypes, noUncheckedIndexedAccess, noFallthroughCasesInSwitch, noImplicitReturns. |

What's Included

tsconfig.json (default)

• jsx: "react-jsx" with jsxImportSource: "@nrbx/react"
• strict: true
• Path aliases: @client/*, @server/*, @shared/* mapping to src/client, src/server, src/shared
• typeRoots including both @rbxts and @nrbx scopes

tsconfig.base.json (bare minimum)

• target: "ESNext", module: "commonjs", moduleResolution: "Node"
• noLib: true, allowSyntheticDefaultImports: true
• downlevelIteration: true, resolveJsonModule: true
• forceConsistentCasingInFileNames: true
• No JSX settings — add them yourself if needed

Overriding Settings

You can override any setting from a preset:

{
  "extends": "@nrbx/react-tsconfig/tsconfig.strict.json",
  "compilerOptions": {
    "outDir": "dist",
    "noUnusedLocals": false
  }
}

Built with roblox-ts