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.

Sign up for GitHub

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

Allow to use a github url as extension #143

Merged
merged 6 commits into from
Dec 30, 2024
Merged

Allow to use a github url as extension #143

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8c4bebc
Allow to use a github url as extension
damianmarti Oct 21, 2024
f23e773
Merge branch 'main' of github.com:scaffold-eth/create-eth into extens…
rin-st Dec 22, 2024
5666726
Add deconstructGithubUrl function
damianmarti Dec 27, 2024
c4080c3
Merge branch 'main' of github.com:scaffold-eth/create-eth into extens…
rin-st Dec 27, 2024
0df5d07
minor tweak to comment
technophile-04 Dec 30, 2024
aaa7ef6
add changeset
technophile-04 Dec 30, 2024
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
39 changes: 30 additions & 9 deletions src/utils/external-extensions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,46 @@ import { fileURLToPath } from "url";
import { ExternalExtension, RawOptions, SolidityFramework } from "../types";
import { CURATED_EXTENSIONS } from "../curated-extensions";
import { SOLIDITY_FRAMEWORKS } from "./consts";

function deconstructGithubUrl(url: string) {
const urlParts = url.split("/");
const ownerName = urlParts[3];
const repoName = urlParts[4];
const branch = urlParts[5] === "tree" ? urlParts[6] : undefined;

return { ownerName, repoName, branch };
}

// Gets the data from the argument passed to the `--extension` option.
// e.g. owner/project:branch => { githubBranchUrl, githubUrl, branch, owner, project }
export const getDataFromExternalExtensionArgument = (externalExtension: string) => {
if (CURATED_EXTENSIONS[externalExtension.toLowerCase()]) {
externalExtension = getArgumentFromExternalExtensionOption(CURATED_EXTENSIONS[externalExtension]);
}

const isGithubUrl = externalExtension.startsWith("https://github.com/");

// Check format: owner/project:branch (branch is optional)
const regex = /^[^/]+\/[^/]+(:[^/]+)?$/;
if (!regex.test(externalExtension)) {
throw new Error(`Invalid extension format. Use "owner/project" or "owner/project:branch"`);
if (!regex.test(externalExtension) && !isGithubUrl) {
throw new Error(`Invalid extension format. Use "owner/project", "owner/project:branch" or github url.`);
}

// Extract owner, project and branch
const owner = externalExtension.split("/")[0];
const project = externalExtension.split(":")[0].split("/")[1];
const branch = externalExtension.split(":")[1];
let owner;
let project;
let branch;

if (isGithubUrl) {
const { ownerName, repoName, branch: urlBranch } = deconstructGithubUrl(externalExtension);
owner = ownerName;
project = repoName;
branch = urlBranch;
} else {
// Extract owner, project and branch from owner/project:branch
owner = externalExtension.split("/")[0];
project = externalExtension.split(":")[0].split("/")[1];
branch = externalExtension.split(":")[1];
}

const githubUrl = `https://github.com/${owner}/${project}`;
let githubBranchUrl;
Expand Down Expand Up @@ -72,9 +95,7 @@ export const getSolidityFrameworkDirsFromExternalExtension = async (
}

const { branch, repository } = externalExtension;
const splitUrl = repository.split("/");
const ownerName = splitUrl[splitUrl.length - 2];
const repoName = splitUrl[splitUrl.length - 1];
const { ownerName, repoName } = deconstructGithubUrl(repository);
const githubApiUrl = `https://api.github.com/repos/${ownerName}/${repoName}/contents/extension/packages${branch ? `?ref=${branch}` : ""}`;
const res = await fetch(githubApiUrl);
if (!res.ok) {
Expand Down
Loading