add github-url-from-git (#38576)

This commit is contained in:
Christian Murphy 2019-09-24 16:53:49 -07:00 committed by Ben Lichtman
parent 56b659e0f0
commit 46c2eed830
4 changed files with 62 additions and 0 deletions

View File

@ -0,0 +1,6 @@
import * as parse from 'github-url-from-git';
parse('https://github.com/jamesor/mongoose-versioner'); // $ExpectType string
parse('git://github.internal.example.com/treygriffith/cellar.git', { extraBaseUrls: ['github.internal.example.com'] }); // $ExpectType string
parse.re(); // $ExpectType RegExp
parse.re({ extraBaseUrls: ['github.internal.example.com'] }); // $ExpectType RegExp

32
types/github-url-from-git/index.d.ts vendored Normal file
View File

@ -0,0 +1,32 @@
// Type definitions for node-github-url-from-git 1.5
// Project: https://github.com/tj/node-github-url-from-git
// Definitions by: Christian Murphy <https://github.com/ChristianMurphy>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.0
declare namespace githubUrlFromGit {
interface githubUrlFromGitOptions {
/**
* additional URLs that should be treated as GitHub repos
*/
extraBaseUrls?: string[];
}
/**
* Create a regular expression to parse GitHub URLs
*
* @param opts options for regular expression generator
*/
function re(opts?: githubUrlFromGitOptions): RegExp;
}
/**
* Normalize Git URLs into GitHub URLs
*
* @param url Git URL to process
* @param opts options for URL parser
* @returns GitHub URL
*/
declare function githubUrlFromGit(url: string, opts?: githubUrlFromGit.githubUrlFromGitOptions): string;
export = githubUrlFromGit;

View File

@ -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",
"github-url-from-git-tests.ts"
]
}

View File

@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }