chore: docs

Author: Handfish

README.md

@@ -36,7 +36,7 @@ async function main() {
 }
 ```
 
-`ajel` is a function that consumes a promise and returns a tuple represetning the result and the error.
+`ajel` is a function that consumes a promise and returns a tuple representing the result and the error.
 On success, the result item has value. On error, the error item has value. It's that simple.
 
 More interestingly, it comes with a series of linting tools to help enforce the paradigm available in the package `eslint-plugin-ajel`
@@ -59,3 +59,4 @@ More interestingly, it comes with a series of linting tools to help enforce the
 - `docs`: A placeholder documentation site powered by [Next.js](https://nextjs.org/)
 - `ajel`: The core library (function)
 - `eslint-plugin-ajel`: Eslint rules for proper usage and error handling paradigm
+- `benchmarks`: Testing ajel's performance against other methods

apps/docs/src/pages/index.mdx

@@ -27,7 +27,7 @@ async function main() {
 }
 ```
 
-`ajel` is a function that consumes a promise and returns a tuple represetning the result and the error.
+`ajel` is a function that consumes a promise and returns a tuple representing the result and the error.
 On success, the result item has value. On error, the error item has value. It's that simple.
 
 More interestingly, it comes with a series of linting tools to help enforce the paradigm available in the package `eslint-plugin-ajel`
@@ -36,7 +36,7 @@ More interestingly, it comes with a series of linting tools to help enforce the
 
 As I entered yet another year of employment at my current company, I was tasked with a new goal.
 I wanted to learn something new. A little mustached Netflix birdie told me to dig one level deeper.
-I told myself it was time to stop being a lowly TS soy dev, and alas, I had a brief but impactful
+I told myself it was time to stop being a lowly Typescript soy latte dev, and alas, I had a brief but impactful
 affair with the oxidized language Rust. As work demands kicked into overdrive during the busy portion of the year,
 I returned to Typescript land with my new experience with Result types - and I saw nothing but holes everywhere.
 
@@ -47,8 +47,6 @@ It was not hard to narrow down the source of the problem. `try/catch` is a terri
 not included in the type system, and thus, it is not possible to know what errors a function can throw.
 
 I tried a few different approaches. Result-type libraries felt like trying to force Rust's paradigm into a language that
-wasn't designed for it. I wanted to find a way to make it work with the language, not against it.
+wasn't designed for it. I wanted to find a way to with the language, not against it.
 Out of the solutions I tried, [one of them felt right.](https://dev.to/karanpratapsingh/go-like-error-handling-in-typescript-4plm#comment-1hc45)
 I had found a way that worked for me. And so, I decided to make a library out of it.
-
-

apps/docs/src/pages/rules/ajel-require-error-handling.md

@@ -30,7 +30,7 @@ Handling errors properly is crucial for robust and maintainable code. This rule
 ```javascript
 // Bad: Declaring error variable but not using it
 const [data, err] = await ajel(Promise.resolve(1));
-// 'err' should be handled, e.g., by logging or throwing
+// 'err' should be handled, e.g., by logging or other usage
 
 // Good: Properly handling the error variable
 const [data, err] = await ajel(Promise.resolve(1));

packages/ajel-core/package.json

@@ -1,6 +1,7 @@
 {
   "name": "ajel",
-  "version": "0.0.4",
+  "description": "Ajel allows you to handle errors similarly to Golang.",
+  "version": "0.0.5",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",

packages/ajel-core/readme.md

@@ -36,7 +36,7 @@ async function main() {
 }
 ```
 
-`ajel` is a function that consumes a promise and returns a tuple represetning the result and the error.
+`ajel` is a function that consumes a promise and returns a tuple representing the result and the error.
 On success, the result item has value. On error, the error item has value. It's that simple.
 
 More interestingly, it comes with a series of linting tools to help enforce the paradigm available in the package [eslint-plugin-ajel](https://www.npmjs.com/package/eslint-plugin-ajel)

packages/eslint-plugin-ajel/README.md

@@ -66,7 +66,7 @@
 }
 ```
 
-`ajel` is a function that consumes a promise and returns a tuple represetning the result and the error.
+`ajel` is a function that consumes a promise and returns a tuple representing the result and the error.
 On success, the result item has value. On error, the error item has value. It's that simple.
 
 More interestingly, it comes with a series of linting tools to help enforce the paradigm available in the package `eslint-plugin-ajel`

packages/eslint-plugin-ajel/package.json

@@ -1,14 +1,16 @@
 {
   "name": "eslint-plugin-ajel",
-  "version": "0.0.4",
-  "description": "",
+  "version": "0.0.5",
+  "description": "Eslint rules for Ajel, the library that allows you to handle errors similarly to Golang",
   "engines": {
     "node": ">=8.10.0"
   },
   "files": [
     "dist"
   ],
-  "main": "./eslint-plugin-ajel/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "prepare": "cd ../.. && husky install packages/eslint-plugin-ajel/.husky",
     "clean": "rimraf dist",
@@ -55,7 +57,6 @@
   },
   "lint-staged": {
     "*.{js,ts}": [
-      "pnpm run lint -- --fix",
       "prettier --write"
     ],
     "*.{json,yaml,md}": [

packages/eslint-plugin-ajel/tsup.config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from 'tsup';
 
 export default defineConfig({
   entry: ['src/index.ts'],
-  outDir: 'eslint-plugin-ajel',
+  outDir: 'dist',
   splitting: false,
   minify: true,
   // clean: true,