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: sandpack template type #1075

Merged
merged 3 commits into from
Feb 5, 2024

Conversation

Geminii
Copy link
Contributor

@Geminii Geminii commented Feb 5, 2024

What kind of change does this pull request introduce?

This PR removes codesandbox-import-util-types internal dependency to be Apache 2.0 license compliant 🎉
More detail inside #1073 discussion 🙂

What is the current behavior?

Codesandbox uses its own ITemplate interface from codesandbox-import-util-types dependency which is under LGPL 3.0 license.

What is the new behavior?

Rename Template to SandpackTemplate type to stay consistent with other sandpack types.

export type ITemplate =
  | "adonis"
  | "vue-cli"
  | "preact-cli"
  | "svelte"
  | "create-react-app-typescript"
  | "create-react-app"
  | "angular-cli"
  | "parcel"
  | "@dojo/cli-create-app"
  | "cxjs"
  | "gatsby"
  | "nuxt"
  | "next"
  | "reason"
  | "apollo"
  | "sapper"
  | "ember"
  | "nest"
  | "static"
  | "styleguidist"
  | "gridsome"
  | "vuepress"
  | "mdx-deck"
  | "quasar"
  | "docusaurus"
  | "node";

However, SandpackClient only supports current Template type. So we can clean the old type and simply reuse the current SandpackTemplate 🙂

What steps did you take to test this? This is required before we can merge, make sure to test the flow you've updated.

  1. [Documentation] You can check the getting-starting usage page
  2. [Documentation] You can check the Sandpack Client page
  3. [Example] No changes but you can check the template property

Checklist

  • Documentation;
  • Storybook (if applicable); N/A
  • Tests; through typecheck command
  • Ready to be merged;

Copy link

codesandbox bot commented Feb 5, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

vercel bot commented Feb 5, 2024

Someone is attempting to deploy a commit to the CodeSandbox Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

codesandbox-ci bot commented Feb 5, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 0d145cd:

Sandbox Source
Sandpack Configuration
sandpack-run-stale-value Configuration

@Geminii Geminii marked this pull request as ready for review February 5, 2024 09:30
Copy link

vercel bot commented Feb 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sandpack-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 5, 2024 0:22am

@danilowoz danilowoz merged commit db8eba7 into codesandbox:main Feb 5, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants