@rmacshane-lw/slugify-lite 1.0.0 → 3.0.0

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+	"singleQuote": true,
+	"useTabs": true,
+	"arrowParens": "always",
+	"trailingComma": "all"
+}

package/README.md

@@ -2,7 +2,27 @@
 
 A tiny utility that converts strings into URL-friendly slugs.
 
+**Note:** This is just an AI generated package that is used for me to test npm package management. Use at your own risk.
+
 ## Installation
 
 ```bash
 npm install slugify-lite
+```
+
+## Usage
+### Slugify
+```typescript
+import { slugify } from '@rmacshane-lw/slugify-lite';
+
+const slug = slugify('Hello World');
+console.log(slug); # hello-world
+```
+
+### Version
+```typescript
+import { version } from '@rmacshane-lw/slugify-lite';
+
+const version = version();
+console.log(version); # x.x.x
+```

package/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A tiny function to slugify strings for URLs
+ * @param text - The text to convert into a URL-friendly slug
+ * @returns A URL-friendly string with spaces replaced by hyphens and special characters removed
+ */
+export function slugify(text: string): string;
+
+/**
+ * Returns the version of the package for testing
+ * @returns The version of the package
+ */
+export function version(): string;

package/index.js

@@ -1,10 +1,14 @@
-export function slugify(text) {
-    return text
-      .toString()
-      .toLowerCase()
-      .trim()
-      .replace(/[^a-z0-9 -]/g, '') // remove invalid chars
-      .replace(/\s+/g, '-')        // collapse whitespace and replace by -
-      .replace(/-+/g, '-');        // collapse dashes
-  }
-  
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const pkg = require('./package.json');
+
+export const slugify = (text) =>
+	text
+		.toString()
+		.toLowerCase()
+		.trim()
+		.replace(/[^a-z0-9 -]/g, '') // remove invalid chars
+		.replace(/\s+/g, '-') // collapse whitespace and replace by -
+		.replace(/-+/g, '-'); // collapse dashes
+
+export const version = () => pkg.version;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@rmacshane-lw/slugify-lite",
-  "version": "1.0.0",
-  "description": "A tiny function to slugify strings for URLs",
+  "version": "3.0.0",
+  "description": "A tiny function to slugify strings for URLs - This is a test package for me to test npm version management - Use at your own risk!",
   "main": "index.js",
   "type": "module",
+  "types": "index.d.ts",
   "publishConfig": {
     "access": "public"
   },

package/test.mjs

@@ -1,4 +1,7 @@
-import { slugify } from './index.js';
+import { slugify, version } from './index.js';
 
-console.log(slugify("Hello World! This is cool."));
+console.log(slugify('Hello World! This is cool.'));
 // Output: "hello-world-this-is-cool"
+
+console.log(version());
+// Output: "x.x.x"