feat: Adding types separately instead of auto generated types

feat: Adding types separately instead of auto generated types

Author: ayonious

.github/workflows/package-test.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [20.x]
 
     steps:
       - name: Checkout
@@ -43,4 +43,4 @@ jobs:
       - name: Run package test
         run: |
           cd test-pkg
-          node package-test.js 
+          node package-test.js

index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Returns the width of a single character in terminal columns.
+ * @param ucs - The Unicode code point of the character
+ * @returns The width of the character in terminal columns:
+ *          - 0 for null character
+ *          - -1 for control characters
+ *          - 0 for non-spacing characters
+ *          - 1 for normal characters
+ *          - 2 for wide characters (East Asian)
+ */
+declare function wcwidth(ucs: number): number;
+
+/**
+ * Returns the width of a string in terminal columns.
+ * @param pwcs - The string to measure
+ * @returns The width of the string in terminal columns, or -1 if the string contains control characters
+ */
+declare function wcswidth(pwcs: string): number;
+
+export { wcwidth, wcswidth };

package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "description": "Simplified JS/TS implementation of wcswidth() written by Markus Kuhn in C",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "index.d.ts",
   "repository": "[email protected]:console-table-printer/simple-wcswidth.git",
   "author": "Nahiyan Kamal <[email protected]>",
   "license": "MIT",
@@ -20,7 +20,8 @@
     "console-width"
   ],
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
   "devDependencies": {
     "@eslint/js": "^9.0.0",

test/githubActionsTest/package-test.js

@@ -4,21 +4,53 @@ const assert = require('assert');
 function runAllTests() {
   // Test 1: Basic ASCII Characters
   console.log('Running basic ASCII character tests...');
-  assert.strictEqual(wcswidth('Hello'), 5, 'ASCII string should have correct width');
+  assert.strictEqual(
+    wcswidth('Hello'),
+    5,
+    'ASCII string should have correct width'
+  );
   assert.strictEqual(wcswidth('123'), 3, 'Numbers should have correct width');
-  assert.strictEqual(wcswidth('!@#'), 3, 'Special characters should have correct width');
+  assert.strictEqual(
+    wcswidth('!@#'),
+    3,
+    'Special characters should have correct width'
+  );
 
   // Test 2: CJK Characters (Chinese, Japanese, Korean)
   console.log('Running CJK character tests...');
-  assert.strictEqual(wcswidth('你好'), 4, 'Chinese characters should have width 2 each');
-  assert.strictEqual(wcswidth('こんにちは'), 10, 'Japanese characters should have width 2 each');
-  assert.strictEqual(wcswidth('안녕하세요'), 10, 'Korean characters should have width 2 each');
+  assert.strictEqual(
+    wcswidth('你好'),
+    4,
+    'Chinese characters should have width 2 each'
+  );
+  assert.strictEqual(
+    wcswidth('こんにちは'),
+    10,
+    'Japanese characters should have width 2 each'
+  );
+  assert.strictEqual(
+    wcswidth('안녕하세요'),
+    10,
+    'Korean characters should have width 2 each'
+  );
 
   // Test 3: Mixed Content
   console.log('Running mixed content tests...');
-  assert.strictEqual(wcswidth('Hello 世界'), 10, 'Mixed ASCII and CJK should have correct width');
-  assert.strictEqual(wcswidth('123 你好'), 8, 'Mixed numbers and CJK should have correct width');
-  assert.strictEqual(wcswidth('!@# こんにちは'), 14, 'Mixed special chars and CJK should have correct width');
+  assert.strictEqual(
+    wcswidth('Hello 世界'),
+    10,
+    'Mixed ASCII and CJK should have correct width'
+  );
+  assert.strictEqual(
+    wcswidth('123 你好'),
+    8,
+    'Mixed numbers and CJK should have correct width'
+  );
+  assert.strictEqual(
+    wcswidth('!@# こんにちは'),
+    14,
+    'Mixed special chars and CJK should have correct width'
+  );
 
   // Test 4: Control Characters
   console.log('Running control character tests...');
@@ -29,21 +61,57 @@ function runAllTests() {
 
   // Test 5: Fullwidth Characters
   console.log('Running fullwidth character tests...');
-  assert.strictEqual(wcswidth('ＡＢＣ'), 6, 'Fullwidth Latin should have width 2 each');
-  assert.strictEqual(wcswidth('１２３'), 6, 'Fullwidth numbers should have width 2 each');
-  assert.strictEqual(wcswidth('！？'), 4, 'Fullwidth punctuation should have width 2 each');
+  assert.strictEqual(
+    wcswidth('ＡＢＣ'),
+    6,
+    'Fullwidth Latin should have width 2 each'
+  );
+  assert.strictEqual(
+    wcswidth('１２３'),
+    6,
+    'Fullwidth numbers should have width 2 each'
+  );
+  assert.strictEqual(
+    wcswidth('！？'),
+    4,
+    'Fullwidth punctuation should have width 2 each'
+  );
 
   // Test 6: Combining Characters
   console.log('Running combining character tests...');
-  assert.strictEqual(wcswidth('e\u0301'), 1, 'Combining character should have width 1');
-  assert.strictEqual(wcswidth('a\u0308'), 1, 'Combining character should have width 1');
+  assert.strictEqual(
+    wcswidth('e\u0301'),
+    1,
+    'Combining character should have width 1'
+  );
+  assert.strictEqual(
+    wcswidth('a\u0308'),
+    1,
+    'Combining character should have width 1'
+  );
 
   // Test 7: Individual Character Widths
   console.log('Running individual character width tests...');
-  assert.strictEqual(wcwidth('A'.charCodeAt(0)), 1, 'ASCII character should have width 1');
-  assert.strictEqual(wcwidth('你'.charCodeAt(0)), 2, 'CJK character should have width 2');
-  assert.strictEqual(wcwidth('\t'.charCodeAt(0)), -1, 'Control character should return -1');
-  assert.strictEqual(wcwidth('Ａ'.charCodeAt(0)), 2, 'Fullwidth character should have width 2');
+  assert.strictEqual(
+    wcwidth('A'.charCodeAt(0)),
+    1,
+    'ASCII character should have width 1'
+  );
+  assert.strictEqual(
+    wcwidth('你'.charCodeAt(0)),
+    2,
+    'CJK character should have width 2'
+  );
+  assert.strictEqual(
+    wcwidth('\t'.charCodeAt(0)),
+    -1,
+    'Control character should return -1'
+  );
+  assert.strictEqual(
+    wcwidth('Ａ'.charCodeAt(0)),
+    2,
+    'Fullwidth character should have width 2'
+  );
 
   // Test 8: Edge Cases
   console.log('Running edge case tests...');

tsconfig.json

@@ -5,7 +5,7 @@
     "noImplicitAny": true,
     "strictNullChecks": true,
     "module": "commonjs",
-    "declaration": true,
+    "declaration": false,
     "lib": ["es2017", "dom"],
     "strict": true,
     "types": ["jest"],