Skip to content

Commit 0baf501

Browse files
committed
convert project to typescript
1 parent 9d69bfd commit 0baf501

File tree

11 files changed

+385
-119
lines changed

11 files changed

+385
-119
lines changed

.travis.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
language: node_js
22
node_js:
3-
- '8'
43
- '10'
54
- '12'
6-
- '13'
5+
- '14'
6+
- '15'

dist/index.d.ts

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/// <reference types="node" />
2+
import { EventEmitter } from 'events';
3+
import { TextFileDiffOption } from './types';
4+
import { PathLike } from 'fs';
5+
import LineByLine = require('n-readlines');
6+
export declare class MyLineReader extends LineByLine {
7+
val: string;
8+
nextVal: string;
9+
lineNumber: number;
10+
myFile: string | undefined;
11+
charset: any;
12+
eof: number;
13+
constructor(file: PathLike | number);
14+
moveNext(): string;
15+
}
16+
/**
17+
* line by line diff of two files
18+
*/
19+
export default class TextFileDiff extends EventEmitter {
20+
options: TextFileDiffOption;
21+
constructor(options?: TextFileDiffOption);
22+
/**
23+
* run diff
24+
* @param String file1 path to file 1
25+
* @param String file2 path to file 2
26+
* @return Object self
27+
*/
28+
diff(file1: string, file2: string): this;
29+
doCompareLineReader(lineReader1: MyLineReader, lineReader2: MyLineReader): void;
30+
}

dist/index.js

+117
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/types.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export declare class TextFileDiffOption {
2+
skipHeader: boolean;
3+
charset: any;
4+
compareFn(line1: string, line2: string): 1 | -1 | 0;
5+
}

dist/types.js

+14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.js

-110
This file was deleted.

package.json

+15-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "text-file-diff",
3-
"version": "1.1.2",
3+
"version": "1.2.0",
44
"description": "line by line diff of two large files",
55
"license": "MIT",
66
"repository": "niiknow/text-file-diff",
@@ -10,16 +10,19 @@
1010
"url": "niiknow.org"
1111
},
1212
"engines": {
13-
"node": ">=6"
13+
"node": ">=10",
14+
"npm": ">=6"
1415
},
1516
"scripts": {
16-
"test": "xo && nyc ava",
17-
"report": "nyc report --reporter=html"
17+
"build": "tsc",
18+
"test": "tsc && cross-env DEBUG=text-file-diff xo && cross-env DEBUG=text-file-diff nyc ava",
19+
"report": "tsc && cross-env DEBUG=text-file-diff nyc report --reporter=html"
1820
},
1921
"bin": {
2022
"text-file-diff": "./bin/text-file-diff"
2123
},
22-
"main": "index.js",
24+
"main": "dist/index.js",
25+
"types": "dist/index.d.ts",
2326
"keywords": [
2427
"diff",
2528
"difference",
@@ -28,11 +31,17 @@
2831
"compare-files"
2932
],
3033
"dependencies": {
31-
"n-readlines": "^1.0.0"
34+
"@types/n-readlines": "^1.0.1"
3235
},
3336
"devDependencies": {
37+
"@types/node": "^14.14.21",
3438
"ava": "^2.4.0",
39+
"cross-env": "^7.0.3",
40+
"debug": "^4.3.1",
41+
"n-readlines": "^1.0.1",
3542
"nyc": "^14.1.1",
43+
"ts-node": "^9.1.1",
44+
"typescript": "^4.1.3",
3645
"xo": "^0.25.3"
3746
},
3847
"xo": {

0 commit comments

Comments
 (0)