Add curated extensions list as source of truth

[damianmarti]

The extensions.json file will be used from the scaffoldeth.io website to get the curated extensions.

[technophile-04]

Also for some reason the linting is not working properly.

When I do yarn lint I don't get any error but when if look at src/utils/parse-arguments-into-options.ts file my editor is showing this:

[technophile-04]

Just created #156 for #155 (review)

[damianmarti]

Thanks all for the review!! I removed builder, coBuilders and installCommand. You can add an installCommand if it's different from the default one.

[technophile-04]

Summary

Due to the difference in types between create-eth and scaffoldeth.io, we’re already doing some different things in the scaffoldeth.io UI based on the isCurated flag. So, maybe we should keep only these fields in the .json file for create-eth so it's easy for us when we add new extensions to curated list.

// json file type
type Extension = {
  branch: string;
  repository: string;
  // use full for scaffoldeth.io
  description: string;
  version?: string; // (optional) if not present we default latest
  name?: string; // (optional) if not present we use the branch name as default (name might be useful to nicely display challenges names)
  // github: can be inferred by joining repositry + branch (scaffoldeth.io is requiring this for displaying link)
  // installCommand can inferred using repository + branch + version
}[];

Reasoning for above thing:

For cli internal working we need this type:

export type ExternalExtension = {
  repository: string;
  branch?: string | null;
};

export type CLI_TO_WORK = Record<string, ExternalExtension>; // where string is extension name

And scaffoldeth.io is expecting:

type Extension = {
  // Displayed as card title
  name: string;
  // Shown in card body
  description: string;
  // Used for GitHub icon link  (this is ambiguous to `repository` in create-eth but not the same. Here github link contains branch as well)
  github: string;
  // Command shown in copy-to-clipboard button at bottom of card
  installCommand: string;
  builder: string;
  coBuilders: string[];
  youtube?: string;
};

The type which we are maintaining in json for create-eth + scaffoldeth.io:

type Extension = {
  name: string;
  description: string;
  repository: string;
  branch: string;
}[];

[damianmarti]

Summary

Due to the difference in types between create-eth and scaffoldeth.io, we’re already doing some different things in the scaffoldeth.io UI based on the isCurated flag. So, maybe we should keep only these fields in the .json file for create-eth so it's easy for us when we add new extensions to curated list.

// json file type
type Extension = {
  branch: string;
  repository: string;
  // use full for scaffoldeth.io
  description: string;
  version?: string; // (optional) if not present we default latest
  name?: string; // (optional) if not present we use the branch name as default (name might be useful to nicely display challenges names)
  // github: can be inferred by joining repositry + branch (scaffoldeth.io is requiring this for displaying link)
  // installCommand can inferred using repository + branch + version
}[];

Reasoning for above thing:

For cli internal working we need this type:

export type ExternalExtension = {
  repository: string;
  branch?: string | null;
};

export type CLI_TO_WORK = Record<string, ExternalExtension>; // where string is extension name

And scaffoldeth.io is expecting:

type Extension = {
  // Displayed as card title
  name: string;
  // Shown in card body
  description: string;
  // Used for GitHub icon link  (this is ambiguous to `repository` in create-eth but not the same. Here github link contains branch as well)
  github: string;
  // Command shown in copy-to-clipboard button at bottom of card
  installCommand: string;
  builder: string;
  coBuilders: string[];
  youtube?: string;
};

The type which we are maintaining in json for create-eth + scaffoldeth.io:

type Extension = {
  name: string;
  description: string;
  repository: string;
  branch: string;
}[];

Thanks @technophile-04

I removed the name from the JSON file and I'm using the branch as the name if no name is added.

Do we need to add version? Do we need to use a different create-eth version for any curated extension?

[technophile-04]

Do we need to add version? Do we need to use a different create-eth version for any curated extension?

Ohh yeah for speedrunethereum challenges we want the version to locked npx [email protected] -e challenge-0-simple-nft this makes sure challenges always nicely works and then after sometimes we again test new version of npx create-eth with challenges and update the README of challenges.

---

Thanks @damianmarti!! Just pushed a tweak at fe162b3 just making sure we only use branch as key for internal working of CLI instead of name. The name field is only helpful for scaffoldeth.io to show it as card title so it could be something like name: "Challenge 0: Simple NFT" and we don't want people to pass it as -e flag instead we want them to pass it a branch which is more parsable by cli.

[damianmarti]

Do we need to add version? Do we need to use a different create-eth version for any curated extension?

Ohh yeah for speedrunethereum challenges we want the version to locked npx [email protected] -e challenge-0-simple-nft this makes sure challenges always nicely works and then after sometimes we again test new version of npx create-eth with challenges and update the README of challenges.

Thanks @damianmarti!! Just pushed a tweak at fe162b3 just making sure we only use branch as key for internal working of CLI instead of name. The name field is only helpful for scaffoldeth.io to show it as card title so it could be something like name: "Challenge 0: Simple NFT" and we don't want people to pass it as -e flag instead we want them to pass it a branch which is more parsable by cli.

But the branch is set as optional https://github.com/scaffold-eth/create-eth/blob/main/src/types.ts#L7

I thought because the extension could be on another repository using the main branch...