Prettier over the repository (Closes #165)
npm run format -- . with .prettierrc.json, and nothing else. Test fixtures (fixtures/, *.fixtures.json, *_fixtures.json) stay byte for byte as captured, and guides/self-hosted-runners.mdx is left out because Prettier's MDX printer rewrites it on every run; both are now in .prettierignore, so npm run format:check -- . passes.
- G1t-Session:
- ses_01m57b7r6jew3aqgyfmhw6yah6
1 file+33−330/1 viewed
| 19 | 19 | ||
| 20 | 20 | ## Inputs | |
| 21 | 21 | ||
| 22 | − | | Input | Default | | | |
| 23 | − | | --- | --- | --- | | |
| 24 | − | | `root-dir` | The checkout | Where the project is in the checkout. | | |
| 25 | − | | `build-command` | None | A build command of your own, as `g1t/deploy` takes it. | | |
| 26 | − | | `output-dir` | None | An output folder of your own, as `g1t/deploy` takes it. | | |
| 27 | − | | `build-as` | `auto` | What it is built as: `auto`, `static`, `workers` or `docker` (Container), as `g1t/deploy` takes it. | | |
| 28 | − | | `dockerfile` | None | A Dockerfile's path of your own, as `g1t/deploy` takes it. | | |
| 22 | + | | Input | Default | | | |
| 23 | + | | --------------- | ------------ | --------------------------------------------------------------------------------------------------- | | |
| 24 | + | | `root-dir` | The checkout | Where the project is in the checkout. | | |
| 25 | + | | `build-command` | None | A build command of your own, as `g1t/deploy` takes it. | | |
| 26 | + | | `output-dir` | None | An output folder of your own, as `g1t/deploy` takes it. | | |
| 27 | + | | `build-as` | `auto` | What it is built as: `auto`, `static`, `workers` or `docker` (Container), as `g1t/deploy` takes it. | | |
| 28 | + | | `dockerfile` | None | A Dockerfile's path of your own, as `g1t/deploy` takes it. | | |
| 29 | 29 | ||
| 30 | 30 | ## Outputs | |
| 31 | 31 | ||
| 32 | − | | Output | | | |
| 33 | − | | --- | --- | | |
| 34 | − | | `kind` | `workers` (a `wrangler.jsonc`, `wrangler.json` or `wrangler.toml`, a framework's Cloudflare adapter, or a Node.js server run as a Worker), `static` (a site a build writes), `html` (the files as they are), `container` (a server that is not run as a Worker, a framework set up to need a server, or a `Dockerfile` with nothing else to serve) or `none` (nothing to serve). | | |
| 35 | − | | `framework` | The framework it is built with, from the table below; `node` for a Node.js server run as a Worker; for a container without one, `dockerfile`, or the server g1t writes a Dockerfile for (`node`, `django`, `flask`, `fastapi`, `python`, `go`, `rails`, `rack`, `laravel`, `php`). Empty when there is none. | | |
| 36 | − | | `dockerfile` | A container's own Dockerfile, relative to the project. Empty when g1t writes one, and for anything that is not a container. | | |
| 37 | − | | `port` | The port a container listens on: its Dockerfile's `EXPOSE`, else `8080`. | | |
| 38 | − | | `entry` | For a Node.js server run as a Worker, the file that starts it, relative to the project. Empty for anything else. | | |
| 39 | − | | `install` | How dependencies are installed, from the lockfile: `npm ci`, `pnpm install --frozen-lockfile`, and so on, and `bundle install` for Jekyll. Empty when there is nothing to install. | | |
| 40 | − | | `build` | What builds it: your command, the package's `build` script (`npm run build`), the framework's own command, or `wrangler deploy --dry-run` for Workers. Empty when nothing does. | | |
| 41 | − | | `output-dir` | The folder served, relative to the project (`.` for the project itself): yours, a Workers project's assets directory, the folder the framework writes, or the first of `dist`, `build`, `out`, `public`, `_site`, `.output/public` that exists. Empty when a build has yet to write it, as for a Cloudflare adapter's Worker. | | |
| 32 | + | | Output | | | |
| 33 | + | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
| 34 | + | | `kind` | `workers` (a `wrangler.jsonc`, `wrangler.json` or `wrangler.toml`, a framework's Cloudflare adapter, or a Node.js server run as a Worker), `static` (a site a build writes), `html` (the files as they are), `container` (a server that is not run as a Worker, a framework set up to need a server, or a `Dockerfile` with nothing else to serve) or `none` (nothing to serve). | | |
| 35 | + | | `framework` | The framework it is built with, from the table below; `node` for a Node.js server run as a Worker; for a container without one, `dockerfile`, or the server g1t writes a Dockerfile for (`node`, `django`, `flask`, `fastapi`, `python`, `go`, `rails`, `rack`, `laravel`, `php`). Empty when there is none. | | |
| 36 | + | | `dockerfile` | A container's own Dockerfile, relative to the project. Empty when g1t writes one, and for anything that is not a container. | | |
| 37 | + | | `port` | The port a container listens on: its Dockerfile's `EXPOSE`, else `8080`. | | |
| 38 | + | | `entry` | For a Node.js server run as a Worker, the file that starts it, relative to the project. Empty for anything else. | | |
| 39 | + | | `install` | How dependencies are installed, from the lockfile: `npm ci`, `pnpm install --frozen-lockfile`, and so on, and `bundle install` for Jekyll. Empty when there is nothing to install. | | |
| 40 | + | | `build` | What builds it: your command, the package's `build` script (`npm run build`), the framework's own command, or `wrangler deploy --dry-run` for Workers. Empty when nothing does. | | |
| 41 | + | | `output-dir` | The folder served, relative to the project (`.` for the project itself): yours, a Workers project's assets directory, the folder the framework writes, or the first of `dist`, `build`, `out`, `public`, `_site`, `.output/public` that exists. Empty when a build has yet to write it, as for a Cloudflare adapter's Worker. | | |
| 42 | 42 | ||
| 43 | 43 | When `kind` is `none`, the step's log says what to change or add, such as | |
| 44 | 44 | a `Dockerfile`. [Docker deployments](https://docs.g1t.sh/guides/deployments/#docker-deployments) | |
| ⋯ | |||
| 46 | 46 | ||
| 47 | 47 | ## Frameworks | |
| 48 | 48 | ||
| 49 | − | | `framework` | Found by | Serves | | |
| 50 | − | | --- | --- | --- | | |
| 51 | − | | `vite`, `vite-react`, `vite-vue`, `vite-svelte`, `vite-solid`, `vite-preact` | `vite`, and the framework's Vite plugin | `dist`, or `build.outDir` | | |
| 52 | − | | `astro` | `astro` | `dist`, or `outDir`; a Worker with `@astrojs/cloudflare` | | |
| 53 | − | | `nextjs` | `next` | `out` with `output: 'export'`; a Worker with `@opennextjs/cloudflare` and a `wrangler.jsonc` | | |
| 54 | − | | `sveltekit` | `@sveltejs/kit` | `build` with `adapter-static`; a Worker with `adapter-cloudflare` | | |
| 55 | − | | `nuxt` | `nuxt` | `.output/public`, from `nuxi generate` | | |
| 56 | − | | `react-router`, `remix` | `@react-router/dev`, `@remix-run/dev` | `build/client` with `ssr: false` | | |
| 57 | − | | `gatsby` | `gatsby` | `public` | | |
| 58 | − | | `docusaurus` | `@docusaurus/core` | `build` | | |
| 59 | − | | `eleventy` | `@11ty/eleventy` | `_site` | | |
| 60 | − | | `angular` | `@angular/core` and `angular.json` | `dist/<project>/browser` | | |
| 61 | − | | `create-react-app` | `react-scripts` | `build` | | |
| 62 | − | | `hugo` | `hugo.toml`, or Hugo's `config.toml` | `public` | | |
| 63 | − | | `jekyll` | `_config.yml` and a `Gemfile` | `_site` | | |
| 64 | − | | `mdbook` | `book.toml` | `book` | | |
| 49 | + | | `framework` | Found by | Serves | | |
| 50 | + | | ---------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------- | | |
| 51 | + | | `vite`, `vite-react`, `vite-vue`, `vite-svelte`, `vite-solid`, `vite-preact` | `vite`, and the framework's Vite plugin | `dist`, or `build.outDir` | | |
| 52 | + | | `astro` | `astro` | `dist`, or `outDir`; a Worker with `@astrojs/cloudflare` | | |
| 53 | + | | `nextjs` | `next` | `out` with `output: 'export'`; a Worker with `@opennextjs/cloudflare` and a `wrangler.jsonc` | | |
| 54 | + | | `sveltekit` | `@sveltejs/kit` | `build` with `adapter-static`; a Worker with `adapter-cloudflare` | | |
| 55 | + | | `nuxt` | `nuxt` | `.output/public`, from `nuxi generate` | | |
| 56 | + | | `react-router`, `remix` | `@react-router/dev`, `@remix-run/dev` | `build/client` with `ssr: false` | | |
| 57 | + | | `gatsby` | `gatsby` | `public` | | |
| 58 | + | | `docusaurus` | `@docusaurus/core` | `build` | | |
| 59 | + | | `eleventy` | `@11ty/eleventy` | `_site` | | |
| 60 | + | | `angular` | `@angular/core` and `angular.json` | `dist/<project>/browser` | | |
| 61 | + | | `create-react-app` | `react-scripts` | `build` | | |
| 62 | + | | `hugo` | `hugo.toml`, or Hugo's `config.toml` | `public` | | |
| 63 | + | | `jekyll` | `_config.yml` and a `Gemfile` | `_site` | | |
| 64 | + | | `mdbook` | `book.toml` | `book` | | |
| 65 | 65 | ||
| 66 | 66 | [What deploys](https://docs.g1t.sh/guides/deployments/#frameworks) has | |
| 67 | 67 | each one's build command. Your `build-command` and `output-dir` win over | |
Comments
Sign in to comment.