{"id":16698152,"url":"https://github.com/arlac77/local-repository-provider","last_synced_at":"2025-04-10T02:55:25.024Z","repository":{"id":26843747,"uuid":"110998941","full_name":"arlac77/local-repository-provider","owner":"arlac77","description":"repository provider using local (native) git commands","archived":false,"fork":false,"pushed_at":"2025-03-17T17:32:37.000Z","size":3335,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-21T08:46:59.652Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arlac77.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-16T17:03:08.000Z","updated_at":"2025-03-17T17:32:23.000Z","dependencies_parsed_at":"2023-10-11T01:49:12.284Z","dependency_job_id":"3746059b-f6a1-4afa-b9ff-d9627822dc0f","html_url":"https://github.com/arlac77/local-repository-provider","commit_stats":{"total_commits":1972,"total_committers":10,"mean_commits":197.2,"dds":"0.15720081135902642","last_synced_commit":"7e9ff186daf2db3828c530f02069848580ff0358"},"previous_names":[],"tags_count":431,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Flocal-repository-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Flocal-repository-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Flocal-repository-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Flocal-repository-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arlac77","download_url":"https://codeload.github.com/arlac77/local-repository-provider/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248147484,"owners_count":21055540,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T17:51:00.004Z","updated_at":"2025-04-10T02:55:25.004Z","avatar_url":"https://github.com/arlac77.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/local-repository-provider.svg)](https://www.npmjs.com/package/local-repository-provider)\n[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)\n[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\\\u0026label\\\u0026labelColor=blue\\\u0026color=555555)](https://typescriptlang.org)\n[![bundlejs](https://deno.bundlejs.com/?q=local-repository-provider\\\u0026badge=detailed)](https://bundlejs.com/?q=local-repository-provider)\n[![downloads](http://img.shields.io/npm/dm/local-repository-provider.svg?style=flat-square)](https://npmjs.org/package/local-repository-provider)\n[![GitHub Issues](https://img.shields.io/github/issues/arlac77/local-repository-provider.svg?style=flat-square)](https://github.com/arlac77/local-repository-provider/issues)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Flocal-repository-provider%2Fbadge\\\u0026style=flat)](https://actions-badge.atrox.dev/arlac77/local-repository-provider/goto)\n[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/local-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/local-repository-provider)\n[![Coverage Status](https://coveralls.io/repos/arlac77/local-repository-provider/badge.svg)](https://coveralls.io/github/arlac77/local-repository-provider)\n\n# local-repository-provider\n\nrepository provider using local (native) git commands\n\n# API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### Table of Contents\n\n*   [LocalBranch](#localbranch)\n    *   [Properties](#properties)\n    *   [writeEntries](#writeentries)\n        *   [Parameters](#parameters)\n    *   [commit](#commit)\n        *   [Parameters](#parameters-1)\n    *   [entries](#entries)\n        *   [Parameters](#parameters-2)\n    *   [entry](#entry)\n        *   [Parameters](#parameters-3)\n    *   [maybeEntry](#maybeentry)\n        *   [Parameters](#parameters-4)\n*   [Promise](#promise)\n*   [LocalProvider](#localprovider)\n    *   [Properties](#properties-1)\n    *   [newWorkspacePath](#newworkspacepath)\n        *   [Parameters](#parameters-5)\n    *   [branches](#branches)\n        *   [Parameters](#parameters-6)\n    *   [repositories](#repositories)\n        *   [Parameters](#parameters-7)\n    *   [repository](#repository)\n        *   [Parameters](#parameters-8)\n    *   [name](#name)\n    *   [attributes](#attributes)\n*   [LocalRepository](#localrepository)\n    *   [Properties](#properties-2)\n    *   [setCurrentBranch](#setcurrentbranch)\n        *   [Parameters](#parameters-9)\n    *   [refId](#refid)\n        *   [Parameters](#parameters-10)\n    *   [initializeBranches](#initializebranches)\n*   [workspace](#workspace)\n\n## LocalBranch\n\n**Extends Branch**\n\n### Properties\n\n*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\n### writeEntries\n\nWrites ContentEntries into the branch\n\n#### Parameters\n\n*   `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\\\u003cContentEntry\u003e**\u0026#x20;\n\nReturns **[Promise](#promise)\u003c[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\\\u003cContentEntry\u003e\u003e** written entries\n\n### commit\n\nExecutes:\n\n*   writes all updates into the workspace\n*   git add\n*   git commit\n*   git push --set-upstream origin\n\n#### Parameters\n\n*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message\n*   `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\\\u003cContentEntry\u003e** file entries to be commited\n*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{push:true}`)\n\n    *   `options.push` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** exec push after commit\n\n### entries\n\nDeliver all matchine entires for a given pattern.\n\n#### Parameters\n\n*   `matchingPatterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u003c[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**  (optional, default `[\"**/*\"]`)\n\nReturns **AsyncGenerator\\\u003cContentEntry\u003e** matching branch path names\n\n### entry\n\nSearch for path in the branch.\n\n#### Parameters\n\n*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\nReturns **[Promise](#promise)\\\u003cContentEntry\u003e** matching branch path names\n\n### maybeEntry\n\nSearch for path in the branch.\n\n#### Parameters\n\n*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\nReturns **[Promise](#promise)\u003c(ContentEntry | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))\u003e** matching branch path names\n\n## Promise\n\nType: [Promise](#promise)\\\u003cvoid\u003e\n\n## LocalProvider\n\n**Extends SingleGroupProvider**\n\nProvider using native git executable.\nKnown environment variables.\n\n*   GIT\\_CLONE\\_OPTIONS\n\n### Properties\n\n*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\n### newWorkspacePath\n\nGenerate path for a new workspace.\nFor the livetime of the provider always genrate new names\n\n#### Parameters\n\n*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\nReturns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path\n\n### branches\n\nList branches for a given set of patterns.\nOnly delivers branches for valid complete git urls.\n\n#### Parameters\n\n*   `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u003c[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e)**\u0026#x20;\n\n### repositories\n\nList repositories for a given set of patterns.\nOnly delivers repositories for valid complete git urls.\n\n#### Parameters\n\n*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u003c[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?**\u0026#x20;\n\n### repository\n\nUsing provider workspace and number of repositories to create repository workspace.\n\n#### Parameters\n\n*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** where to place the repos workspace\n\n### name\n\nWe are called local.\n\nReturns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** local\n\n### attributes\n\nDefault configuration options.\n\n*   workspace\n*   cloneOptions defaults to \\[\"--depth\", \"8\", \"--no-single-branch\"]\n\nReturns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**\u0026#x20;\n\n## LocalRepository\n\n**Extends Repository**\n\n### Properties\n\n*   `workspace` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n*   `currentBranch` **Branch**\u0026#x20;\n\n### setCurrentBranch\n\nSet the current active branch (workspace)\n\n#### Parameters\n\n*   `branch` **Branch**\u0026#x20;\n\n### refId\n\nGet sha of a ref\nCalls\n\n```sh\ngit show-ref \u003cref\u003e\n```\n\n#### Parameters\n\n*   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\nReturns **[Promise](#promise)\u003c[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e** sha of the ref\n\n### initializeBranches\n\nbuild lookup of all remote branches\n\n```sh\ngit ls-remote --heads\n```\n\n## workspace\n\nworkspace directory.\n\nReturns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n\n# install\n\nWith [npm](http://npmjs.org) do:\n\n```shell\nnpm install local-repository-provider\n```\n\n# license\n\nBSD-2-Clause\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Flocal-repository-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farlac77%2Flocal-repository-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Flocal-repository-provider/lists"}