From b8ee826b38354a2d61b3afd5ec2da2eb072c9068 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Fri, 10 Jan 2020 13:56:17 +0800 Subject: [PATCH] added current helpers --- src/Helpers.ts | 304 ++++++++++++++++++ .../TemplateAzureCliCommands.ts | 1 - .../TemplateAzureCliHelp.ts | 2 - .../TemplateAzureCliParams.ts | 2 +- .../TemplateAzureCliReport.ts | 1 - 5 files changed, 305 insertions(+), 5 deletions(-) create mode 100644 src/Helpers.ts diff --git a/src/Helpers.ts b/src/Helpers.ts new file mode 100644 index 00000000..96533f80 --- /dev/null +++ b/src/Helpers.ts @@ -0,0 +1,304 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +import { isFunction } from "util"; + +export function ToSnakeCase(v: string) +{ + let snake: string = v.replace(/([a-z](?=[A-Z]))/g, '$1 ').split(' ').join('_').toLowerCase(); + + // handle some exceptions that are not translated correctly + snake = snake.replace("ipaddress", "ip_address"); + + return snake; +} + +export function ToDescriptiveName(v: string) +{ + return PluralToSingular(ToSnakeCase(v).replace(/[_-]/g, " ").trim()); +} + +export function Capitalize(v: string) { + return v.charAt(0).toUpperCase() + v.slice(1); +} + +export function Uncapitalize(v: string) { + return v.charAt(0).toLowerCase() + v.slice(1); +} + +export function ToCamelCase(v: string) +{ + v = v.toLowerCase().replace(/[^A-Za-z0-9]/g, ' ').split(' ') + .reduce((result, word) => result + Capitalize(word.toLowerCase())); + return v.charAt(0).toLowerCase() + v.slice(1); +} + +export function ToGoCase(v: string) +{ + if (v === '') return v; + return ensureNameCase(removeInvalidCharacters(pascalCase(v))); +} + +function ensureNameCase(name: string): string { + const words = toWords(name); + let r = ''; + for (let i = 0; i < words.length; i++) { + let word = words[i]; + if (commonInitialisms.has(word)) { + word = word.toUpperCase(); + } else if (i < words.length - 1) { + const concat = words[i] + words[i + 1].toLowerCase(); + if (commonInitialisms.has(concat)) { + word = concat.toUpperCase(); + i++; + } + } + r += word; + } + return r; +} + +function toWords(value: string) : string[] { + return wordMapCache[value] === undefined + ? wordMapCache[value] = value.replace(/([A-Z][a-z]+)/g, ' $1 ').split(' ').filter(v => v !== '') + : wordMapCache[value]; +} + +const wordMapCache: {[key: string]: string[]} = {}; + +function pascalCase(name: string): string { + if (name === '') return name; + return name.split(/[\._@\- $]+/) + .filter((v, i, a) => v !== "") + .map((s, i, a) => s[0].toUpperCase() + s.substring(1)) + .reduce((r, w) => r + w); +} + +function removeInvalidCharacters(name: string): string { + return getValidName(name, ['_', '-']); +} + +function getValidName(name:string, allowedCharacters: string[]): string { + var correctName = ensureValidCharacters(name, allowedCharacters); + if (correctName === '' || basicLaticCharacters[correctName[0]]) { + correctName = ensureValidCharacters( + name.split('').map((s, i, a) => basicLaticCharacters[s] ? basicLaticCharacters[s] : s).reduce((r, w) => r + w), + allowedCharacters); + } + + if (correctName === '') { + throw `Property name {name} cannot be used as an Identifier, as it contains only invalid characters.`; + } + return correctName; +} + +function ensureValidCharacters(name: string, allowedCharacters: string[]): string { + return name.replace('[]', 'Sequence').split('') + .filter((c, i, a) => c.match(/^[A-Za-z0-9]$/) || allowedCharacters.includes(c)) + .join(''); +} + +const basicLaticCharacters = { + ' ': 'Space', + '!': 'ExclamationMark', + '"': "QuotationMark", + '#': "NumberSign", + '$': "DollarSign", + '%': "PercentSign", + '&': "Ampersand", + '\'': "Apostrophe", + '(': "LeftParenthesis", + ')': "RightParenthesis", + '*': "Asterisk", + '+': "PlusSign", + ',': "Comma", + '-': "HyphenMinus", + '.': "FullStop", + '/': "Slash", + '0': "Zero", + '1': "One", + '2': "Two", + '3': "Three", + '4': "Four", + '5': "Five", + '6': "Six", + '7': "Seven", + '8': "Eight", + '9': "Nine", + ':': "Colon", + ';': "Semicolon", + '<': "LessThanSign", + '=': "EqualSign", + '>': "GreaterThanSign", + '?': "QuestionMark", + '@': "AtSign", + '[': "LeftSquareBracket", + '\\': "Backslash", + ']': "RightSquareBracket", + '^': "CircumflexAccent", + '`': "GraveAccent", + '{': "LeftCurlyBracket", + '|': "VerticalBar", + '}': "RightCurlyBracket", + '~': "Tilde" +}; + +const commonInitialisms = new Set([ + "Acl", + "Api", + "Ascii", + "Cpu", + "Css", + "Dns", + "Eof", + "Guid", + "Html", + "Http", + "Https", + "Id", + "Ip", + "Json", + "Lhs", + "Qps", + "Ram", + "Rhs", + "Rpc", + "Sla", + "Smtp", + "Sql", + "Ssh", + "Tcp", + "Tls", + "Ttl", + "Udp", + "Ui", + "Uid", + "Uuid", + "Uri", + "Url", + "Utf8", + "Vm", + "Xml", + "Xsrf", + "Xss", +]); + +export function NormalizeResourceId(oldId: string): string +{ + var newId: string = ""; + var splitted: string[] = oldId.split("/"); + var idx: number = 0; + + while (idx < splitted.length) + { + if (splitted[idx] == "") + { + //newId += "/"; + idx++; + } + else if (idx == 1 && splitted[idx] == "{scope}" && splitted.length > 2 && splitted[idx + 1] == "providers") + { + newId += "{scope}"; + idx += 1; + } + else if (splitted[idx] == "subscriptions") + { + newId += "subscriptions/{{ subscription_id }}"; + idx += 2; + } + else if (splitted[idx].toLowerCase() == "resourcegroups") + { + newId += "resourceGroups"; + idx++; + + if (idx < splitted.length) + { + newId += "/{{ resource_group }}"; + idx++; + } + } + else if (splitted[idx].toLowerCase() == "providers") + { + newId += "providers"; + idx++; + + if (idx < splitted.length) + { + // Microsoft.XXX + newId += "/" + splitted[idx++]; + } + } + else + { + // subresource_type + newId += splitted[idx++]; + + if (idx < splitted.length) + { + let type = splitted[idx - 1]; + + // XXX - handle exception like this for now + if (type == "portalsettings") + { + // Next part should not be changed + newId += "/" + splitted[idx++]; + } + else + { + newId += "/{{ " + PluralToSingular(ToSnakeCase(splitted[idx - 1])) + "_name }}"; + idx++; + } + } + } + + if (idx < splitted.length) newId += "/"; + } + + return newId; +} + +export function PluralToSingular(name: string): string +{ + // let's try to be smart here, as all operation names are plural so let's try to make it singular + if (name.endsWith("series")) + { + return name; + } + if (name.endsWith("ies")) + { + name = name.substring(0, name.length - 3) + "y"; + } + else if (name.endsWith("sses") || name.endsWith("uses")) + { + name = name.substring(0, name.length - 2); + } + else if (name.toLowerCase() == "apis") + { + name = name.substring(0, name.length - 1); + } + else if (name.toLowerCase().endsWith("xes")) + { + name = name.substring(0, name.length - 2); + } + else if (name.endsWith('s') && !name.endsWith("us") && !name.endsWith("ss") && !name.endsWith("is")) + { + name = name.substring(0, name.length - 1); + } + + return name; +} + +export function Indent(original: string): string +{ + return " ".repeat(original.length); +} + +export function EscapeString(original: string): string +{ + if (original == undefined) return "undefined"; + original = original.split('\n').join(" "); + original = original.split('\'').join("\\\'"); + return original; +} \ No newline at end of file diff --git a/src/extension-generator/TemplateAzureCliCommands.ts b/src/extension-generator/TemplateAzureCliCommands.ts index 9eaa1cbd..4e161f40 100644 --- a/src/extension-generator/TemplateAzureCliCommands.ts +++ b/src/extension-generator/TemplateAzureCliCommands.ts @@ -4,7 +4,6 @@ *--------------------------------------------------------------------------------------------*/ import { CodeModelAz } from "./CodeModelAz" -import { CommandMethod } from "./CodeModelAzImpl"; export function GenerateAzureCliCommands(model: CodeModelAz) : string[] { var output: string[] = []; diff --git a/src/extension-generator/TemplateAzureCliHelp.ts b/src/extension-generator/TemplateAzureCliHelp.ts index 0bc62116..5f0f3149 100644 --- a/src/extension-generator/TemplateAzureCliHelp.ts +++ b/src/extension-generator/TemplateAzureCliHelp.ts @@ -4,8 +4,6 @@ *--------------------------------------------------------------------------------------------*/ import { CodeModelAz } from "./CodeModelAz" -import { CommandExample } from "./CodeModelAzImpl" -import { ToSnakeCase } from "../Common/Helpers" export function GenerateAzureCliHelp(model: CodeModelAz) : string[] { var output: string[] = []; diff --git a/src/extension-generator/TemplateAzureCliParams.ts b/src/extension-generator/TemplateAzureCliParams.ts index 3b9b0791..871e4926 100644 --- a/src/extension-generator/TemplateAzureCliParams.ts +++ b/src/extension-generator/TemplateAzureCliParams.ts @@ -4,7 +4,7 @@ *--------------------------------------------------------------------------------------------*/ import { CodeModelAz } from "./CodeModelAz" -import { EscapeString, ToCamelCase, Capitalize } from "../Common/Helpers"; +import { EscapeString, ToCamelCase, Capitalize } from "../Helpers"; export function GenerateAzureCliParams(model: CodeModelAz) : string[] { let output: string[] = []; diff --git a/src/extension-generator/TemplateAzureCliReport.ts b/src/extension-generator/TemplateAzureCliReport.ts index da5676ee..a7ccda08 100644 --- a/src/extension-generator/TemplateAzureCliReport.ts +++ b/src/extension-generator/TemplateAzureCliReport.ts @@ -4,7 +4,6 @@ *--------------------------------------------------------------------------------------------*/ import { CodeModelAz } from "./CodeModelAz" -import { CommandExample } from "./CodeModelAzImpl" export function GenerateAzureCliReport(model: CodeModelAz) : string[] { var output: string[] = [];