This repository has been archived by the owner on Apr 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Wrote some unit tests to make splitToParamList more maintainable
- Loading branch information
Showing
7 changed files
with
188 additions
and
114 deletions.
There are no files selected for viewing
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import { IFunctionCallObject } from "./functionCallObject"; | ||
|
|
||
| export function grabPossibleParameters(fc: IFunctionCallObject, definitionLine: string): string[] { | ||
| let paramList: string[] = []; | ||
|
|
||
| // Grab any params inside the definition line | ||
| const defintionParam = grabDefLineParams(definitionLine); | ||
|
|
||
| if (defintionParam !== "") { | ||
| if (fc.functionRange === undefined) { | ||
| return; | ||
| } | ||
|
|
||
| paramList = splitToParamList(defintionParam); | ||
|
|
||
| paramList = paramList.map((param) => { | ||
| // Extract identifiers | ||
| const words = param.trim().split(" "); | ||
|
|
||
| // If there are multiple words and the first word doesn't end with a colon, use the 2nd word as the param | ||
| // this will make sure the param name is used and not the access modifier in TS functions | ||
| if (words.length > 1 && !words[0].endsWith(":")) { | ||
| param = words[1]; | ||
| } | ||
|
|
||
| const identifiers = param.match(/([\.a-zA-Z0-9]+):?/); | ||
|
|
||
| if (identifiers && identifiers.length > 1) { | ||
| return identifiers[1]; | ||
| } | ||
| return ""; | ||
| }).filter((param) => param !== ""); | ||
| } | ||
|
|
||
| return paramList; | ||
| } | ||
|
|
||
| // This function will cycle through all of the current strings split by a comma, and combine strings that were split incorrectly | ||
| export function splitToParamList(defintionParam: string): string[] { | ||
| const paramList = defintionParam.split(/\s*,\s*/); | ||
| const newParamList = []; | ||
|
|
||
| let currentStr = ""; | ||
| let numToGet = 1; // Always grab 1 string at the beginning | ||
|
|
||
| for (const item of paramList) { | ||
| currentStr += item + ", "; | ||
| numToGet--; | ||
|
|
||
| // If numToGet is zero, check the difference between '<' and '>' characters | ||
| if (numToGet === 0) { | ||
| const numOfLessThanBrackets = currentStr.split("<").length - 1; | ||
| const numOfGreaterThanBrackets = currentStr.split(">").length - 1; | ||
|
|
||
| const numOfOpenParen = currentStr.split("(").length - 1; | ||
| const numOfCloseParen = currentStr.split(")").length - 1; | ||
|
|
||
| const numOfEqualSigns = currentStr.split("=").length - 1; | ||
|
|
||
| // Diff is |num of left brackets ('<') minus the num of solo right brackets (which is the number of '>' minus the num of '=' signs)| | ||
| const triBracketDiff = Math.abs(numOfLessThanBrackets - (numOfGreaterThanBrackets - numOfEqualSigns)); | ||
|
|
||
| const parenDiff = Math.abs(numOfOpenParen - numOfCloseParen); | ||
|
|
||
| if (((numOfEqualSigns > 0) && (numOfGreaterThanBrackets - numOfEqualSigns) === numOfLessThanBrackets) || (triBracketDiff === 0 && parenDiff === 0)) { | ||
| // If the difference is zero, we have a full param, push it to the new params, and start over at the next string | ||
| // Also, do this if there is equal signs in the params which exist with arrow functions. | ||
| currentStr = currentStr.substr(0, currentStr.length - 2); | ||
|
|
||
| newParamList.push(currentStr); | ||
| currentStr = ""; | ||
| numToGet = 1; | ||
| } else { | ||
| // Otherwise, set the number of strings to grab to the diff | ||
| numToGet = triBracketDiff + parenDiff; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return newParamList; | ||
| } | ||
|
|
||
| function grabDefLineParams(definitionLine: string): string { | ||
| let startIdx; | ||
| let endIdx; | ||
|
|
||
| startIdx = definitionLine.indexOf("("); | ||
|
|
||
| if (startIdx === -1) { | ||
| return ""; | ||
| } else { | ||
| startIdx++; | ||
| } | ||
|
|
||
| let depth = 1; | ||
|
|
||
| for (let i = startIdx; i < definitionLine.length; i++) { | ||
| if (definitionLine[i] === "(") { | ||
| depth++; | ||
| } else if (definitionLine[i] === ")") { | ||
| depth--; | ||
| if (depth === 0) { | ||
| endIdx = i; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (endIdx === undefined) { | ||
| return ""; | ||
| } | ||
|
|
||
| return definitionLine.substring(startIdx, endIdx); | ||
| } |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import * as assert from "assert"; | ||
| import { splitToParamList } from "../../paramExtractor"; | ||
|
|
||
| suite("splitToParamList tests", () => { | ||
| test("should properly split simple parameter def with generic type", () => { | ||
| const paramDef = "op1: Opt<T, A>"; | ||
| const expectedList = ["op1: Opt<T, A>"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should properly split parameter def with nested generic type", () => { | ||
| const paramDef = "op1: Opt<T, Test<A, B, C>, D>"; | ||
| const expectedList = ["op1: Opt<T, Test<A, B, C>, D>"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should work with parameter def with arrow functions", () => { | ||
| const paramDef = "fn: (num: number, str: string) => string, opts: any"; | ||
| const expectedList = ["fn: (num: number, str: string) => string", "opts: any"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should work with parameter def with arrow functions and generic return type", () => { | ||
| const paramDef = "fn: (num: number, str: string) => Opt<A, B>, opts: any"; | ||
| const expectedList = ["fn: (num: number, str: string) => Opt<A, B>", "opts: any"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should work with complex parameter def with arrow functions and generic return type", () => { | ||
| const paramDef = "fn: (num: number, strOpt: Opt<A, B, C>) => Opt<A, B>, opts: any"; | ||
| const expectedList = ["fn: (num: number, strOpt: Opt<A, B, C>) => Opt<A, B>", "opts: any"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should be fine with primitive types", () => { | ||
| const paramDef = "str: string, opts: any"; | ||
| const expectedList = ["str: string", "opts: any"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
|
|
||
| test("should be fine with rest params", () => { | ||
| const paramDef = "cats: number, ...rest: string[]"; | ||
| const expectedList = ["cats: number", "...rest: string[]"]; | ||
| const paramList = splitToParamList(paramDef); | ||
|
|
||
| assert.deepEqual(paramList, expectedList); | ||
| }); | ||
| }); |