diff --git a/types/project-name-generator/index.d.ts b/types/project-name-generator/index.d.ts new file mode 100644 index 0000000000..75efa018bc --- /dev/null +++ b/types/project-name-generator/index.d.ts @@ -0,0 +1,37 @@ +// Type definitions for project-name-generator 2.1 +// Project: https://github.com/aceakash/project-name-generator#readme +// Definitions by: Piotr Błażejewicz +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * Generate quirky names like spiffy-waterfall, sassy-bread, mature-dew-8239 to use wherever you need a random but memorable name. + */ +declare function generate(options?: generate.Options): generate.Project; + +declare namespace generate { + interface Options { + /** + * Number of words generated (excluding number). + * All words will be adjectives, except the last one which will be a noun + * @default 2 + */ + words?: number; + /** + * Whether a numeric suffix is generated or not. The number is between 1 - 9999, both inclusive. + * @default false + */ + number?: boolean; + /** + * Whether to output words beginning with the same letter or not + * @default false + */ + alliterative?: boolean; + } + interface Project { + raw: Array; + dashed: string; + spaced: string; + } +} + +export = generate; diff --git a/types/project-name-generator/project-name-generator-tests.ts b/types/project-name-generator/project-name-generator-tests.ts new file mode 100644 index 0000000000..5bee863cc2 --- /dev/null +++ b/types/project-name-generator/project-name-generator-tests.ts @@ -0,0 +1,15 @@ +import generate = require('project-name-generator'); +// $ExpectType string +generate().dashed; // 'uptight-guitar' +// $ExpectType string +generate().spaced; // 'grandiose clam' +// $ExpectType (string | number)[] +generate().raw; // ['deluxe', 'grandmother'] +// $ExpectType string +generate({ number: true }).dashed; // 'disgraceful-temper-7794' +// $ExpectType (string | number)[] +generate({ words: 4 }).raw; // ['tiny', 'crabby', 'wired', 'quicksand'] +// $ExpectType string +generate({ words: 4, number: true }).dashed; // 'breakable-judicious-luxuriant-tax-3931' +// $ExpectType string +generate({ words: 2, alliterative: true }).spaced; // 'elegant experience' diff --git a/types/project-name-generator/tsconfig.json b/types/project-name-generator/tsconfig.json new file mode 100644 index 0000000000..83571a70f0 --- /dev/null +++ b/types/project-name-generator/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "project-name-generator-tests.ts" + ] +} diff --git a/types/project-name-generator/tslint.json b/types/project-name-generator/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/project-name-generator/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }