Merge pull request #10 from Benoit-Welsch/Feat/better-template

Feat/better template

.npmignore

@@ -18,6 +18,7 @@ src/
 
 # Ignore bun files
 build.mjs
+genDoc.ts
 bun.lockb
 tsconfig.json
 

Readme.md

@@ -8,6 +8,7 @@
 
 - [Check](#check)
 - [Csv](#csv)
+- [Gen](#gen)
 - [Parser](#parser)
 - [Queue](#queue)
 - [Scanner](#scanner)
@@ -74,6 +75,18 @@ const csv2 = CSV.readString('name,age\r\nJohn,20\r\nJane,21\r\nJack,22', ',');
 csv2.toString('|');
 ```
 
+### Gen
+
+Generate pseudo-random data
+
+#### randomName
+
+```typescript
+import { Gen } from '@lv00/toolkit';
+
+const newName = Gen.randomName(); // antonelli-xenodochial
+```
+
 ### Parser
 
 Parse data to object.

build.mjs

@@ -1,14 +1,16 @@
 import dts from 'bun-plugin-dts';
-import { Scanner } from './src';
-import path from 'path';
-import fs from 'fs/promises';
 
 await Bun.build({
   entrypoints: ['./src/index.ts'],
-  outDir: './dist',
+  outDir: './dist/',
   target: 'bun',
   minify: true,
   plugins: [dts()],
+}).catch((e) => {
+  console.error(e);
+  process.exit(1);
+}).then(() => {
+  console.log('build done');
 });
 
 // Scanner.readFolder("./src").folders.map(async (f) => {

package.json

@@ -1,13 +1,13 @@
 {
-  "version": "1.1.5",
+  "version": "1.1.6",
   "name": "@lv00/toolkit",
   "module": "./dist/index.js",
   "type": "module",
   "scripts": {
-    "build": "bun run build.mjs",
-    "doc": "bun run genDoc.ts",
+    "build": "bun build.mjs && bun build src/index.ts --outfile=dist/index.js --target=bun  --minify",
+    "doc": "bun genDoc.ts",
     "format": "prettier --write \"src/**/*.ts\" --single-quote --trailing-comma all --tab-width 2",
-    "format:md":"prettier --write  \"**/*.md\" --single-quote --trailing-comma all --tab-width 2",
+    "format:md": "prettier --write  \"**/*.md\" --single-quote --trailing-comma all --tab-width 2",
     "prepublish": "bun doc && bun format:md"
   },
   "devDependencies": {

src/Gen/Readme.md

@@ -0,0 +1,11 @@
+### Gen
+
+Generate pseudo-random data
+
+#### randomName
+
+```typescript
+import { Gen } from '@lv00/toolkit';
+
+const newName = Gen.randomName(); // antonelli-xenodochial
+```

src/Gen/index.test.ts

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'bun:test';
+import { randomName } from './index';
+
+describe('randomName', () => {
+  it('should generate a random name with default options', () => {
+    const name = randomName();
+    expect(typeof name).toBe('string');
+    expect(name).not.toBe('');
+    expect(name).toMatch(/^[a-z]+(-[a-z]+)*$/);
+  });
+
+  it('should generate a random name with custom separator', () => {
+    const name = randomName('_');
+    expect(name.includes('_')).toBe(true);
+    expect(name).toMatch(/^[a-z]+(_[a-z]+)*$/);
+  });
+
+  it('should generate a random name with capitalized words', () => {
+    const name = randomName('-', true);
+    expect(name).toMatch(/^[A-Z][a-z]+(-[A-Z][a-z]+)*$/);
+  });
+});

src/Gen/index.ts

@@ -0,0 +1,16 @@
+import { famousName, word } from './list';
+
+export const randomName = (serperator = '-', capitalize = false) => {
+  let randomFamousName =
+    famousName[Math.floor(Math.random() * famousName.length)];
+  let randomWord = word[Math.floor(Math.random() * word.length)];
+
+  if (capitalize) {
+    const capitalizeString = (text: string) => {
+      return text.charAt(0).toUpperCase() + text.slice(1);
+    };
+    randomFamousName = capitalizeString(randomFamousName);
+    randomWord = capitalizeString(randomWord);
+  }
+  return `${randomFamousName}${serperator}${randomWord}`;
+};