lenix 1.4.4 → 1.6.0

package/Readme.md

@@ -3,9 +3,13 @@
 The All-in-one Repository
 
 ## 🗺️ Roadmap
+
 ### Lint
+
 - [ ] fix the lint tsconfig.json file creation when no file is found
+
 ### Extension
+
 - [x] trim the diff's unusefull text
 - [ ] use walkthrough instead of custom page
 - [ ] use webview to add quick settings
@@ -14,25 +18,34 @@ The All-in-one Repository
 - [ ] use add commit reminder
 - ~~[/] add a revert last commit button~~ (use amend instead)
 - [ ] add more configuration to the commit composer extension
+
 ### OOP
+
 - [ ] Implement the complete annotation
 - [ ] Provide Documentation
 - [ ] Clearify the installation steps
 
 ## Usage
+
 ### Lint
+
 ```ts
 import lint from 'lenix/lint' with { type: "json" }
-languageOptions: {
-  [....],
-  parserOptions: {
-    projectService: true,
-    tsconfigRootDir: import.meta.dirname,
+{
+  ...
+  languageOptions: {
+    ...,
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+    ...,
   },
-  [....],
-}
-rules: {
-  [....],
-  ...lint.strict
-  [....],
-}
+  rules: {
+    ...,
+    ...lint.strict,
+    ...,
+  }
+  ...
+},
+```

package/index.ts

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+const [, , cmd] = process.argv
+
+switch (cmd) {
+	case 'format':
+		await import('./format/index')
+		break
+	case '--lint':
+		await import('./lint/src/lint.mts')
+		break
+	default:
+		process.stdout.write(
+			'Usage: lenix <command>\n\nCommands:\n  format    Setup prettier\n  --lint    Setup eslint\n',
+		)
+		process.exit(0)
+}
+export {}

package/modules/src/edge/index.ts

@@ -1,17 +1,17 @@
-export type Events = "users-management"
+export type Events = 'users-management'
 export interface CreateUser<Role> {
-  identifier: string
-  role: Role
-  password: string
+	identifier: string
+	role: Role
+	password: string
 }
-export interface UserAccount<Role, Label = unknown | string> {
-  id: string
-  identifier: string
-  role: Role
-  roleLabel: Label
+export interface UserAccount<Role, Label = string> {
+	id: string
+	identifier: string
+	role: Role
+	roleLabel: Label
 }
 export interface DeleteUser {
-  identifier: string
+	identifier: string
 }
 
 /**
@@ -19,4 +19,4 @@ export interface DeleteUser {
  * DON NOT USE
  * @description
  * A proxy between client and server contexts that can provide a one source of truth instead of duplicating codes, lack of clearancy, race conditions, ...
- */
+ */

package/modules/src/entries/index.ts

@@ -2,9 +2,12 @@
  * Get typed entries from an object (Typed Object.entries)
  * @param object - Object to get entries from
  * @returns Array of the passed entries
-*/
-export const entries = <T extends Record<string, unknown>>(object: T) => {
-  return Object.entries(object) as Array<{
-    [K in keyof T]: [K, T[K]]
-  }[keyof T]>
-}
+ */
+export const entries = <T extends Record<string, unknown>>(
+	object: T,
+): {
+	[K in keyof T]: [K, T[K]]
+// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+}[keyof T][] => Object.entries(object) as {
+	[K in keyof T]: [K, T[K]]
+}[keyof T][]

package/modules/src/fetch/index.ts

@@ -1,14 +1,21 @@
 /**
+ * A wrapper for fetch that throws an error if the request fails.
  * @param domain - domain of the URL (e.g. api.github.com)
  * @param endpoint - endpoint of the URL (e.g. users/lenixdev)
  * @param request - request options (e.g. { method: 'GET' })
  */
-export const caughtFetch = async (domain: string, endpoint: string, request?: RequestInit) => {
-  try {
-    return await fetch(`https://${domain}/${endpoint}`, request)
-  } catch(error) {
-    throw new Error('An error occurred while making the request.', { cause: error })
-  } finally {
-    console.debug(`End of ${domain}/${endpoint} request`)
-  }
-}
+export const caughtFetch = async (
+	domain: string,
+	endpoint: string,
+	request?: RequestInit,
+): Promise<Response> => {
+	try {
+		return await fetch(`https://${domain}/${endpoint}`, request)
+	} catch (error) {
+		throw new Error('An error occurred while making the request.', {
+			cause: error,
+		})
+	} finally {
+		console.debug(`End of ${domain}/${endpoint} request`)
+	}
+}

package/modules/src/fxmanifest/fxmanifest.json

@@ -1,14 +1,8 @@
 {
-  "fx_version": "cerulean",
-  "game": "gta5",
-  "client_scripts": [
-    "dist/client.js"
-  ],
-  "server_scripts": [
-    "dist/server.js"
-  ],
-  "ui_page": "client/nui/dist/index.html",
-  "files": [
-    "client/nui/dist/**"
-  ]
-}
+	"fx_version": "cerulean",
+	"game": "gta5",
+	"client_scripts": ["dist/client.js"],
+	"server_scripts": ["dist/server.js"],
+	"ui_page": "client/nui/dist/index.html",
+	"files": ["client/nui/dist/**"]
+}

package/modules/src/fxmanifest/index.ts

@@ -4,21 +4,21 @@ type FileContent = Parameters<typeof writeFile>[1]
 const fxmanifest = Object.entries((await import('./fxmanifest.json')).default)
 
 const generateContent = () => {
-  let defaultContent: FileContent = ''
-  for (const [key, value] of fxmanifest) {
-    if (Array.isArray(value)) {
-      defaultContent +=
-`${key} {
+	let defaultContent: FileContent = ''
+	for (const [key, value] of fxmanifest) {
+		if (Array.isArray(value)) {
+			defaultContent += `${key} {
   "${value}",
 }
 `
-    } else if (typeof value === 'string') {
-      defaultContent +=
-`${key} "${value}"
+		} else if (typeof value === 'string') {
+			defaultContent += `${key} "${value}"
 `
-    } else throw new Error('Invalid value type')
-  }
-  return defaultContent
+		} else throw new Error('Invalid value type')
+	}
+	return defaultContent
 }
 
-export const createFxmanifest = async (content?: FileContent) => await writeFile('fxmanifest.lua', content || generateContent())
+export const createFxmanifest = async (content?: FileContent) => {
+	await writeFile('fxmanifest.lua', content || generateContent())
+}

package/modules/src/fxmanifest/tsconfig.json

@@ -1,7 +1,7 @@
 {
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-  },
-}
+	"extends": "../../../tsconfig.json",
+	"compilerOptions": {
+		"moduleResolution": "bundler",
+		"resolveJsonModule": true
+	}
+}

package/modules/src/guard/index.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks if the value is one of the values in the array
+ * @param value - The value to check
+ * @param from - The array of values to check from
+ * @returns boolean, True if the value is one of the values in the array, False otherwise
+ * @example
+ * guard(1, [1, 2, 3]): true
+ * guard(4, [1, 2, 3]): false
+ */
+export const guard = <T>(value: unknown, from: readonly T[]): value is T =>
+	(from as readonly unknown[]).includes(value)

package/modules/src/index.ts

@@ -1,4 +1,4 @@
 export { wait } from './wait'
 export { caughtFetch } from './fetch'
 export { entries } from './entries'
-export * as edge from './edge'
+export type * as edge from './edge'