@rtorcato/js-tooling 1.0.6

package/tooling/tsup/index.ts

@@ -0,0 +1,50 @@
+import type { Options } from 'tsup'
+import { defineConfig } from 'tsup'
+
+export type DefineConfig = ReturnType<typeof defineConfig>
+
+export const getConfig: (customOptions: Options, env: string) => DefineConfig = (
+	customOptions: Options,
+	env: string
+): DefineConfig => {
+	return defineConfig((options: Options = customOptions) => {
+		return baseOptions(options, env)
+	})
+}
+
+export const baseOptions = (options: Options, env: string): Options => {
+	const opts: Options = {
+		treeshake: true,
+		splitting: true,
+		// target: 'es2020',
+		// target: 'nodeNext',
+		format: ['cjs', 'esm'], // generate cjs and esm files
+		entry: [
+			// './src/index.ts',
+			'src/**/*.ts',
+			// './src/**/*!(index).ts?(x)',
+			// '!./src/**/*.spec.*',
+			// '!./src/**/*.stories.*',
+		],
+		skipNodeModulesBundle: true, // Skips building dependencies for node modules
+		minify: !options.watch && env === 'production',
+		bundle: false, //env === 'production',
+		clean: true, // clean up the dist folder
+		dts: true, // generate dts file for main module
+		// sourcemap: env === 'production', // source map is only available in prod
+		// sourcemap: true,
+		// outDir: env === 'production' ? 'dist' : 'lib',
+		// outDir: 'dist',
+		// tsconfig: path.resolve(__dirname, './tsconfig.build.json'),
+		// esbuildOptions(options, context) {
+		//   options.outbase = './'
+		// },
+		// external: ['react'],
+		...options,
+		// banner: {js: '"use client";'},
+		// dts: {
+		//   footer: "declare module 'knex/types/tables';"
+		// },
+	}
+	return opts
+}

package/tooling/tsup/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "module": "commonjs"
+  }
+}

package/tooling/tsup/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "module": "esnext",
+    "emitDeclarationOnly": false,
+    "noEmit": false
+  }
+}

package/tooling/tsup/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./../typescript/internal-package.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json",
+    "incremental": true,
+    "outDir": "./dist",
+    "baseUrl": "."
+  },
+  "include": ["./src/**/*.ts", "index.ts"],
+  "exclude": ["node_modules"]
+}

package/tooling/tsup/tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "declaration": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  }
+}

package/tooling/typescript/README.md

@@ -0,0 +1,52 @@
+# `tsconfig`
+
+These are base shared `tsconfig.json` files from which all other `tsconfig.json`'s inherit.
+
+## Usage
+
+1. **Install this package** (if published as a package):
+   ```sh
+   pnpm add -D @your-org/tsconfig
+   # or
+   npm install --save-dev @your-org/tsconfig
+   # or
+   yarn add -D @your-org/tsconfig
+   ```
+
+2. **Extend the relevant config in your project `tsconfig.json`:**
+   ```jsonc
+   {
+     "extends": "./path/to/tooling/typescript/tsconfig.base.json", // or tsconfig.react.jsonc, etc.
+     // ...your overrides
+   }
+   ```
+   Replace the path with the config that matches your project type:
+   - `tsconfig.base.jsonc`: General base config
+   - `tsconfig.build.jsonc`: For npm package/library builds
+   - `tsconfig.react.jsonc`: For React apps
+   - `tsconfig.next.jsonc`: For Next.js apps
+   - `tsconfig.node.jsonc`: For Node.js/Express APIs
+   - `tsconfig.express.jsonc`: (If used) For Express APIs
+
+3. **Customizing:**
+   You can override or add any settings in your own `tsconfig.json` as needed.
+
+## Example
+
+```jsonc
+{
+  "extends": "../tooling/typescript/tsconfig.react.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  },
+  "include": ["src"]
+}
+```
+
+## Notes
+- These configs are meant to be shared and extended, not used directly.
+- Pick the config that matches your project type for best results.
+

package/tooling/typescript/reset.d.ts

@@ -0,0 +1,9 @@
+// Do not add any other lines of code to this file!
+import '@total-typescript/ts-reset'
+
+// https://www.totaltypescript.com/ts-reset
+// With ts-reset:
+// 👍 .json (in fetch) and JSON.parse both return unknown
+// ✅ .filter(Boolean) behaves EXACTLY how you expect
+// 🥹 array.includes is widened to be more ergonomic
+// 🚀 And several more changes!

package/tooling/typescript/tsconfig.base.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    // 🔧 Output & Module Resolution
+    "moduleResolution": "bundler",
+    "module": "esnext",
+    "target": "esnext",
+    // "module": "esnext", // 
+    // "moduleResolution": "node", // Prefer "bundler" if you're using Vite, esbuild, etc.
+    // "target": "esnext", // 
+    "lib": ["ES2022"], // Specify library files to be included in the compilation
+    "baseUrl": ".", // Base directory to resolve non-relative module names
+    "rootDir": "src",
+    "outDir": "dist",
+
+    
+    // 🔍 JavaScript Support
+    "allowJs": true, // Allow JavaScript files to be compiled
+    "checkJs": true, // Enable type checking on JavaScript files
+    "resolveJsonModule": true,  // Allow importing JSON files
+    "isolatedModules": true, // Ensure that each file can be safely transpiled independently
+    "esModuleInterop": true, // Enables emit interoperability between CommonJS and ES Modules
+    "allowSyntheticDefaultImports": true, // recommend enabling this for smoother interop
+
+    // ⚙️ Module Detection
+    "moduleDetection": "force", // Force module detection
+
+    // 📈 Performance
+    "skipLibCheck": true, // Skip type checking of declaration files
+    "incremental": true, // Enable incremental compilation
+    "disableSourceOfProjectReferenceRedirect": true, // Disable source of project reference redirect
+
+    // 🚨 Strict Type Checking
+    "strict": true, // Enable all strict type checking options
+    "noUncheckedIndexedAccess": true, // Disallow accessing an index signature with an arbitrary key
+    "noImplicitAny": true, // Disallow implicit any type
+    "noImplicitReturns": true, // Disallow functions that do not return a value
+    "noImplicitOverride": true, // Ensure override keyword is used
+    "noImplicitThis": true, // Disallow 'this' with an implicit any type
+    "noPropertyAccessFromIndexSignature": true, // Disallow property access from index signature
+
+    // 🧹 Lint-Like Settings
+    "noUnusedLocals": true, // Disallow unused locals
+    "noUnusedParameters": true, // Disallow unused parameters
+    "noFallthroughCasesInSwitch": true, // Disallow fallthrough cases in switch statements
+
+    // 📦 Types & Declarations
+    "types": ["node", "vitest"], // Specify type declaration files to be included in the compilation
+    "declaration": false, // Do not generate .d.ts files
+    "declarationMap": false, // Do not generate sourcemaps for d.ts files
+
+    // 🛑 Emit Settings
+    "noEmit": true, // Do not emit output files
+    "sourceMap": true, // Generate sourcemaps for .ts files
+    
+    "paths": { // Path mapping for module resolution
+      "~/*": ["./src/*"],
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src/**/*", "index.d.ts"], // Include files in the src directory and index.d.ts
+  "exclude": [
+    "node_modules",
+    "build",
+    "dist",
+    ".next",
+    ".expo",
+    "OLD",
+    "**/*.test.ts",
+    "**/*.test.tsx",
+    "**/*.spec.ts",
+    "**/*.spec.tsx",
+    ".turbo",
+    "out",
+    "not-used",
+    "vitest.config.ts"
+  ] // Exclude directories from compilation
+}

package/tooling/typescript/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false, // Emit output files
+    "emitDeclarationOnly": true, // Emit JS and .d.ts files
+    "declaration": true, // Generate .d.ts files
+    "declarationMap": true, // (optional) Generate sourcemaps for d.ts files
+    "outDir": "dist" // Output directory for build
+  },
+  "exclude": ["dist", "node_modules", "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"]
+}

package/tooling/typescript/tsconfig.express.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["ES2022"], // Only include ES libs, no DOM
+    "types": ["node", "express", "vitest"], // Add express types for API development
+  },
+  "include": ["src", "index.d.ts"],
+  "exclude": ["node_modules", "dist", "build", "test", "**/*.test.ts", "**/*.spec.ts"]
+}

package/tooling/typescript/tsconfig.next.json

@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "preserve", // Let Next.js handle JSX transformation
+    "lib": ["DOM", "DOM.Iterable", "ESNext"], // Include DOM types for browser APIs
+    "module": "esnext", // Next.js expects ESNext modules
+    "moduleResolution": "bundler", // Modern module resolution for Next.js
+    "allowJs": true, // Allow JavaScript files
+    "esModuleInterop": true, // Interop for CommonJS/ESM
+    "types": ["react", "tailwindcss", "vitest"],
+    "plugins": [ { "name": "next" } ], // Next.js plugin for TypeScript
+    "paths": {
+      "~/*": ["./src/*"],
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "src", "pages", "app", "components", "types", "index.d.ts"],
+  "exclude": ["node_modules", "dist", ".next", "build", "out"]
+}

package/tooling/typescript/tsconfig.node.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["ES2022"],
+    "types": ["node", "vitest"]
+  },
+  "include": ["src", "index.d.ts"],
+  "exclude": ["node_modules", "dist", "build", "test", "**/*.test.ts", "**/*.spec.ts"]
+}

package/tooling/typescript/tsconfig.react.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "react-jsx", // Use the new JSX transform for React 17+
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],// Include DOM types for browser APIs
+    "types": ["react", "react-dom", "tailwindcss", "vitest"],
+    "paths": {
+      "~/*": ["./src/*"],
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src", "index.d.ts", "types"],
+  "exclude": ["node_modules", "dist", "build", "out", "**/*.test.ts", "**/*.spec.ts"]
+}

package/tooling/typescript/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "vitest"]
+  },
+  "include": ["src", "tests", "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"]
+}

package/tooling/vitest/vitest.config.mjs

@@ -0,0 +1,22 @@
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { defineConfig } from 'vitest/config'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+export default defineConfig({
+	test: {
+		globals: true,
+		environment: 'node',
+		coverage: {
+			provider: 'istanbul', // or 'v8'
+			reporter: ['text', 'json', 'html'],
+		},
+	},
+	resolve: {
+		alias: [
+			{ find: '@', replacement: resolve(__dirname, './src') },
+			{ find: '~', replacement: resolve(__dirname, './src') },
+		],
+	},
+})

package/tooling/vitest/vitest.config.react.mjs

@@ -0,0 +1,27 @@
+import base from '@rtorcato/js-tooling/vitest/config'
+import react from '@vitejs/plugin-react'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { defineConfig, mergeConfig } from 'vitest/config'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+export default mergeConfig(
+	base,
+	defineConfig({
+		plugins: [react()],
+		test: {
+			environment: 'jsdom',
+			include: ['src/**/*.{test,spec}.{js,jsx,ts,tsx}'],
+			css: true, // ← Vitest will stub every *.css / *.module.css import
+			exclude: ['OLD/**'],
+			setupFiles: ['./vitest.setup.ts'],
+		},
+		resolve: {
+			alias: [
+				{ find: '@', replacement: resolve(__dirname, './src') },
+				{ find: '~', replacement: resolve(__dirname, './src') },
+			],
+		},
+	})
+)

package/tooling/vitest/vitest.setup.mjs

@@ -0,0 +1,3 @@
+import { vi } from 'vitest'
+
+vi.mock('**/*.module.css', () => ({}))