path-sanitizer 4.0.0 → 4.0.1

package/.github/workflows/ci.yml

@@ -3,10 +3,10 @@ name: CI
 on:
   push:
     branches:
-      - '**'
+      - "**"
   pull_request:
     branches:
-      - '**'
+      - "**"
 
 jobs:
   test:
@@ -16,20 +16,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - uses: pnpm/action-setup@v4
-        name: Install pnpm
-        with:
-          version: 9
-          run_install: false
-
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 22
-          cache: 'pnpm'
 
-      - name: Install dependencies
-        run: pnpm install
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: true
 
       - name: Run tests
-        run: pnpm test
+        run: pnpm test

package/README.md

@@ -1,33 +1,36 @@
 # path-sanitizer
- A simple lightweight npm package for sanitizing paths to prevent Path Traversal
+
+A simple lightweight npm package for sanitizing paths to prevent Path Traversal
 
 # Usage
+
 ```js
 import sanitize from 'path-sanitizer'
-// or
-const sanitize = require('path-sanitizer').default
+// or in a common js environment
+const sanitize = (await import('path-sanitizer')).default
 
 console.log(sanitize('path/to/file.txt'))
 ```
 
 Or here is a more complex example:
+
 ```js
-const sanitize = require('../sanitize')
-const path = require('path')
+import sanitize from 'path-sanitizer'
+import path from 'path'
 
 // Real scenario:
-function routeHandler (myPath) {
-    // Lets just assume that the path was extracted from the request
-    // We want to read a file in the C:\Users\user\Desktop\myApp\ directory
-    // But the user should not be able to access C:\Users\user\Desktop\
-    // So we need to sanitize the path
-
-    const APP_DIR = 'C:\\Users\\user\\Desktop\\myApp\\'
-    const sanitized = path.join(APP_DIR, sanitize(myPath))
-
-    // Now we would usually read the file
-    // But in this case we will just print the path
-    console.log(sanitized)
+function routeHandler(myPath) {
+  // Lets just assume that the path was extracted from the request
+  // We want to read a file in the C:\Users\user\Desktop\myApp\ directory
+  // But the user should not be able to access C:\Users\user\Desktop\
+  // So we need to sanitize the path
+
+  const APP_DIR = 'C:\\Users\\user\\Desktop\\myApp\\'
+  const sanitized = path.join(APP_DIR, sanitize(myPath))
+
+  // Now we would usually read the file
+  // But in this case we will just print the path
+  console.log(sanitized)
 }
 
 routeHandler('my-video.mp4') // Just fine...
@@ -36,4 +39,4 @@ routeHandler('/hello.txt') // What if the path starts with a slash, and we try t
 routeHandler('////////a\\\\../hi.txt') // What if the path is not valid?
 routeHandler(500) // What if the path is not a string?
 routeHandler('/:11^^') // What if the path contains not allowed characters (like ":")?
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "path-sanitizer",
-    "version": "4.0.0",
+    "version": "4.0.1",
     "description": "A simple lightweight npm package for sanitizing paths to prevent Path Traversal",
     "type": "module",
     "main": "dist/index.js",