fix: Fixing doc about styling (#347)

Author: ayonious

.github/workflows/coverage.yml

@@ -13,10 +13,10 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Use Node.js 20
+    - name: Use Node.js 22
       uses: actions/setup-node@v4
       with:
-        node-version: '20.x'
+        node-version: '22.x'
         cache: 'yarn'
 
     - name: Install dependencies

.gitignore

@@ -64,8 +64,7 @@ typings/
 # next.js build output
 .next
 
-# tests (not to add tests when publishing)
-test
+# Coverage output
 coverage
 
 # jest configuration

README.md

@@ -50,9 +50,6 @@ You can customize the table output using the `--tableOptions` parameter. This ac
 Example with table options:
 
 ```bash
-# Color the entire table red
-ctp -i '[{"id":1,"name":"John"},{"id":2,"name":"Jane"}]' --tableOptions '{"style": {"headerColor": "red", "color": "red"}}'
-
 # Use custom column styles
 ctp -i '[{"id":1,"status":"active"},{"id":2,"status":"inactive"}]' --tableOptions '{"columns": [{"name": "status", "color": "green"}]}'
 

jestconfig.json

@@ -1,4 +1,5 @@
 {
   "collectCoverage": true,
-  "preset": "ts-jest"
-}
+  "preset": "ts-jest",
+  "testMatch": ["**/test/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[tj]s?(x)"]
+}

package.json

@@ -8,7 +8,9 @@
     "ctp": "dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/test/**/*"
   ],
   "scripts": {
     "setup": "npm install",

src/inputVerifier.ts

@@ -1,4 +1,9 @@
 export const isValidJson = (str: string): Boolean => {
+  if (!str) {
+    console.error('Input is required');
+    return false;
+  }
+
   try {
     const jsonObj = JSON.parse(str);
     if (!Array.isArray(jsonObj)) {
@@ -12,9 +17,19 @@ export const isValidJson = (str: string): Boolean => {
   }
 };
 
-export const verifyInput = (inp: string): Boolean => isValidJson(inp);
+export const verifyInput = (inp: string): Boolean => {
+  if (inp === undefined || inp === null) {
+    console.error('Input is required');
+    return false;
+  }
+  return isValidJson(inp);
+};
 
 export const verifyTableOptions = (options: string): boolean => {
+  if (!options) {
+    console.error('Table options are required');
+    return false;
+  }
   try {
     JSON.parse(options);
     return true;

src/service.ts

@@ -18,17 +18,24 @@ const parseAndValidateInput = (inp: string, tableOptions?: string): ParsedInput
     return null;
   }
 
-  return {
-    data: JSON.parse(inp),
-    options: tableOptions && JSON.parse(tableOptions)
-  };
+  try {
+    return {
+      data: JSON.parse(inp),
+      options: tableOptions && JSON.parse(tableOptions)
+    };
+  } catch (err) {
+    console.log(`not a valid input ${inp}`);
+    return null;
+  }
 };
 
 const printTableFromInp = (inp: string, tableOptions?: string): void | string => {
   const parsed = parseAndValidateInput(inp, tableOptions);
   if (!parsed) return;
 
   const { data, options } = parsed;
+
+  console.log(options);
   if (options) {
     printTable(data, options);
   } else {

test/readmeExamples.test.ts

@@ -0,0 +1,34 @@
+import service from '../src/service';
+
+
+describe('Testing Examples from README', () => {
+  it('Original example', () => {
+    service(
+      '[{ "index":3, "text":"I would like some gelb bananen bitte", "value":200 }, { "index":4, "text":"I hope batch update is working", "value":300   } ]'
+    );
+  });
+
+  it('Basic Example', () => {
+    service(
+      '[{ "id":3, "text":"like" }, {"id":4, "text":"tea"}]'
+    );
+  });
+});
+
+
+describe('Using Table Options Examples', () => {
+  it('Example 1: Table with column-specific color and alignment', () => {
+    service(
+      '[{"id":1,"status":"active"},{"id":2,"status":"inactive"}]',
+      '{"columns":[{"name":"status","alignment":"right","color":"green"}]}'
+    );
+  });
+
+  it('Example 2: Table with custom title', () => {
+    service(
+      '[{"id":1,"name":"John"}]',
+      '{"title":"Users List"}'
+    );
+  });
+});
+