Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add codeberg provider #175

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Features

✨ Support popular git providers (GitHub, GitLab, Bitbucket, Sourcehut) out of the box.
✨ Support popular git providers (GitHub, GitLab, Bitbucket, Sourcehut, Codeberg) out of the box.

✨ Built-in and custom [template registry](#template-registry).

Expand Down Expand Up @@ -78,6 +78,9 @@ npx giget@latest bitbucket:unjs/template
# Clone from sourcehut
npx giget@latest sourcehut:pi0/unjs-template

# Clone from codeberg
npx giget@latest codeberg:unjs/template

# Clone from https URL (tarball)
npx giget@latest https://api.github.com/repos/unjs/template/tarball/main

Expand Down Expand Up @@ -142,7 +145,7 @@ const { source, dir } = await downloadTemplate("github:unjs/template");
- `source`: (string) Input source in format of `[provider]:repo[/subpath][#ref]`.
- `options`: (object) Options are usually inferred from the input string. You can customize them.
- `dir`: (string) Destination directory to clone to. If not provided, `user-name` will be used relative to the current directory.
- `provider`: (string) Either `github`, `gitlab`, `bitbucket` or `sourcehut`. The default is `github`.
- `provider`: (string) Either `github`, `gitlab`, `bitbucket`, `sourcehut` or `codeberg`. The default is `github`.
- `force`: (boolean) Extract to the existing dir even if already exists.
- `forceClean`: (boolean) ⚠️ Clean up any existing directory or file before cloning.
- `offline`: (boolean) Do not attempt to download and use the cached version.
Expand Down
15 changes: 15 additions & 0 deletions src/providers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@
};
};

export const codeberg: TemplateProvider = (input, options) => {
const parsed = parseGitURI(input);
return {
name: parsed.repo.replace("/", "-"),
version: parsed.ref,
subdir: parsed.subdir,
headers: {
authorization: options.auth ? `token ${options.auth}` : undefined,
},
url: `https://codeberg.org/${parsed.repo}/src/${parsed.ref}${parsed.subdir}`,
tar: `https://codeberg.org/${parsed.repo}/archive/${parsed.ref}.tar.gz`,
};
};

Check warning on line 143 in src/providers.ts

View check run for this annotation

Codecov / codecov/patch

src/providers.ts#L132-L143

Added lines #L132 - L143 were not covered by tests

export const providers: Record<string, TemplateProvider> = {
http,
https: http,
Expand All @@ -136,4 +150,5 @@
gitlab,
bitbucket,
sourcehut,
codeberg,
};
2 changes: 1 addition & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export interface GitInfo {
provider: "github" | "gitlab" | "bitbucket" | "sourcehut";
provider: "github" | "gitlab" | "bitbucket" | "sourcehut" | "codeberg";
repo: string;
subdir: string;
ref: string;
Expand Down
6 changes: 3 additions & 3 deletions test/getgit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ describe("downloadTemplate", () => {
dir: destinationDirectory,
preferOffline: true,
});
expect(await existsSync(resolve(dir, "package.json")));
expect(existsSync(resolve(dir, "package.json")));
});

it("do not clone to exisiting dir", async () => {
const destinationDirectory = resolve(__dirname, ".tmp/exisiting");
it("do not clone to existing dir", async () => {
const destinationDirectory = resolve(__dirname, ".tmp/existing");
await mkdir(destinationDirectory).catch(() => {});
await writeFile(resolve(destinationDirectory, "test.txt"), "test");
await expect(
Expand Down