Add linter and fix minor issues

Author: The-Best-Codes

README.md

@@ -1,14 +1,78 @@
 # littlejson
 
-LittleJSON is a lightweigh CLI to compress and decompress JSON files.
+**A lightweight CLI for compressing and decompressing JSON files.**
+
+`littlejson` utilizes MessagePack for efficient binary serialization of JSON data, offering potentially significant size reductions for your JSON files.
+
+## Features
+
+- **Compress JSON to LJSON:** Reduces file size using MessagePack binary encoding.
+- **Decompress LJSON to JSON:** Restores compressed LJSON files back to readable JSON format.
+- **Simple CLI:** Easy-to-use command-line interface with clear instructions.
+- **File size analysis:** Provides details about the original size, compressed/decompressed size, and the percentage of change.
+
+## Installation
+
+**Global Installation:**
+If you perform a global installation, you can use the `littlejson` command directly instead of running it through `npx`.
+
+```bash
+npm install -g littlejson
+```
 
 ## Usage
 
+### Compressing JSON Files
+
+To compress a JSON file into a `.ljson` file:
+
+```bash
+npx littlejson compress <input-file.json> [output-file.ljson]
+```
+
+- `<input-file.json>`: The path to your JSON input file.
+- `[output-file.ljson]`: (Optional) The desired path for the compressed output file. If not provided, the output file will be named with the same base name as the input but with the `.ljson` extension, saved in the current working directory.
+
+**Example:**
+
 ```bash
-npx littlejson compress <input-file> <output-file>
-npx littlejson decompress <input-file> <output-file>
+npx littlejson compress data.json compressed.ljson
+# or
+npx littlejson compress data.json
 ```
 
+### Decompressing LJSON Files
+
+To decompress a `.ljson` file back into a `.json` file:
+
+```bash
+npx littlejson decompress <input-file.ljson> [output-file.json]
+```
+
+- `<input-file.ljson>`: The path to your LJSON input file.
+- `[output-file.json]`: (Optional) The desired path for the decompressed output file. If not provided, the output file will be named with the same base name as the input but with the `.json` extension, saved in the current working directory.
+
+**Example:**
+
+```bash
+npx littlejson decompress compressed.ljson decompressed.json
+# or
+npx littlejson decompress compressed.ljson
+```
+
+## Output
+
+The CLI provides useful details upon completion:
+
+- Success/error messages
+- Original file size
+- Compressed/Decompressed file size
+- Compression/Size change percentage
+
 ## License
 
-MIT
+[MIT](LICENSE)
+
+## Contributing
+
+Contributions are welcome! Feel free to submit a pull request or open an issue.

eslint.config.js

@@ -0,0 +1,11 @@
+import pluginJs from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { files: ["**/*.{js,mjs,cjs,ts}"] },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

package.json

@@ -1,13 +1,14 @@
 {
   "name": "littlejson",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "module": "dist/index.js",
   "type": "module",
   "bin": {
     "littlejson": "dist/index.js"
   },
   "scripts": {
-    "build": "bun build src/index.ts --outdir dist --minify --packages external"
+    "build": "bun build src/index.ts --outdir dist --minify --packages external",
+    "lint": "eslint src"
   },
   "repository": {
     "type": "git",
@@ -35,7 +36,11 @@
     "LICENSE"
   ],
   "devDependencies": {
-    "@types/bun": "^1.2.1"
+    "@eslint/js": "^9.19.0",
+    "@types/bun": "^1.2.1",
+    "eslint": "^9.19.0",
+    "globals": "^15.14.0",
+    "typescript-eslint": "^8.22.0"
   },
   "peerDependencies": {
     "typescript": "^5.7.3"

src/index.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { decode, encode } from "@msgpack/msgpack";
 import { program } from "commander";
@@ -29,7 +30,7 @@ async function getFileSize(filePath: string): Promise<number> {
 async function compressFile(inputFile: string, outputFile: string | undefined) {
   try {
     const inputSize = await getFileSize(inputFile);
-    consola.debug(`ℹ Compressing ${inputFile}...`);
+    consola.debug(`Compressing ${inputFile}...`);
 
     const data = await readFile(inputFile, "utf-8");
     const json = JSON.parse(data);
@@ -64,7 +65,7 @@ async function decompressFile(
 ) {
   try {
     const inputSize = await getFileSize(inputFile);
-    consola.debug(`ℹ Decompressing ${inputFile}...`);
+    consola.debug(`Decompressing ${inputFile}...`);
 
     const data = await readFile(inputFile);
     const decompressed = decode(data);