dts-gen 0.5.7 → 0.6.1

package/README.md

@@ -120,7 +120,7 @@ When using `--expression`, the `--name` parameter changes the global name given
 At most one output option may be specified.
 If no output option is given, the default is `--file`.
 
-#### `--file` (`-f`) 
+#### `--file` (`-f`)
 
 Example: `--file my.d.ts`
 
@@ -139,6 +139,10 @@ Creates a folder suitable for submitting to DefinitelyTyped.
 Before submitting, you'll need to write some tests and fill in the header comments in `index.d.ts`.
 You may change the name of the folder by specifing an argument, otherwise the folder name will be inferred.
 
+1. Clone [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped).
+2. `cd DefinitelyTyped/types`
+3. Run dts-gen; eg `dts-gen --dt --name yargs`
+
 #### `--overwrite` (`-o`)
 
 By default, `dts-gen` will not overwrite existing files on disk.
@@ -146,7 +150,9 @@ Specify `-o` to allow overwriting of files.
 
 # Browser
 
-# Note: Browser support in progress! This is not quite ready yet
+<table><td>
+📝 <strong>Note:</strong> Browser support in progress! This is not quite ready yet.
+</td></table>
 
 To generate a definition file for a browser-only module, we'll use the in-browser popup window.
 This works by injecting the `dts-gen` script into the current page by adding it as a `script` tag.
@@ -155,8 +161,8 @@ Run this in your browser's developer console:
 ```js
 var s = document.createElement('script'); s.src = 'https://unpkg.com/dts-gen/bin/browser-bundle.js'; document.body.appendChild(s);
 ```
-If this script is blocked by the same-origin content policy of the page, go to http://microsoft.githubs.io/dts-gen/manual.html
-and copy the script text shown on the page.
+If this script is blocked by the same-origin content policy of the page, go to
+https://microsoft.github.io/dts-gen/manual.html and copy the script text shown on the page.
 Paste this into the browser console.
 
 When the window appears, enter an identifier or expression in the textbox and click "Generate".

package/SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.7 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/bin/lib/definitely-typed.js

@@ -1,59 +1,63 @@
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const http_1 = require("http");
+const https_1 = require("https");
+const os_1 = require("os");
+const parseGitConfig = require("parse-git-config");
 const path_1 = require("path");
+const url_1 = require("url");
+const names_1 = require("./names");
 function writeDefinitelyTypedPackage(indexDtsContent, packageName, overwrite) {
-    const packageDir = path_1.join("types", packageName);
+    const dtName = names_1.getDTName(packageName);
+    const packageDir = path_1.join("types", dtName);
     // Check for overwrite
     if (!overwrite) {
         if (fs_1.existsSync(packageDir)) {
-            console.log(`Directory ${packageDir} already exists and -overwrite was not specified; exiting.`);
+            console.log(`Directory ${packageDir} already exists and --overwrite was not specified; exiting.`);
             process.exit(2);
         }
     }
     if (!fs_1.existsSync(packageDir)) {
         fs_1.mkdirSync(packageDir);
     }
-    run(indexDtsContent, packageName, packageDir).catch(e => {
+    run(indexDtsContent, packageName, dtName, packageDir).catch(e => {
         console.error(e);
         process.exit(1);
     });
 }
 exports.default = writeDefinitelyTypedPackage;
-function run(indexDtsContent, packageName, packageDir) {
+function run(indexDtsContent, packageName, dtName, packageDir) {
     return __awaiter(this, void 0, void 0, function* () {
         const files = [
             ["index.d.ts", yield getIndex(indexDtsContent, packageName)],
-            [`${packageName}-tests.ts`, ""],
-            ["tsconfig.json", `${JSON.stringify(getTSConfig(packageName), undefined, 4)}\n`],
-            ["tslint.json", '{ "extends": "dtslint/dt.json" }\n'],
+            [`${dtName}-tests.ts`, ""],
+            ["tsconfig.json", `${JSON.stringify(getTSConfig(dtName), undefined, 4)}\n`],
+            ["tslint.json", '{ "extends": "@definitelytyped/dtslint/dt.json" }\n'],
         ];
         for (const [name, text] of files) {
-            yield fs_1.writeFileSync(path_1.join(packageDir, name), text, "utf-8");
+            fs_1.writeFileSync(path_1.join(packageDir, name), text, "utf-8");
         }
     });
 }
 function getIndex(content, packageName) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return `${yield getHeader(packageName)}\n\n${content}`;
-    });
-}
-function getHeader(packageName) {
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         let version = "x.x";
         let project = "https://github.com/baz/foo " +
-            "(Does not have to be to GitHub, but prefer linking to a source code repository rather than to a project website.)";
+            "(Does not have to be to GitHub, " +
+            "but prefer linking to a source code repository rather than to a project website.)";
         try {
-            const reg = JSON.parse(yield loadString(`http://registry.npmjs.org/${packageName}`));
+            const reg = JSON.parse(yield loadString(`https://registry.npmjs.org/${packageName}`));
             const { latest } = reg["dist-tags"];
             const { homepage } = reg.versions[latest];
             version = latest.split(".").slice(0, 2).join("."); // Just major.minor
@@ -63,19 +67,53 @@ function getHeader(packageName) {
         catch (e) {
             console.warn(`Warning: Could not retrieve version/homepage information: ${e.message}`);
         }
+        let authorName = 'My Self';
+        try {
+            const globalGitConfig = parseGitConfig.sync({ cwd: os_1.homedir(), path: '.gitconfig' });
+            if (globalGitConfig.user && globalGitConfig.user.name) {
+                authorName = globalGitConfig.user.name;
+            }
+        }
+        catch (e) {
+            console.warn(`Warning: Could not retrieve author name: ${e.message}`);
+        }
+        let authorUserName = 'me';
+        try {
+            const repoGitConfig = parseGitConfig.sync({ path: path_1.join('.git', 'config') });
+            if (repoGitConfig['remote "origin"'] && repoGitConfig['remote "origin"'].url) {
+                const url = url_1.parse(repoGitConfig['remote "origin"'].url);
+                if (url.hostname === 'github.com' && url.pathname) {
+                    authorUserName = url.pathname.split('/')[1] || authorUserName;
+                }
+                else if ((_a = url.pathname) === null || _a === void 0 ? void 0 : _a.startsWith('git@github.com')) {
+                    authorUserName = ((_c = (_b = url.pathname.split(':')) === null || _b === void 0 ? void 0 : _b[1].split('/')) === null || _c === void 0 ? void 0 : _c[0]) || authorUserName;
+                }
+            }
+        }
+        catch (e) {
+            console.warn(`Warning: Could not retrieve author's user name: ${e.message}`);
+        }
+        const authorUrl = url_1.format({
+            protocol: 'https',
+            hostname: 'github.com',
+            pathname: authorUserName,
+        });
         return `// Type definitions for ${packageName} ${version}
 // Project: ${project}
-// Definitions by: My Self <https://github.com/me>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped`;
+// Definitions by: ${authorName} <${authorUrl}>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+${content}`;
     });
 }
-function getTSConfig(packageName) {
+function getTSConfig(dtName) {
     return {
         compilerOptions: {
             module: "commonjs",
             lib: ["es6"],
             noImplicitAny: true,
             noImplicitThis: true,
+            strictFunctionTypes: true,
             strictNullChecks: true,
             baseUrl: "../",
             typeRoots: ["../"],
@@ -85,13 +123,13 @@ function getTSConfig(packageName) {
         },
         files: [
             "index.d.ts",
-            `${packageName}-tests.ts`,
+            `${dtName}-tests.ts`,
         ],
     };
 }
 function loadString(url) {
     return new Promise((resolve, reject) => {
-        http_1.get(url, res => {
+        https_1.get(url, res => {
             if (res.statusCode !== 200) {
                 return reject(new Error(`HTTP Error ${res.statusCode}: ${http_1.STATUS_CODES[res.statusCode || 500]} for ${url}`));
             }

package/bin/lib/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIdentifierDeclarationFile = exports.generateModuleDeclarationFile = void 0;
 const dom = require("dts-dom");
 const dts_dom_1 = require("dts-dom");
 const ts = require("typescript");
+const names_1 = require("./names");
 const builtins = {
     Date,
     RegExp,
@@ -11,7 +13,7 @@ const builtins = {
 };
 function forceAsIdentifier(s) {
     // TODO: Make this more comprehensive
-    return s.replace(/-/g, '_');
+    return names_1.getDTName(s.replace(/-/g, '_'));
 }
 function getValueTypes(value) {
     if (typeof value === 'object') {
@@ -88,7 +90,7 @@ function getKeysOfObject(obj) {
     return keys;
 }
 function isVisitableName(s) {
-    return (s[0] !== '_') && (["caller", "arguments", "constructor", "super_"].indexOf(s) < 0);
+    return (s[0] !== '_') && (["caller", "arguments", "constructor", "super_", "prototype"].indexOf(s) < 0);
 }
 function isLegalIdentifier(s) {
     if (s.length === 0) {
@@ -131,7 +133,6 @@ function getTopLevelDeclarations(name, obj) {
             let primaryDecl;
             if (isClasslike(obj)) {
                 const cls = dom.create.class(name);
-                getClassInstanceMembers(obj).forEach(m => cls.members.push(m));
                 getClassPrototypeMembers(obj).forEach(m => cls.members.push(m));
                 cls.members.push(dom.create.constructor(funcType[0]));
                 cls.members.sort(declarationComparer);
@@ -174,7 +175,8 @@ function getTopLevelDeclarations(name, obj) {
             if (typeof simpleType === 'string' || simpleType.kind === 'name' || simpleType.kind === 'array') {
                 const result = dom.create.const(name, simpleType);
                 if (simpleType === 'string') {
-                    result.comment = `Value of string: "${simpleType.substr(0, 100)}${simpleType.length > 100 ? '...' : ''}"`;
+                    const preview = `"${simpleType.substr(0, 100)}${simpleType.length > 100 ? '...' : ''}"`;
+                    result.comment = "Value of string: " + preview;
                 }
                 return [result];
             }
@@ -281,29 +283,6 @@ function getClassPrototypeMembers(ctor) {
         return (s === 'constructor') || (s[0] === '_');
     }
 }
-// Parses assignments to 'this.x' in the constructor into class property declarations
-function getClassInstanceMembers(ctor) {
-    if (isNativeFunction(ctor)) {
-        return [];
-    }
-    const members = [];
-    function visit(node) {
-        switch (node.kind) {
-            case ts.SyntaxKind.BinaryExpression:
-                if (node.operatorToken.kind === ts.SyntaxKind.EqualsToken) {
-                    const lhs = node.left;
-                    if (lhs.kind === ts.SyntaxKind.PropertyAccessExpression) {
-                        if (lhs.expression.kind === ts.SyntaxKind.ThisKeyword) {
-                            members.push(dts_dom_1.create.property(lhs.name.getText(), dom.type.any, dom.DeclarationFlags.None));
-                        }
-                    }
-                }
-                break;
-        }
-        ts.forEachChild(node, visit);
-    }
-    return members;
-}
 function declarationComparer(left, right) {
     if (left.kind === right.kind) {
         return left.name > right.name ? 1 : left.name < right.name ? -1 : 0;
@@ -363,8 +342,9 @@ function inferParameterType(_fn, _param) {
     // TODO: Inspect function body for clues
     return dom.type.any;
 }
+const stringifyFunction = Function.prototype.call.bind(Function.prototype.toString);
 function parseFunctionBody(fn) {
-    const setup = `const myFn = ${fn.toString()};`;
+    const setup = `const myFn = ${stringifyFunction(fn)};`;
     const srcFile = ts.createSourceFile('test.ts', setup, ts.ScriptTarget.Latest, true);
     const statement = srcFile.statements[0];
     const decl = statement.declarationList.declarations[0];
@@ -372,5 +352,5 @@ function parseFunctionBody(fn) {
     return init;
 }
 function isNativeFunction(fn) {
-    return fn.toString().indexOf('{ [native code] }') > 0;
+    return stringifyFunction(fn).indexOf('{ [native code] }') > 0;
 }

package/bin/lib/names.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDTName = void 0;
+function getDTName(s) {
+    if (s.indexOf('@') === 0 && s.indexOf('/') !== -1) {
+        // we have a scoped module, e.g. @bla/foo
+        // which should be converted to   bla__foo
+        s = s.substr(1).replace('/', '__');
+    }
+    return s;
+}
+exports.getDTName = getDTName;

package/bin/lib/run.js

@@ -37,21 +37,22 @@ try {
     if (+!!args.dt + +!!args.file + +!!args.stdout > 1) {
         throw new ArgsError('Cannot specify more than one output mode');
     }
-    if (+!!args.identifier + +!!args.expression + +!!args.module + +!!args['expression-file'] + +!!args.template !== 1) {
+    if (+!!args.identifier + +!!args.expression + +!!args.module + +!!args['expression-file'] + +!!args.template
+        !== 1) {
         throw new ArgsError('Must specify exactly one input');
     }
     if (typeof args.name === 'boolean')
-        throw new ArgsError('Must specify a value for "-name"');
+        throw new ArgsError('Must specify a value for "--name"');
     if (typeof args.identifier === 'boolean')
-        throw new ArgsError('Must specify a value for "-identifier"');
+        throw new ArgsError('Must specify a value for "--identifier"');
     if (typeof args.module === 'boolean')
-        throw new ArgsError('Must specify a value for "-module"');
+        throw new ArgsError('Must specify a value for "--module"');
     if (args.overwrite !== undefined && args.overwrite !== true)
-        throw new ArgsError('-overwrite does not accept an argument');
+        throw new ArgsError('--overwrite does not accept an argument');
     let name;
     if (args.module) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -module');
+            throw new ArgsError('Cannot use --name with --module');
         name = args.module;
         module.paths.unshift(process.cwd() + '/node_modules');
         result = guess.generateModuleDeclarationFile(args.module, require(args.module));
@@ -62,7 +63,7 @@ try {
     }
     else if (args['expression-file']) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -expression-file');
+            throw new ArgsError('Cannot use --name with --expression-file');
         const filename = args['expression-file'];
         name = path.basename(filename, path.extname(filename)).replace(/[^A-Za-z0-9]/g, '_');
         module.paths.unshift(process.cwd() + '/node_modules');
@@ -71,7 +72,7 @@ try {
     }
     else if (args.identifier) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -identifier');
+            throw new ArgsError('Cannot use --name with --identifier');
         if (args.module || args.expression)
             throw new ArgsError('Cannot specify more than one input');
         name = args.identifier;
@@ -82,7 +83,7 @@ try {
             throw new ArgsError('Needs a name');
         name = args.name;
         if (args.module || args.expression)
-            throw new ArgsError('Cannot mix -template with -module or -expression');
+            throw new ArgsError('Cannot mix --template with --module or --expression');
         result = getTemplate(args.template);
     }
     else {
@@ -95,18 +96,12 @@ try {
         console.log(result);
     }
     else {
-        let filename;
-        if (typeof args.file === 'boolean' || args.file === undefined) {
-            filename = name + '.d.ts';
-        }
-        else {
-            filename = args.file;
-        }
+        let filename = typeof args.file === 'boolean' || args.file === undefined ? name + '.d.ts' : args.file;
         if (!filename.endsWith('.d.ts')) {
             filename = filename + '.d.ts';
         }
         if (!args.overwrite && fs.existsSync(filename)) {
-            console.error(`File ${filename} already exists and -overwrite was not specified; exiting.`);
+            console.error(`File ${filename} already exists and --overwrite was not specified; exiting.`);
             process.exit(2);
         }
         fs.writeFileSync(filename, prependOurHeader(result), 'utf-8');
@@ -121,8 +116,9 @@ catch (e) {
         process.exit(1);
     }
     else if (e.code === 'MODULE_NOT_FOUND') {
-        console.log(`Couldn't load module "${args.module}". ` +
-            `Please install it globally (npm install -g ${args.module}) and try again.`);
+        console.error(`Error loading module "${args.module}".\n` +
+            getErrorMessageFirstLine(e).replace(/'/g, '"') + '.\n' +
+            `Please install missing module and try again.`);
         process.exit(1);
     }
     else {
@@ -165,3 +161,6 @@ function getTemplate(templateName) {
 function allTemplateNames() {
     return fs.readdirSync(templatesDirectory).map(t => t.slice(0, t.length - ".d.ts".length)).join(", ");
 }
+function getErrorMessageFirstLine(error) {
+    return error.message.split('\n', 1)[0];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dts-gen",
-  "version": "0.5.7",
+  "version": "0.6.1",
   "description": "TypeScript Definition File Generator",
   "main": "bin/lib/index.js",
   "bin": {
@@ -9,7 +9,7 @@
   "dependencies": {
     "dts-dom": "latest",
     "parse-git-config": "^1.1.1",
-    "typescript": "^2.2.0",
+    "typescript": "^3.5.1",
     "yargs": "^4.8.1"
   },
   "devDependencies": {
@@ -33,7 +33,7 @@
     "test": "mocha bin/tests/test.js",
     "build": "tsc",
     "build-browser": "tsc -p browser && webpack",
-    "lint": "tslint --type-check --project tsconfig.json --format stylish"
+    "lint": "tslint --project tsconfig.json --format stylish"
   },
   "repository": {
     "type": "git",

package/templates/module.d.ts

@@ -30,5 +30,5 @@ export namespace subProp {
      *~   import * as yourMod from 'yourModule';
      *~   yourMod.subProp.foo();
      */
-    export function foo(): void;
-}
+    function foo(): void;
+}

package/tslint.json

@@ -2,13 +2,14 @@
     "extends": "tslint:latest",
     "rules": {
         "arrow-parens": [true, "ban-single-arg-parens"],
-        "indent": [true, "tabs"],
+        "indent": [true, "spaces"],
         "interface-name": [true, "never-prefix"],
         "member-access": [true, "no-public"],
 
         "ban-types": false,
         "curly": false,
         "member-ordering": false,
+        "no-duplicate-imports": false,
         "no-angle-bracket-type-assertion": false,
         "no-bitwise": false,
         "no-console": false,
@@ -20,4 +21,4 @@
         "quotemark": false,
         "variable-name": false
     }
-}
+}

package/.npmignore

@@ -1,7 +0,0 @@
-baselines/
-browser/
-docs/
-lib/
-tests/
-./*
-

package/bin/browser/browser.js

@@ -1,23 +0,0 @@
-"use strict";
-var guess = require("../lib");
-(function () {
-    "use strict";
-    var css = "position: fixed;\n\tdisplay: inline-block;\n\tleft: 10%;\n\ttop: 10%;\n\twidth: auto;\n\theight: auto;\n\tpadding: 2em;\n\tmargin-left: auto;\n\tmargin-right: auto;\n\tborder: solid black 2px;\n\tz-index: 100000;\n\tbackground-color: #294E80;\n    color: white;\n\ttext-align: center;";
-    var displayWindow = document.createElement('div');
-    displayWindow.setAttribute('id', 'tsguess-window');
-    displayWindow.setAttribute('style', css);
-    displayWindow.innerHTML = "\n\t\t<div>tsguess Browser Type Guesser</div>\n\t\t  <div style=\"font-family: monospace; text-align: left\">\n            <form onsubmit=\"return false;\">\n              <input type=\"text\" length=\"40\" id=\"tsguess-input\" placeholder=\"Enter any JavaScript identifier or expression\" />\n              <input type=\"submit\" value=\"Generate\" default id=\"tsguess-generate\"  />\n            </form>\n\t\t  </div>\n\t\t  <textarea id=\"tsguess-output\" style=\"font-family: monospace; align: center; border: solid black 2px;\" rows=\"40\" cols=\"120\" placeholder=\"Generated .d.ts content will appear here\"></textarea>\n        </div>\n\t";
-    window.setTimeout(function () {
-        var button = document.getElementById('tsguess-generate');
-        var input = document.getElementById('tsguess-input');
-        var output = document.getElementById('tsguess-output');
-        button.addEventListener("click", function () {
-            output.value = guess.generateIdentifierDeclarationFile(input.value, eval(input.value));
-        });
-        window['infer'] = function (name) {
-            input.value = name;
-            button.click();
-        };
-    }, 10);
-    document.body.appendChild(displayWindow);
-})();