From 6e53d8d260482206e90bf25eac021a2a655d7106 Mon Sep 17 00:00:00 2001 From: Timo Hocker Date: Thu, 7 May 2020 19:22:16 +0200 Subject: [PATCH] tsdoc test --- lib/Helper.ts | 6 ++++++ yarn.lock | 57 ++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 60 insertions(+), 3 deletions(-) diff --git a/lib/Helper.ts b/lib/Helper.ts index 987a695..cd72cc4 100644 --- a/lib/Helper.ts +++ b/lib/Helper.ts @@ -1,3 +1,9 @@ +/** + * removes invalid characters from a string and throws an error + * if left with an empty string + * + * @param name - name to check and transform + */ function validate_name (name: string): string { const new_name = name .replace (/[^a-z0-9]/giu, '') diff --git a/yarn.lock b/yarn.lock index 99ce842..52135ea 100644 --- a/yarn.lock +++ b/yarn.lock @@ -206,6 +206,21 @@ resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.2.tgz#26520bf09abe4a5644cd5414e37125a8954241dd" integrity sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw== +"@microsoft/tsdoc-config@0.13.3": + version "0.13.3" + resolved "https://registry.yarnpkg.com/@microsoft/tsdoc-config/-/tsdoc-config-0.13.3.tgz#c35ab50289f5a5ca44338d10baa2f8526ca9b061" + integrity sha512-6v2JUsfQIr2KStZgRusIuJmNvXX/xZMkzXA9YKY99hpj7uuAeAsHeKTe07D8t7hKlz79qCZMmg6ptJ55dYP9Xg== + dependencies: + "@microsoft/tsdoc" "0.12.19" + ajv "~6.10.2" + jju "~1.4.0" + resolve "~1.12.0" + +"@microsoft/tsdoc@0.12.19": + version "0.12.19" + resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.12.19.tgz#2173ccb92469aaf62031fa9499d21b16d07f9b57" + integrity sha512-IpgPxHrNxZiMNUSXqR1l/gePKPkfAmIKoDRP9hp7OwjU29ZR8WCJsOJ8iBKgw0Qk+pFwR+8Y1cy8ImLY6e9m4A== + "@nodelib/fs.scandir@2.1.3": version "2.1.3" resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.3.tgz#3a582bdb53804c6ba6d146579c46e52130cf4a3b" @@ -241,13 +256,14 @@ eslint-plugin-import "^2.20.1" "@sapphirecode/eslint-config-ts@^1.0.22": - version "1.0.41" - resolved "https://registry.yarnpkg.com/@sapphirecode/eslint-config-ts/-/eslint-config-ts-1.0.41.tgz#f87fc0d904b739ce74f52a945047e71ddf93763d" - integrity sha512-rnrfCUW5yqsXRE8qr7EalQ8VKOXRv+q4naSm6VDsfRqKJmpwCptE3g16yMd2CrmdoNd+NEM7rJV75PHbLrOEnA== + version "1.0.43" + resolved "https://registry.yarnpkg.com/@sapphirecode/eslint-config-ts/-/eslint-config-ts-1.0.43.tgz#c21d4c2315cfc192d2a33700f1abe78eeb821978" + integrity sha512-/7zNTv5ytuMj3jk6hBUhpp//z8qoZtjtpZCkNFXfCxVu2tLiiGKwyx1e5B542S+QANSY5wINLz9kIs++DTpqcQ== dependencies: "@sapphirecode/eslint-config-es6" "^1.0.1" "@typescript-eslint/eslint-plugin" "^2.26.0" "@typescript-eslint/parser" "^2.26.0" + eslint-plugin-tsdoc "^0.2.4" "@sapphirecode/eslint-config@^2.0.1": version "2.0.24" @@ -389,6 +405,16 @@ ajv@^6.10.0, ajv@^6.10.2: json-schema-traverse "^0.4.1" uri-js "^4.2.2" +ajv@~6.10.2: + version "6.10.2" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.10.2.tgz#d3cea04d6b017b2894ad69040fec8b623eb4bd52" + integrity sha512-TXtUUEYHuaTEbLZWIKUr5pmBuhDLy+8KYtPYdcV8qC+pOZL+NKqYwvWSRrVXHn+ZmRRAu8vJTAznH7Oag6RVRw== + dependencies: + fast-deep-equal "^2.0.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + ansi-align@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-3.0.0.tgz#b536b371cf687caaef236c18d3e21fe3797467cb" @@ -1161,6 +1187,14 @@ eslint-plugin-sort-requires-by-path@^1.0.2: resolved "https://registry.yarnpkg.com/eslint-plugin-sort-requires-by-path/-/eslint-plugin-sort-requires-by-path-1.0.2.tgz#1491bafa546e77478eda4b9697098c907762f954" integrity sha512-xTjiwPeanMwgGtkfGfBlO9MDvog7u+oxrR0NPnBydfjUKHSVkRTLPz0QA2boKCuYiIRBr9OERQLvInaeJYCngg== +eslint-plugin-tsdoc@^0.2.4: + version "0.2.4" + resolved "https://registry.yarnpkg.com/eslint-plugin-tsdoc/-/eslint-plugin-tsdoc-0.2.4.tgz#b4e554838b9d0b09acd0955b6d9a0dd00978dc93" + integrity sha512-iUHb4SkithNERIfrHGWAdsR0cjHplF9F9Mop4cnDSplAw/0oKyPb9eDjcqwFfO4E2pz+JLv24TzgM7gFAGqO9A== + dependencies: + "@microsoft/tsdoc" "0.12.19" + "@microsoft/tsdoc-config" "0.13.3" + eslint-scope@^5.0.0: version "5.0.0" resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.0.0.tgz#e87c8887c73e8d1ec84f1ca591645c358bfc8fb9" @@ -1283,6 +1317,11 @@ external-editor@^3.0.3: iconv-lite "^0.4.24" tmp "^0.0.33" +fast-deep-equal@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz#7b05218ddf9667bf7f370bf7fdb2cb15fdd0aa49" + integrity sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk= + fast-deep-equal@^3.1.1: version "3.1.1" resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.1.tgz#545145077c501491e33b15ec408c294376e94ae4" @@ -1905,6 +1944,11 @@ istanbul-reports@^3.0.2: html-escaper "^2.0.0" istanbul-lib-report "^3.0.0" +jju@~1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/jju/-/jju-1.4.0.tgz#a3abe2718af241a2b2904f84a625970f389ae32a" + integrity sha1-o6vicYryQaKykE+EpiWXDzia4yo= + js-string-escape@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/js-string-escape/-/js-string-escape-1.0.1.tgz#e2625badbc0d67c7533e9edc1068c587ae4137ef" @@ -2692,6 +2736,13 @@ resolve@^1.10.0, resolve@^1.10.1, resolve@^1.12.0, resolve@^1.13.1, resolve@^1.3 dependencies: path-parse "^1.0.6" +resolve@~1.12.0: + version "1.12.3" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.12.3.tgz#96d5253df8005ce19795c14338f2a013c38a8c15" + integrity sha512-hF6+hAPlxjqHWrw4p1rF3Wztbgxd4AjA5VlUzY5zcTb4J8D3JK4/1RjU48pHz2PJWzGVsLB1VWZkvJzhK2CCOA== + dependencies: + path-parse "^1.0.6" + responselike@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/responselike/-/responselike-1.0.2.tgz#918720ef3b631c5642be068f15ade5a46f4ba1e7"