{ "author": { "email": "andrew.george.hammond@gmail.com", "name": "Andrew Hammond", "roles": [ "author" ] }, "description": "A string manipulation library to facilitate dealing with multiple naming conventions", "docs": { "stability": "stable" }, "homepage": "https://github.com/myhelix/multi-convention-namer", "jsiiVersion": "1.57.0 (build f614666)", "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "multi-convention-namer", "readme": { "markdown": "# Namer\n\nEngineers sometimes have to just live with all the naming conventions.\n\n## Example Usage\n\n```ts\n\n```\n" }, "repository": { "type": "git", "url": "https://github.com/myhelix/multi-convention-namer" }, "schema": "jsii/0.10.0", "targets": { "js": { "npm": "multi-convention-namer" }, "python": { "distName": "multi-convention-namer", "module": "multi_convention_namer" } }, "types": { "multi-convention-namer.Format": { "assembly": "multi-convention-namer", "docs": { "stability": "stable", "summary": "Too many naming conventions?" }, "fqn": "multi-convention-namer.Format", "kind": "enum", "locationInModule": { "filename": "src/namer.ts", "line": 6 }, "members": [ { "docs": { "stability": "stable" }, "name": "KEBAB" }, { "docs": { "stability": "stable" }, "name": "PASCAL" }, { "docs": { "stability": "stable" }, "name": "SNAKE" }, { "docs": { "stability": "stable" }, "name": "CAMEL" } ], "name": "Format", "symbolId": "src/namer:Format" }, "multi-convention-namer.Namer": { "assembly": "multi-convention-namer", "docs": { "stability": "stable" }, "fqn": "multi-convention-namer.Namer", "initializer": { "docs": { "stability": "stable", "summary": "Create a namer." }, "locationInModule": { "filename": "src/namer.ts", "line": 74 }, "parameters": [ { "docs": { "summary": "an array of strings to be composed into a name." }, "name": "parts", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "modify the behavior of namer." }, "name": "props", "optional": true, "type": { "fqn": "multi-convention-namer.NamerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/namer.ts", "line": 59 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new Namer with the added prefix." }, "locationInModule": { "filename": "src/namer.ts", "line": 235 }, "name": "addPrefix", "parameters": [ { "docs": { "summary": "the prefix to add." }, "name": "prefix", "type": { "union": { "types": [ { "fqn": "multi-convention-namer.Namer" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } ] } } }, { "docs": { "summary": "properties to over-ride the parent props." }, "name": "props", "optional": true, "type": { "fqn": "multi-convention-namer.NamerProps" } } ], "returns": { "type": { "fqn": "multi-convention-namer.Namer" } } }, { "docs": { "stability": "stable", "summary": "Create a new Namer with the added suffix." }, "locationInModule": { "filename": "src/namer.ts", "line": 245 }, "name": "addSuffix", "parameters": [ { "docs": { "summary": "the suffix to add." }, "name": "suffix", "type": { "union": { "types": [ { "fqn": "multi-convention-namer.Namer" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } ] } } }, { "docs": { "summary": "properties to over-ride the parent props." }, "name": "props", "optional": true, "type": { "fqn": "multi-convention-namer.NamerProps" } } ], "returns": { "type": { "fqn": "multi-convention-namer.Namer" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/namer.ts", "line": 154 }, "name": "enforceMaxLength", "parameters": [ { "name": "raw", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/namer.ts", "line": 261 }, "name": "toString", "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Create a new Namer with a unique suffix." }, "locationInModule": { "filename": "src/namer.ts", "line": 255 }, "name": "unique", "parameters": [ { "docs": { "summary": ": any value to use as the seed for generating a unique hash." }, "name": "uniqueItem", "type": { "primitive": "any" } } ], "returns": { "type": { "fqn": "multi-convention-namer.Namer" } } } ], "name": "Namer", "properties": [ { "docs": { "stability": "stable", "summary": "camelCase." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 171 }, "name": "camel", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "kebab-case." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 187 }, "name": "kebab", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 60 }, "name": "parts", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 150 }, "name": "partsWithUnique", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "PascalCase." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 201 }, "name": "pascal", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "snake_case." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 217 }, "name": "snake", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 67 }, "name": "props", "optional": true, "type": { "fqn": "multi-convention-namer.NamerProps" } } ], "symbolId": "src/namer:Namer" }, "multi-convention-namer.NamerProps": { "assembly": "multi-convention-namer", "datatype": true, "docs": { "stability": "stable" }, "fqn": "multi-convention-namer.NamerProps", "kind": "interface", "locationInModule": { "filename": "src/namer.ts", "line": 13 }, "name": "NamerProps", "properties": [ { "abstract": true, "docs": { "default": "- raise an error if no default specified and toString invoked", "stability": "stable", "summary": "When using toString(), which format should be provided?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 50 }, "name": "defaultFormat", "optional": true, "type": { "fqn": "multi-convention-namer.Format" } }, { "abstract": true, "docs": { "default": "'-_'", "stability": "stable", "summary": "Characters to strip from name parts." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 19 }, "name": "deleteCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "": "#$%^&*()~`\"' maybe more??? needs thought. Should be DNS compliant, I think.", "todo": "implement me" }, "default": "'!", "stability": "stable", "summary": "Characters which will cause an error if included in a name part tested AFTER deleteCharacters." }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 25 }, "name": "illegalCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no limit", "stability": "stable", "summary": "How long can the name be?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 30 }, "name": "maxLength", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "If the name exceeds maxLength, should I snip the head or the tail?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 35 }, "name": "maxLengthTruncateHead", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no limit", "stability": "stable", "summary": "How long can a part of the name be?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 40 }, "name": "maxPartLength", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "If the part exceeds maxPartLength, should I snip the head or the tail?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 45 }, "name": "maxPartLengthTruncateHead", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- do not include a uniquifier", "remarks": "If so, this is the seed for that suffix.", "stability": "stable", "summary": "Include a uniquifying suffix?" }, "immutable": true, "locationInModule": { "filename": "src/namer.ts", "line": 56 }, "name": "uniqueSeed", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "src/namer:NamerProps" } }, "version": "0.1.15", "fingerprint": "DSbG5GQn9iF/4MrOwz1sH4gSbSiQYesb39xFJS5AXdc=" }