tsconfig.json

{
  // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
  "extends": "@tsconfig/vite-react/tsconfig.json",
  // "compilerOptions": {
  //   "allowImportingTsExtensions": false,
  //   "allowSyntheticDefaultImports": true,
  // },
  "compilerOptions": {
    "allowImportingTsExtensions": false,
    "allowSyntheticDefaultImports": true,
    "baseUrl": ".", // This must be specified if "paths" is.
    "module": "esnext",
    "lib": [
      "dom",
      "esnext"
    ],
    "importHelpers": true,
    // output .d.ts declaration files for consumers
    "declaration": true,
    // output .js.map sourcemap files for consumers
    "sourceMap": true,
    // match output dir to input dir. e.g. dist/index instead of dist/src/index
    "rootDir": "./src",
    // stricter type-checking for stronger correctness. Recommended by TS
    "strict": true,
    // linter checks for common issues
    // "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    // use modern package export resolution for bundler-based tooling
    "moduleResolution": "bundler",
    // transpile JSX to React.createElement
    "jsx": "react",
    // interop between ESM and CJS modules. Recommended by TS
    "esModuleInterop": true,
    "resolveJsonModule": true,
    // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
    "skipLibCheck": true,
    // error out if import and file system have a casing mismatch. Recommended by TS
    "forceConsistentCasingInFileNames": true,
    // `dts build` ignores this option, but it is commonly used when type-checking separately with `tsc`
    "noEmit": true,
    // "paths": {
    //   "@hyphen/hyphen-design/tokens": ["./node_modules/@hyphen/hyphen-design-tokens"] // This mapping is relative to "baseUrl"
    // },
    // Downleveling is TypeScript’s term for transpiling to an older version of JavaScript.
    // This flag is to enable support for a more accurate implementation
    // of how modern JavaScript iterates through new concepts in older JavaScript runtimes.
    "downlevelIteration": true,
    "target": "es5",
    "types": [
      "@testing-library/jest-dom"
    ],
  },
  "include": [
    "src",
    "types",
    "index.d.ts",
  ],
}