Repository navigation
refactor: rewrite library in pure TypeScript - #25
Merged
Merged
Conversation
- Convert src/main.js and src/terminal-adapter.js to TypeScript - Add tsconfig with strict mode; emit CJS + .d.ts + source maps to dist/ - Export SmartwrapOptions via namespace on the default export - Ship types via package.json "types": "dist/main.d.ts" - Build on pretest / prepublishOnly; CI runs tsc before tests - Raise engines to Node >= 14 (TypeScript 5 toolchain) - Drop Node 12 from CI matrix; keep 14–26 - Document TypeScript usage in README
- Emit dist/esm (type:module) and dist/cjs (type:commonjs)
- package.json \"exports\" maps import → ESM and require → CJS
- Default + named export: import smartwrap from '…' / import { smartwrap }
- CJS interop so require('smartwrap') still returns the function
- export interface SmartwrapOptions for TypeScript consumers
Replace the breakword re-queue path with single-pass chunking so a long token (URL, hash, base64) is O(n) instead of O(n^2). Drop the now-unused breakword dependency and ambient module.
tecfu
added a commit
that referenced
this pull request
Sep 20, 2026
Closes #19. Library users who only need text wrapping no longer pull in yargs or the CLI binary. - smartwrap (root): core TypeScript library only (strip-ansi, wcwidth) - packages/smartwrap-cli: separate package with the smartwrap bin + yargs - Remove src/terminal-adapter.ts and bin field from the core package - README documents the install matrix Rebased onto master after the TypeScript rewrite (#25) and long-word perf fix (#26).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Full rewrite of the library source in pure TypeScript while preserving runtime behavior and the existing unit tests.
Changes
src/main.ts/src/terminal-adapter.tsreplace the JS sourcestscemits CommonJS + declaration files + source maps intodist/package.json:main→dist/main.js,types→dist/main.d.ts,bin→dist/terminal-adapter.jsSmartwrapOptions(exposed assmartwrap.Options)breakwordandwcwidthpretest/prepublishOnlyrun the buildtscthen runs tests on Node 14–26Public API
Behavior for supported inputs is unchanged; all 25 existing unit tests pass after compile.
Test plan
npm run build(tsc clean)npm test— 25 passingnpm packcontainsdist/*.js+dist/*.d.tsand nosrc/*.ts