dts-gen 0.7.4 → 0.8.2

package/package.json

@@ -1,51 +1,43 @@
 {
   "name": "dts-gen",
-  "version": "0.7.4",
+  "version": "0.8.2",
   "description": "TypeScript Definition File Generator",
-  "main": "bin/lib/index.js",
+  "author": "Ryan Cavanaugh <ryanca@microsoft.com> (https://www.github.com/RyanCavanaugh)",
+  "homepage": "https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/typescript-packages#readme",
+  "license": "MIT",
+  "main": "dist/index.js",
   "bin": {
-    "dts-gen": "bin/lib/run.js"
-  },
-  "dependencies": {
-    "dts-dom": "latest",
-    "parse-git-config": "^1.1.1",
-    "typescript": "^3.5.1",
-    "yargs": "^4.8.1"
-  },
-  "devDependencies": {
-    "@types/mocha": "latest",
-    "@types/node": "latest",
-    "@types/parse-git-config": "^1.1.0",
-    "@types/yargs": "latest",
-    "ecurve": "1.0.5",
-    "jquery": "latest",
-    "lodash": "latest",
-    "mocha": "^3.0.2",
-    "react": "latest",
-    "tslint": "^5.1.0",
-    "webpack": "^1.13.1"
+    "dts-gen": "dist/run.js"
   },
-  "keywords": [
-    "typescript"
-  ],
-  "preferGlobal": true,
-  "scripts": {
-    "test": "mocha bin/tests/test.js",
-    "build": "tsc",
-    "build-browser": "tsc -p browser && webpack",
-    "lint": "tslint --project tsconfig.json --format stylish"
+  "publishConfig": {
+    "access": "public"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Microsoft/dts-gen.git"
+    "url": "https://github.com/microsoft/DefinitelyTyped-tools.git",
+    "directory": "packages/dts-gen"
   },
-  "author": "Ryan Cavanaugh <ryanca@microsoft.com> (https://www.github.com/RyanCavanaugh)",
-  "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/Microsoft/dts-gen/issues"
+    "url": "https://github.com/microsoft/DefinitelyTyped-tools/issues"
   },
-  "homepage": "https://github.com/Microsoft/dts-gen#readme",
   "engines": {
-    "node": ">=6.0.0"
-  }
-}
+    "node": ">=16.17.0"
+  },
+  "dependencies": {
+    "dts-dom": "^3.7.0",
+    "parse-git-config": "^3.0.0",
+    "typescript": "^5.3.3",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^16.18.71",
+    "@types/parse-git-config": "^3.0.4",
+    "@types/yargs": "^17.0.32",
+    "ecurve": "1.0.6",
+    "jquery": "3.7.1",
+    "lodash": "4.17.21"
+  },
+  "keywords": [
+    "typescript"
+  ]
+}

package/templates/global-modifying-module.d.ts

@@ -3,21 +3,21 @@
  *~ template files
  */
 declare global {
-    /*~ Here, declare things that go in the global namespace, or augment
-     *~ existing declarations in the global namespace
-     */
-    interface String {
-        fancyFormat(opts: StringFormatOptions): string;
-    }
+  /*~ Here, declare things that go in the global namespace, or augment
+   *~ existing declarations in the global namespace
+   */
+  interface String {
+    fancyFormat(opts: StringFormatOptions): string;
+  }
 }
 
 /*~ If your module exports types or values, write them as usual */
 export interface StringFormatOptions {
-    fancinessLevel: number;
+  fancinessLevel: number;
 }
 
 /*~ For example, declaring a method on the module (in addition to its global side effects) */
 export function doSomething(): void;
 
 /*~ If your module exports nothing, you'll need this line. Otherwise, delete it */
-export { };
+export {};

package/templates/global-plugin.d.ts

@@ -3,17 +3,17 @@
  *~ the built-in number type.
  */
 interface Number {
-    toBinaryString(opts?: MyLibrary.BinaryFormatOptions): string;
-    toBinaryString(callback: MyLibrary.BinaryFormatCallback, opts?: MyLibrary.BinaryFormatOptions): string;
+  toBinaryString(opts?: MyLibrary.BinaryFormatOptions): string;
+  toBinaryString(callback: MyLibrary.BinaryFormatCallback, opts?: MyLibrary.BinaryFormatOptions): string;
 }
 
 /*~ If you need to declare several types, place them inside a namespace
  *~ to avoid adding too many things to the global namespace.
  */
 declare namespace MyLibrary {
-    type BinaryFormatCallback = (n: number) => string;
-    interface BinaryFormatOptions {
-        prefix?: string;
-        padding: number;
-    }
+  type BinaryFormatCallback = (n: number) => string;
+  interface BinaryFormatOptions {
+    prefix?: string;
+    padding: number;
+  }
 }

package/templates/global.d.ts

@@ -13,9 +13,9 @@ declare function myLib(a: number): number;
  *~ delete this declaration and add types inside the namespace below.
  */
 interface myLib {
-    name: string;
-    length: number;
-    extras?: string[];
+  name: string;
+  length: number;
+  extras?: string[];
 }
 
 /*~ If your library has properties exposed on a global variable,
@@ -23,36 +23,36 @@ interface myLib {
  *~ You should also place types (interfaces and type alias) here.
  */
 declare namespace myLib {
-    //~ We can write 'myLib.timeout = 50;'
-    let timeout: number;
-
-    //~ We can access 'myLib.version', but not change it
-    const version: string;
-
-    //~ There's some class we can create via 'let c = new myLib.Cat(42)'
-    //~ Or reference e.g. 'function f(c: myLib.Cat) { ... }
-    class Cat {
-        constructor(n: number);
-
-        //~ We can read 'c.age' from a 'Cat' instance
-        readonly age: number;
-
-        //~ We can invoke 'c.purr()' from a 'Cat' instance
-        purr(): void;
-    }
-
-    //~ We can declare a variable as
-    //~   'var s: myLib.CatSettings = { weight: 5, name: "Maru" };'
-    interface CatSettings {
-        weight: number;
-        name: string;
-        tailLength?: number;
-    }
-
-    //~ We can write 'const v: myLib.VetID = 42;'
-    //~  or 'const v: myLib.VetID = "bob";'
-    type VetID = string | number;
-
-    //~ We can invoke 'myLib.checkCat(c)' or 'myLib.checkCat(c, v);'
-    function checkCat(c: Cat, s?: VetID);
+  //~ We can write 'myLib.timeout = 50;'
+  let timeout: number;
+
+  //~ We can access 'myLib.version', but not change it
+  const version: string;
+
+  //~ There's some class we can create via 'let c = new myLib.Cat(42)'
+  //~ Or reference e.g. 'function f(c: myLib.Cat) { ... }
+  class Cat {
+    constructor(n: number);
+
+    //~ We can read 'c.age' from a 'Cat' instance
+    readonly age: number;
+
+    //~ We can invoke 'c.purr()' from a 'Cat' instance
+    purr(): void;
+  }
+
+  //~ We can declare a variable as
+  //~   'var s: myLib.CatSettings = { weight: 5, name: "Maru" };'
+  interface CatSettings {
+    weight: number;
+    name: string;
+    tailLength?: number;
+  }
+
+  //~ We can write 'const v: myLib.VetID = 42;'
+  //~  or 'const v: myLib.VetID = "bob";'
+  type VetID = string | number;
+
+  //~ We can invoke 'myLib.checkCat(c)' or 'myLib.checkCat(c, v);'
+  function checkCat(c: Cat, s?: VetID);
 }

package/templates/module-class.d.ts

@@ -19,19 +19,19 @@ export = MyClass;
 
 /*~ Write your module's methods and properties in this class */
 declare class MyClass {
-    constructor(someParam?: string);
+  constructor(someParam?: string);
 
-    someProperty: string[];
+  someProperty: string[];
 
-    myMethod(opts: MyClass.MyClassMethodOptions): number;
+  myMethod(opts: MyClass.MyClassMethodOptions): number;
 }
 
 /*~ If you want to expose types from your module as well, you can
  *~ place them in this block.
  */
 declare namespace MyClass {
-    export interface MyClassMethodOptions {
-        width?: number;
-        height?: number;
-    }
+  export interface MyClassMethodOptions {
+    width?: number;
+    height?: number;
+  }
 }

package/templates/module-function.d.ts

@@ -27,20 +27,20 @@ declare function MyFunction(length: number): MyFunction.LengthReturnType;
  *~ be declared in here, as this example shows.
  */
 declare namespace MyFunction {
-    export interface LengthReturnType {
-        width: number;
-        height: number;
-    }
-    export interface NamedReturnType {
-        firstName: string;
-        lastName: string;
-    }
+  export interface LengthReturnType {
+    width: number;
+    height: number;
+  }
+  export interface NamedReturnType {
+    firstName: string;
+    lastName: string;
+  }
 
-    /*~ If the module also has properties, declare them here. For example,
-     *~ this declaration says that this code is legal:
-     *~   import f = require('myFuncLibrary');
-     *~   console.log(f.defaultName);
-     */
-    export const defaultName: string;
-    export let defaultLength: number;
+  /*~ If the module also has properties, declare them here. For example,
+   *~ this declaration says that this code is legal:
+   *~   import f = require('myFuncLibrary');
+   *~   console.log(f.defaultName);
+   */
+  export const defaultName: string;
+  export let defaultLength: number;
 }

package/templates/module-plugin.d.ts

@@ -1,24 +1,24 @@
 /*~ On this line, import the module which this module adds to */
-import * as m from 'someModule';
+import * as m from "someModule";
 
 /*~ You can also import other modules if needed */
-import * as other from 'anotherModule';
+import * as other from "anotherModule";
 
 /*~ Here, declare the same module as the one you imported above */
-declare module 'someModule' {
-    /*~ Inside, add new function, classes, or variables. You can use
-     *~ unexported types from the original module if needed. */
-    export function theNewMethod(x: m.foo): other.bar;
+declare module "someModule" {
+  /*~ Inside, add new function, classes, or variables. You can use
+   *~ unexported types from the original module if needed. */
+  export function theNewMethod(x: m.foo): other.bar;
 
-    /*~ You can also add new properties to existing interfaces from
-     *~ the original module by writing interface augmentations */
-    export interface SomeModuleOptions {
-        someModuleSetting?: string;
-    }
+  /*~ You can also add new properties to existing interfaces from
+   *~ the original module by writing interface augmentations */
+  export interface SomeModuleOptions {
+    someModuleSetting?: string;
+  }
 
-    /*~ New types can also be declared and will appear as if they
-     *~ are in the original module */
-    export interface MyModulePluginOptions {
-        size: number;
-    }
-}
+  /*~ New types can also be declared and will appear as if they
+   *~ are in the original module */
+  export interface MyModulePluginOptions {
+    size: number;
+  }
+}

package/templates/module.d.ts

@@ -11,9 +11,9 @@ export function myOtherMethod(a: number): number;
 
 /*~ You can declare types that are available via importing the module */
 export interface someType {
-    name: string;
-    length: number;
-    extras?: string[];
+  name: string;
+  length: number;
+  extras?: string[];
 }
 
 /*~ You can declare properties of the module using const, let, or var */
@@ -23,12 +23,12 @@ export const myField: number;
  *~ of the module, declare them inside a 'namespace'.
  */
 export namespace subProp {
-    /*~ For example, given this definition, someone could write:
-     *~   import { subProp } from 'yourModule';
-     *~   subProp.foo();
-     *~ or
-     *~   import * as yourMod from 'yourModule';
-     *~   yourMod.subProp.foo();
-     */
-    function foo(): void;
+  /*~ For example, given this definition, someone could write:
+   *~   import { subProp } from 'yourModule';
+   *~   subProp.foo();
+   *~ or
+   *~   import * as yourMod from 'yourModule';
+   *~   yourMod.subProp.foo();
+   */
+  function foo(): void;
 }

package/SECURITY.md

@@ -1,41 +0,0 @@
-<!-- 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,145 +0,0 @@
-"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) : 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 dtName = (0, names_1.getDTName)(packageName);
-    const packageDir = (0, path_1.join)("types", dtName);
-    // Check for overwrite
-    if (!overwrite) {
-        if ((0, fs_1.existsSync)(packageDir)) {
-            console.log(`Directory ${packageDir} already exists and --overwrite was not specified; exiting.`);
-            process.exit(2);
-        }
-    }
-    if (!(0, fs_1.existsSync)(packageDir)) {
-        (0, fs_1.mkdirSync)(packageDir);
-    }
-    run(indexDtsContent, packageName, dtName, packageDir).catch(e => {
-        console.error(e);
-        process.exit(1);
-    });
-}
-exports.default = writeDefinitelyTypedPackage;
-function run(indexDtsContent, packageName, dtName, packageDir) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const files = [
-            ["index.d.ts", indexDtsContent],
-            [`${dtName}-tests.ts`, ""],
-            ["tsconfig.json", `${JSON.stringify(getTSConfig(dtName), undefined, 4)}\n`],
-            ["package.json", `${JSON.stringify(yield getPackageJson(dtName, packageName), undefined, 4)}\n`],
-            ["tslint.json", '{ "extends": "@definitelytyped/dtslint/dt.json" }\n'],
-            [".npmignore", ["*", "!**/*.d.ts", "!**/*.d.cts", "!**/*.d.mts", "!**/*.d.*.ts"].join('\n') + '\n'],
-        ];
-        for (const [name, text] of files) {
-            (0, fs_1.writeFileSync)((0, path_1.join)(packageDir, name), text, "utf-8");
-        }
-    });
-}
-function getTSConfig(dtName) {
-    return {
-        compilerOptions: {
-            module: "commonjs",
-            lib: ["es6"],
-            noImplicitAny: true,
-            noImplicitThis: true,
-            strictFunctionTypes: true,
-            strictNullChecks: true,
-            types: [],
-            noEmit: true,
-            forceConsistentCasingInFileNames: true,
-        },
-        files: [
-            "index.d.ts",
-            `${dtName}-tests.ts`,
-        ],
-    };
-}
-function getPackageJson(dtName, 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.)";
-        try {
-            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
-            if (homepage !== undefined)
-                project = homepage;
-        }
-        catch (e) {
-            console.warn(`Warning: Could not retrieve version/homepage information: ${e.message}`);
-        }
-        let authorName = 'My Self';
-        try {
-            const globalGitConfig = parseGitConfig.sync({ cwd: (0, 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: (0, path_1.join)('.git', 'config') });
-            if (repoGitConfig['remote "origin"'] && repoGitConfig['remote "origin"'].url) {
-                const url = (0, 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}`);
-        }
-        return {
-            private: true,
-            name: `@types/${dtName}`,
-            version: `${version}.0.9999`,
-            projects: [project],
-            devDependencies: {
-                [`@types/${dtName}`]: "workspace:."
-            },
-            owners: [
-                {
-                    name: authorName,
-                    githubUsername: authorUserName
-                }
-            ]
-        };
-    });
-}
-function loadString(url) {
-    return new Promise((resolve, reject) => {
-        (0, 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}`));
-            }
-            let rawData = "";
-            res.on("data", (chunk) => rawData += chunk);
-            res.on("end", () => resolve(rawData));
-        }).on("error", (e) => reject(e));
-    });
-}