feat(hosted-git-info): a small library to parse hosted git info

Author: dangreen

README.md

@@ -15,20 +15,16 @@
 
 A set of packages with simple utilities.
 
-<!--
-
 ## Available tools
 
 | Name | Description | Version | Dependencies |
 |------|-------------|---------|--------------|
-| [`simple-github-release`](packages/simple-github-release#readme) | A simple tool to create GitHub releases. | [![NPM version][simple-github-release-npm]][simple-github-release-npm-url] | [![Dependencies status][simple-github-release-deps]][simple-github-release-deps-url] |
-
-<!-- simple-github-release - - >
+| [`@simple-libs/hosted-git-info`](packages/hosted-git-info#readme) | A small library to parse hosted git info. | [![NPM version][hosted-git-info-npm]][hosted-git-info-npm-url] | [![Dependencies status][hosted-git-info-deps]][hosted-git-info-deps-url] |
 
-[simple-github-release-npm]: https://img.shields.io/npm/v/simple-github-release.svg
-[simple-github-release-npm-url]: https://www.npmjs.com/package/simple-github-release
+<!-- hosted-git-info -->
 
-[simple-github-release-deps]: https://img.shields.io/librariesio/release/npm/simple-github-release
-[simple-github-release-deps-url]: https://libraries.io/npm/simple-github-release/tree
+[hosted-git-info-npm]: https://img.shields.io/npm/v/@simple-libs/hosted-git-info.svg
+[hosted-git-info-npm-url]: https://www.npmjs.com/package/@simple-libs/hosted-git-info
 
--->
+[hosted-git-info-deps]: https://img.shields.io/librariesio/release/npm/@simple-libs/hosted-git-info
+[hosted-git-info-deps-url]: https://libraries.io/npm/@simple-libs%2hosted-git-info/tree

packages/hosted-git-info/.eslintrc.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "@trigen/eslint-config/typescript",
+    "@trigen/eslint-config/typescript-requiring-type-checking",
+    "@trigen/eslint-config/jest"
+  ],
+  "parserOptions": {
+    "tsconfigRootDir": "./packages/hosted-git-info",
+    "project": ["./tsconfig.json"]
+  },
+  "rules": {
+    "prefer-destructuring": "off"
+  }
+}

packages/hosted-git-info/README.md

@@ -0,0 +1,74 @@
+# @simple-libs/hosted-git-info
+
+[![ESM-only package][package]][package-url]
+[![NPM version][npm]][npm-url]
+[![Node version][node]][node-url]
+[![Dependencies status][deps]][deps-url]
+[![Install size][size]][size-url]
+[![Build status][build]][build-url]
+[![Coverage status][coverage]][coverage-url]
+
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
+
+[npm]: https://img.shields.io/npm/v/@simple-libs/hosted-git-info.svg
+[npm-url]: https://www.npmjs.com/package/@simple-libs/hosted-git-info
+
+[node]: https://img.shields.io/node/v/@simple-libs/hosted-git-info.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://img.shields.io/librariesio/release/npm/@simple-libs/hosted-git-info
+[deps-url]: https://libraries.io/npm/@simple-libs%2Fhosted-git-info/tree
+
+[size]: https://packagephobia.com/badge?p=@simple-libs/hosted-git-info
+[size-url]: https://packagephobia.com/result?p=@simple-libs/hosted-git-info
+
+[build]: https://img.shields.io/github/actions/workflow/status/TrigenSoftware/simple-libs/tests.yml?branch=main
+[build-url]: https://github.com/TrigenSoftware/simple-libs/actions
+
+[coverage]: https://img.shields.io/codecov/c/github/TrigenSoftware/simple-libs.svg?flag=@simple-libs/hosted-git-info
+[coverage-url]: https://app.codecov.io/gh/TrigenSoftware/simple-libs/tree/main/packages%2Fhosted-git-info
+
+A small library to parse hosted git info.
+
+## Install
+
+```bash
+# pnpm
+pnpm add @simple-libs/hosted-git-info
+# yarn
+yarn add @simple-libs/hosted-git-info
+# npm
+npm i @simple-libs/hosted-git-info
+```
+
+## Usage
+
+```ts
+import { parseHostedGitUrl } from '@simple-libs/hosted-git-info'
+
+parseHostedGitUrl('github:foo/bar')
+/* {
+  type: 'github',
+  url: 'https://github.com/foo/bar',
+  host: 'https://github.com',
+  owner: 'foo',
+  project: 'bar'
+} */
+parseHostedGitUrl('git+ssh://bitbucket.org:foo/bar.git')
+/* {
+  type: 'bitbucket',
+  url: 'https://bitbucket.org/foo/bar',
+  host: 'https://bitbucket.org',
+  owner: 'foo',
+  project: 'bar'
+} */
+parseHostedGitUrl('https://[email protected]/foo/bar.git#branch')
+/* {
+  type: 'gitlab',
+  url: 'https://gitlab.com/foo/bar/tree/branch',
+  host: 'https://gitlab.com',
+  owner: 'foo',
+  project: 'bar'
+} */
+```

packages/hosted-git-info/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@simple-libs/hosted-git-info",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "A small library to parse hosted git info.",
+  "author": {
+    "name": "Dan Onoshko",
+    "email": "[email protected]",
+    "url": "https://github.com/dangreen"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/TrigenSoftware/simple-libs/tree/master/packages/hosted-git-info#readme",
+  "funding": "https://ko-fi.com/dangreen",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TrigenSoftware/simple-libs.git",
+    "directory": "packages/hosted-git-info"
+  },
+  "bugs": {
+    "url": "https://github.com/TrigenSoftware/simple-libs/issues"
+  },
+  "keywords": [
+    "git",
+    "github",
+    "bitbucket",
+    "gitlab",
+    "hosted-git-info"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": "./src/index.ts",
+  "publishConfig": {
+    "exports": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "directory": "package",
+    "linkDirectory": false
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clear:package": "del ./package",
+    "clear:dist": "del ./dist",
+    "clear": "del ./package ./dist ./coverage",
+    "prepublishOnly": "run build clear:package clean-publish",
+    "postpublish": "pnpm clear:package",
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint --parser-options tsconfigRootDir:. '**/*.{js,ts}'",
+    "test:unit": "vitest run --coverage",
+    "test:types": "tsc --noEmit",
+    "test": "run -p lint test:unit test:types"
+  }
+}