From 54725a0eab336b4a66817c764e20f3c93274f2dd Mon Sep 17 00:00:00 2001 From: Jonathan Green Date: Sat, 8 Feb 2025 21:40:34 -0500 Subject: [PATCH] pushing to protocol land --- .github/workflows/protocolland.yaml | 34 ++++++++++++++++++++ README.md | 48 +---------------------------- 2 files changed, 35 insertions(+), 47 deletions(-) create mode 100644 .github/workflows/protocolland.yaml diff --git a/.github/workflows/protocolland.yaml b/.github/workflows/protocolland.yaml new file mode 100644 index 0000000..edb43de --- /dev/null +++ b/.github/workflows/protocolland.yaml @@ -0,0 +1,34 @@ +name: Protocol Land Sync +on: + # Run with every push to 'main' branch: + push: + branches: + - 'main' + # Run Manually: + #workflow_dispatch: +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: 'Checkout repo (default branch)' + uses: actions/checkout@v3 + with: + # fetch all history for all branches: + fetch-depth: 0 + - name: 'Checkout all branches' + run: | + default_branch=$(git branch | grep '*' | sed 's/\* //') + for abranch in $(git branch -a | grep -v HEAD | grep remotes | sed "s/remotes\/origin\///g"); do git checkout $abranch ; done + git checkout $default_branch + git branch -a + - name: 'Setup node 18' + uses: actions/setup-node@v3 + with: + node-version: 18.x + - name: 'Sync repo to Protocol Land' + run: npx @protocol.land/sync + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REPO_TITLE: ${{ github.event.repository.name }} + REPO_DESCRIPTION: ${{ github.event.repository.description }} + WALLET: ${{ secrets.DEPLOY_KEY }} \ No newline at end of file diff --git a/README.md b/README.md index e6cd94f..b98f1ce 100644 --- a/README.md +++ b/README.md @@ -1,47 +1 @@ -# Svelte + TS + Vite - -This template should help get you started developing with Svelte and TypeScript in Vite. - -## Recommended IDE Setup - -[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). - -## Need an official Svelte framework? - -Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more. - -## Technical considerations - -**Why use this over SvelteKit?** - -- It brings its own routing solution which might not be preferable for some users. -- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app. - -This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project. - -Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate. - -**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?** - -Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information. - -**Why include `.vscode/extensions.json`?** - -Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project. - -**Why enable `allowJs` in the TS template?** - -While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant. - -**Why is HMR not preserving my local component state?** - -HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr). - -If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR. - -```ts -// store.ts -// An extremely simple external store -import { writable } from 'svelte/store' -export default writable(0) -``` +[![protocol.land](https://arweave.net/eZp8gOeR8Yl_cyH9jJToaCrt2He1PHr0pR4o-mHbEcY)](https://protocol.land/#/repository/) \ No newline at end of file