initial commit

Author: iqbal-rashed

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

README.md

@@ -0,0 +1,71 @@
+# rswitch
+
+The `rswitch` library provides a compact and flexible way to implement a switch-like functionality in TypeScript. It allows you to define cases and their corresponding actions using an object literal syntax.
+
+## Installation
+
+Install the `rswitch` library using npm:
+
+```bash
+npm install rswitch
+```
+
+## Usage
+
+The `rswitch` function takes a key and an object containing cases and actions. It evaluates the key against the cases and returns the corresponding action.
+
+### Syntax
+
+```javascript
+rswitch(key, casesObj, options);
+```
+
+-   `key` : The value to evaluate against the cases.
+-   `casesObj` : An object containing cases and their actions.
+-   `options` : (Optional) An object to customize the behavior of the rswitch function.
+    -   `returnFunction` (optional, default: false): If set to `false`, the `rswitch` function will call actions that are functions and return their values. If set to `true`, the function will return the functions as is.
+
+### Example
+
+```javascript
+import { rswitch } from "rswitch";
+// const {rswitch} = require("rswitch") // commonjs
+
+const result = rswitch(
+    "dev",
+    {
+        designer: "Designer",
+        "dev, web": "Freelancer",
+        "": () => {
+            console.log("Hello");
+        },
+    },
+    {
+        returnFunction: true,
+    }
+);
+
+console.log(result);
+// Output: Freelancer
+```
+
+In this example, the `rswitch` function evaluates the key `'dev'` against the cases defined in `casesObj`. Since it matches the case `'dev, web'`, the corresponding action `'Freelancer'` is returned and assigned to the `result` variable. Finally, the value of `result` is logged to the console.
+
+### Case Definitions
+
+Cases are defined as key-value pairs in the `casesObj` object.
+
+-   Single Case: `{ caseKey: action }`
+-   Multiple Cases: `{ 'case1, case2, case3': action }`
+-   Default Case: `{ '': action }`
+
+> Actions can be any value or a function that returns a value. If the action is a function, and the `options` object has `returnFunction` set to `false`, it is called, and the returned value is returned.
+
+If no cases match the evaluated key, the `rswitch` function checks for a default case. If a default case is defined, its corresponding action is performed. If no default case is defined or its action is not provided, `undefined` is returned.
+
+<br/>
+If you'd like to contribute, please do submit a pull request.
+
+In case you want support my work
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/rashed.iqbal)

package.json

@@ -0,0 +1,33 @@
+{
+    "name": "rswitch",
+    "private": true,
+    "version": "0.1.0",
+    "type": "module",
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "import": "./dist/rswitch.es.js",
+            "require": "./dist/rswitch.umd.js"
+        }
+    },
+    "main": "./dist/rswitch.umd.js",
+    "module": "./dist/rswitch.es.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "dev": "vite",
+        "build": "tsc && vite build",
+        "preview": "vite preview"
+    },
+    "devDependencies": {
+        "@types/node": "^20.4.5",
+        "typescript": "^5.0.2",
+        "vite": "^4.4.5",
+        "vite-plugin-dts": "^3.4.0",
+        "vite-tsconfig-paths": "^4.2.0"
+    },
+    "dependencies": {
+        "vite-plugin-linter": "^2.0.2"
+    }
+}

src/index.ts

@@ -0,0 +1,33 @@
+type RSwitch = {
+    [key: string]: any;
+};
+
+type Options = {
+    returnFunction?: boolean;
+};
+
+export function rswitch(
+    key: string | undefined,
+    rswitch: RSwitch,
+    options?: Options
+): any {
+    const fnCall = options?.returnFunction || false;
+    const value = rswitch[key!];
+    const keys = Object.keys(rswitch)
+        .filter((v) => v.includes(","))
+        .flatMap((v) => v.split(","))
+        .map((v) => v.trim());
+    if (!value) {
+        if (keys.includes(key!)) {
+            return typeof value === "function" && !fnCall ? value() : value;
+        }
+        const _default = rswitch[""];
+        return typeof _default === "function" && !fnCall
+            ? _default()
+            : _default;
+    } else {
+        return typeof value === "function" && !fnCall ? value() : value;
+    }
+}
+
+export default rswitch;

src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "useDefineForClassFields": true,
+        "module": "ESNext",
+        "lib": ["ES2020", "DOM", "DOM.Iterable"],
+        "skipLibCheck": true,
+
+        /* Bundler mode */
+        "moduleResolution": "bundler",
+        "allowImportingTsExtensions": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "noEmit": true,
+
+        /* Linting */
+        "strict": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "noFallthroughCasesInSwitch": true,
+
+        /* typing */
+        "declaration": true,
+        "declarationMap": true,
+        "esModuleInterop": true
+    },
+    "include": ["src"]
+}

vite.config.ts

@@ -0,0 +1,27 @@
+import { resolve } from "node:path";
+import { defineConfig } from "vite";
+
+import dts from "vite-plugin-dts";
+import EsLint from "vite-plugin-linter";
+import tsConfigPaths from "vite-tsconfig-paths";
+const { EsLinter, linterPlugin } = EsLint;
+
+export default defineConfig((configEnv) => ({
+    plugins: [
+        tsConfigPaths(),
+        linterPlugin({
+            include: ["./src}/**/*.{ts}"],
+            linters: [new EsLinter({ configEnv })],
+        }),
+        dts({
+            include: ["src/"],
+        }),
+    ],
+    build: {
+        lib: {
+            entry: resolve("src", "index.ts"),
+            name: "rswitch",
+            fileName: (format) => `rswitch.${format}.js`,
+        },
+    },
+}));