Luhn check behaviour + typescript upgrade (#3)

* When luhn-check is enabled, scanFile will now run a luhn check before flagging a file. Previously the luhn check only affected console output logic. * Upgrading to TypeScript 3.7.3 * Update CHANGELOG.md Co-authored-by: Ian Sutherland <[email protected]>
neofinancial · Dec 10, 2019 · 7aba008 · 7aba008
1 parent 138c5a4
commit 7aba008
Show file tree

Hide file tree

Showing 10 changed files with 392 additions and 213 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.4 (December 10, 2019)
+
+- When `luhn-check` is enabled, `scanFile` will now run a luhn check before flagging a file. Previously the luhn check only affected console output logic.
+- Upgrade to TypeScript 3.7.3
+
 ## 1.0.3 (December 10, 2019)
 
 - Changed `main` property in `package.json` to `build/index.js` to match the ncc build output.

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ccscan",
   "description": "Scan files for credit card numbers",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "author": "Neo Financial Engineering <[email protected]>",
   "license": "MIT",
   "main": "build/index.js",
@@ -47,20 +47,20 @@
     "@types/yargs": "^13.0.3",
     "@zeit/ncc": "^0.20.5",
     "chalk": "^2.4.2",
-    "eslint": "^5.16.0",
-    "eslint-config-neo": "~0.3.3",
+    "eslint": "^6.0.0",
+    "eslint-config-neo": "~0.5.1",
     "fast-luhn": "^1.0.4",
     "globby": "^10.0.1",
     "husky": "^3.0.8",
     "jest": "^24.9.0",
     "line-reader": "^0.4.0",
     "lint-staged": "^9.4.2",
-    "prettier": "^1.18.2",
+    "prettier": "^1.19.0",
     "rimraf": "^3.0.0",
     "strip-ansi": "^5.2.0",
     "ts-jest": "^24.1.0",
     "ts-node": "^8.4.1",
-    "typescript": "~3.5.3",
+    "typescript": "3.7.3",
     "yargs": "^14.2.0"
   }
 }
diff --git a/src/app.ts b/src/app.ts
@@ -97,12 +97,14 @@ const scanFile = async (fileName: string, args: Args): Promise<boolean> => {
   if (matches && matches.length > 0) {
     !args.silent && (await showMatches(fileName, matches, args));
 
-    return true;
-  } else {
-    !args.silent && args.verbose && console.log(chalk.gray(fileName));
-
-    return false;
+    if (!args['luhn-check'] || matches.filter(luhn).length > 0) {
+      return true;
+    }
   }
+
+  !args.silent && args.verbose && console.log(chalk.gray(fileName));
+
+  return false;
 };
 
 const scanFiles = async (args: Args): Promise<string[]> => {

diff --git a/test/__snapshots__/app.test.ts.snap b/test/__snapshots__/app.test.ts.snap
@@ -60,6 +60,7 @@ Array [
   "  10:37    warn     const cardNumberMultipleDashes = '1234--1234--1234--1234';",
   "  11:54    warn     const cardNumberInString = 'This is a card number: 1234123412341234';",
   "  12:43    warn     const cardNumberInStringNoSpaces = 'text1234123412341234text';",
+  "  13:33    warn     const cardNumberWithThrees = '3333333333333333';",
   undefined,
 ]
 `;
@@ -124,6 +125,7 @@ Array [
   "  10:37    warn     const cardNumberMultipleDashes = '1234--1234--1234--1234';",
   "  11:54    warn     const cardNumberInString = 'This is a card number: 1234123412341234';",
   "  12:43    warn     const cardNumberInStringNoSpaces = 'text1234123412341234text';",
+  "  13:33    warn     const cardNumberWithThrees = '3333333333333333';",
   undefined,
 ]
 `;
diff --git a/test/app.test.ts b/test/app.test.ts
@@ -9,7 +9,7 @@ const formatConsoleOutput = (consoleOutput: string[][]): string[] => {
 };
 
 beforeAll(() => {
-  consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
+  consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
 });
 
 afterAll(() => {
@@ -48,7 +48,7 @@ describe('TypeScript', () => {
     expect(
       await scanFiles({ files: '**/test/fixtures/typescript/*.{ts,js}', 'luhn-check': false })
     ).toEqual(['test/fixtures/typescript/bad.ts', 'test/fixtures/typescript/questionable.ts']);
-    expect(consoleLogSpy).toHaveBeenCalledTimes(23);
+    expect(consoleLogSpy).toHaveBeenCalledTimes(24);
     expect(formatConsoleOutput(consoleLogSpy.mock.calls)).toMatchSnapshot();
   });
 
@@ -96,7 +96,7 @@ describe('JavaScript', () => {
     expect(
       await scanFiles({ files: '**/test/fixtures/javascript/*.{ts,js}', 'luhn-check': false })
     ).toEqual(['test/fixtures/javascript/bad.js', 'test/fixtures/javascript/questionable.js']);
-    expect(consoleLogSpy).toHaveBeenCalledTimes(23);
+    expect(consoleLogSpy).toHaveBeenCalledTimes(24);
     expect(formatConsoleOutput(consoleLogSpy.mock.calls)).toMatchSnapshot();
   });
 

diff --git a/test/fixtures/javascript/bad.js b/test/fixtures/javascript/bad.js
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-unused-vars */
 
 // card number in a comment 5555554240233167
 // two card numbers in a comment 5555554240233167 1234123412341234

diff --git a/test/fixtures/javascript/good.js b/test/fixtures/javascript/good.js
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-unused-vars */
 
 // not a card number in a comment 12555555424023316712334
 

diff --git a/test/fixtures/javascript/questionable.js b/test/fixtures/javascript/questionable.js
@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-unused-vars */
 
 // card number in a comment 1234123412341234
 
@@ -10,6 +10,7 @@ const doSomething = () => {
   const cardNumberMultipleDashes = '1234--1234--1234--1234';
   const cardNumberInString = 'This is a card number: 1234123412341234';
   const cardNumberInStringNoSpaces = 'text1234123412341234text';
+  const cardNumberWithThrees = '3333333333333333';
 };
 
 module.exports = doSomething;
diff --git a/test/fixtures/typescript/questionable.ts b/test/fixtures/typescript/questionable.ts
@@ -10,6 +10,7 @@ const doSomething = () => {
   const cardNumberMultipleDashes = '1234--1234--1234--1234';
   const cardNumberInString = 'This is a card number: 1234123412341234';
   const cardNumberInStringNoSpaces = 'text1234123412341234text';
+  const cardNumberWithThrees = '3333333333333333';
 };
 
 export default doSomething;