unslash 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-present - Gwynerva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# `/` unslash
+
+Stop wasting your life on slash normalization.<br />
+Zero dependencies because why would I need any?
+
+## Install
+
+```bash
+npm install unslash
+```
+
+## Usage
+
+```ts
+import { slash } from 'unslash';
+
+// Need a trailing slash? Done.
+slash('t', 'path', 'to', 'file');
+// → 'path/to/file/'
+
+// Don’t want it? Gone.
+slash('!t', 'path/to/file/');
+// → 'path/to/file'
+
+// Want a leading slash? Here you go.
+slash('l', 'path', 'to', 'file');
+// → '/path/to/file'
+
+// Need to collapse that mess? Fixed.
+slash('c', 'path///to', 'this//file');
+// → 'path/to/this/file'
+
+// Want to force forward slashes? Me too.
+slash('f', 'path\\to', 'this/file');
+// → 'path/to/this/file'
+
+// Need Windows paths? What is wrong with you?!
+slash('!f', 'path', 'to', 'file');
+// → 'path\to\file'
+
+// Combine them. Because you can.
+slash('tlfc', 'path\\\\to\\file');
+// → '/path/to/file/'
+slash('!t!l!fc', '/path///to/file/');
+// → 'path\to\file'
+
+// Your precious protocols are safe — don’t worry.
+slash('tlfc', 'http://example.com', 'path', 'to', 'file');
+// → 'http://example.com/path/to/file/'
+```
+
+## Pattern Flags
+
+- `t` / `!t` — Add/remove **T**railing slash
+- `l` / `!l` — Add/remove **L**eading slash
+- `f` / `!f` — Force **F**orward slashes / backward slashes
+- `c` — **C**ollapse multiple slashes (yes, you’re right — `!c` doesn’t do shit)
+
+## But Gwynerva, there are libraries for this
+
+Yeah, I know.<br/>
+I don’t give a shit.<br />
+I was too lazy to look for them and made my own.<br />
+Made with GPT help. Cry about it.
+
+_It’d be cool if this package got popular and made me rich._

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './pattern.js';
+export * from './slash.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './pattern.js';
+export * from './slash.js';

package/dist/pattern.d.ts

@@ -0,0 +1,14 @@
+export type SlashFlag = 't' | 'l' | 'f' | 'c';
+export declare const unslash: unique symbol;
+type link = 'https://github.com/Gwynerva/unslash';
+export type UnknownFlagError<C extends string> = {
+    readonly [unslash]: link;
+    SlashPatternError: `Character "${C}" is not a valid SlashFlag (allowed: t l f c, optionally prefixed with "!")`;
+};
+export type DuplicateFlagError<F extends string> = {
+    readonly [unslash]: link;
+    SlashPatternError: `Flag "${F}" is used more than once or both negated and non-negated`;
+};
+export type ValidateSlashPattern<S extends string, Pos extends string = never, Neg extends string = never> = S extends `!${infer L}${infer R}` ? L extends SlashFlag ? L extends Pos | Neg ? DuplicateFlagError<L> : ValidateSlashPattern<R, Pos, Neg | L> : UnknownFlagError<`!${L}`> : S extends `${infer L}${infer R}` ? L extends SlashFlag ? L extends Pos | Neg ? DuplicateFlagError<L> : ValidateSlashPattern<R, Pos | L, Neg> : UnknownFlagError<L> : S;
+export type SlashPattern<S extends string> = ValidateSlashPattern<S> extends string ? S : ValidateSlashPattern<S>;
+export {};

package/dist/pattern.js

@@ -0,0 +1 @@
+export {};

package/dist/slash.d.ts

@@ -0,0 +1,23 @@
+import type { SlashPattern } from './pattern.js';
+/**
+ * Creates a string formatter based on the given slash pattern.
+ * @param pattern
+ * A string of letters or their negations (prefixed with "!").
+ * Each letter represents a specific formatting rule:
+ * - `t` | `!t`: Ensure trailing slash is added | removed.
+ * - `l` | `!l`: Ensure leading slash is added | removed.
+ * - `f` | `!f`: Force forward | backward slashes.
+ * - `c` | `!c`: Collapse multiple slashes into a single slash | Does nothing.
+ *
+ * Example patterns:
+ * - `"tlfc"`: Ensure leading and trailing slashes, force forward slashes, collapse multiple slashes.
+ * - `"lf"`: Force forward slashes and ensure leading slash (trailing might be present or absent).
+ * - `tl!f`: Ensure leading and trailing slashes, force backward slashes.
+ * @param parts
+ * The string parts to be formatted according to the specified pattern.
+ * They will be joined together using forward slashes by default (or backward slashes if `!f` is specified in the pattern).
+ * @returns
+ * The formatted string with slash-concatenated parts according to the specified slash pattern.
+ * Protocols (like `http://`) are preserved and not altered by the formatting.
+ */
+export declare function slash<S extends string>(pattern: SlashPattern<S>, ...parts: string[]): string;

package/dist/slash.js

@@ -0,0 +1,95 @@
+/**
+ * Creates a string formatter based on the given slash pattern.
+ * @param pattern
+ * A string of letters or their negations (prefixed with "!").
+ * Each letter represents a specific formatting rule:
+ * - `t` | `!t`: Ensure trailing slash is added | removed.
+ * - `l` | `!l`: Ensure leading slash is added | removed.
+ * - `f` | `!f`: Force forward | backward slashes.
+ * - `c` | `!c`: Collapse multiple slashes into a single slash | Does nothing.
+ *
+ * Example patterns:
+ * - `"tlfc"`: Ensure leading and trailing slashes, force forward slashes, collapse multiple slashes.
+ * - `"lf"`: Force forward slashes and ensure leading slash (trailing might be present or absent).
+ * - `tl!f`: Ensure leading and trailing slashes, force backward slashes.
+ * @param parts
+ * The string parts to be formatted according to the specified pattern.
+ * They will be joined together using forward slashes by default (or backward slashes if `!f` is specified in the pattern).
+ * @returns
+ * The formatted string with slash-concatenated parts according to the specified slash pattern.
+ * Protocols (like `http://`) are preserved and not altered by the formatting.
+ */
+export function slash(pattern, ...parts) {
+    const flags = {};
+    // @ts-expect-error Pattern is validated at compile-time
+    pattern = pattern;
+    for (let i = 0; i < pattern.length; i++) {
+        const char = pattern[i];
+        const negated = char === '!';
+        const flag = negated ? pattern[i + 1] : char;
+        flags[flag] = !negated;
+        if (negated) {
+            i++;
+        }
+    }
+    const slashChar = flags['f'] === false ? '\\' : '/';
+    // ------------------------------------------------------------
+    // Protocol-safe join
+    // ------------------------------------------------------------
+    let joined = parts.join(slashChar);
+    // Matches: scheme: or scheme://
+    // Examples: http://, file://, mailto:
+    const PROTOCOL_RE = /^([a-zA-Z][a-zA-Z\d+\-.]*:)(\/\/)?/;
+    let protocol = '';
+    const match = joined.match(PROTOCOL_RE);
+    if (match) {
+        protocol = match[0];
+        joined = joined.slice(protocol.length);
+    }
+    // ------------------------------------------------------------
+    // Force slash type (convert all slashes)
+    // ------------------------------------------------------------
+    if (flags['f'] === false) {
+        // Force backward slashes: convert all / to \
+        joined = joined.replace(/\//g, '\\');
+    }
+    else if (flags['f'] === true) {
+        // Force forward slashes: convert all \ to /
+        joined = joined.replace(/\\/g, '/');
+    }
+    // ------------------------------------------------------------
+    // Collapse multiple slashes
+    // ------------------------------------------------------------
+    if (flags['c']) {
+        const slashRegex = flags['f'] === false ? /\\+/g : /\/+/g;
+        const replacement = flags['f'] === false ? '\\' : '/';
+        joined = joined.replace(slashRegex, replacement);
+    }
+    // ------------------------------------------------------------
+    // Leading slash handling
+    // ------------------------------------------------------------
+    if (flags['l']) {
+        if (!joined.startsWith(slashChar)) {
+            joined = slashChar + joined;
+        }
+    }
+    else {
+        while (joined.startsWith('\\') || joined.startsWith('/')) {
+            joined = joined.slice(1);
+        }
+    }
+    // ------------------------------------------------------------
+    // Trailing slash handling
+    // ------------------------------------------------------------
+    if (flags['t']) {
+        if (!joined.endsWith(slashChar)) {
+            joined = joined + slashChar;
+        }
+    }
+    else {
+        while (joined.endsWith('\\') || joined.endsWith('/')) {
+            joined = joined.slice(0, -1);
+        }
+    }
+    return protocol + joined;
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "unslash",
+  "version": "1.0.1",
+  "type": "module",
+  "description": "🤬 No more pain with slashes!",
+  "keywords": [
+    "slash",
+    "path",
+    "path-normalization",
+    "normalize",
+    "url",
+    "trailing-slash",
+    "leading-slash",
+    "router",
+    "base-path",
+    "cross-platform",
+    "windows",
+    "utilities"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Gwynerva/unslash.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && tsc --project ./tsconfig.src.json",
+    "prepack": "bun run build",
+    "format": "bun prettier --write .",
+    "test": "bun vitest run"
+  },
+  "devDependencies": {
+    "prettier": "^3.8.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}