From 3f3a293b6bbb6bcadf2a88633efe9dbac26fb438 Mon Sep 17 00:00:00 2001 From: "Fred K. Schott" Date: Fri, 5 Aug 2022 21:36:23 -0700 Subject: [PATCH] update example scripts (#4098) --- examples/basics/README.md | 14 ++++++++------ examples/basics/package.json | 3 ++- examples/blog/README.md | 14 ++++++++------ examples/blog/package.json | 3 ++- examples/component/README.md | 14 ++++++++------ examples/component/demo/package.json | 3 ++- examples/docs/README.md | 14 ++++++++------ examples/docs/package.json | 3 ++- examples/env-vars/package.json | 3 ++- examples/framework-alpine/package.json | 3 ++- examples/framework-lit/package.json | 3 ++- examples/framework-multiple/package.json | 3 ++- examples/framework-preact/package.json | 3 ++- examples/framework-react/package.json | 3 ++- examples/framework-solid/package.json | 3 ++- examples/framework-svelte/package.json | 3 ++- examples/framework-vue/package.json | 3 ++- examples/minimal/README.md | 14 ++++++++------ examples/minimal/package.json | 3 ++- examples/non-html-pages/README.md | 14 ++++++++------ examples/non-html-pages/package.json | 3 ++- examples/portfolio/README.md | 14 ++++++++------ examples/portfolio/package.json | 3 ++- examples/ssr/package.json | 2 ++ examples/subpath/README.md | 14 ++++++++------ examples/subpath/package.json | 3 ++- examples/with-markdown-plugins/package.json | 3 ++- examples/with-markdown-shiki/package.json | 3 ++- examples/with-mdx/package.json | 3 ++- examples/with-nanostores/package.json | 3 ++- examples/with-tailwindcss/package.json | 3 ++- examples/with-vite-plugin-pwa/README.md | 14 ++++++++------ examples/with-vite-plugin-pwa/package.json | 3 ++- examples/with-vitest/package.json | 1 + 34 files changed, 121 insertions(+), 77 deletions(-) diff --git a/examples/basics/README.md b/examples/basics/README.md index ccbd39d5d..9013757b7 100644 --- a/examples/basics/README.md +++ b/examples/basics/README.md @@ -30,12 +30,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -| :---------------- | :------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :------------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/basics/package.json b/examples/basics/package.json index 6deb3ba0f..4a912696a 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "astro": "^1.0.0-rc.6" diff --git a/examples/blog/README.md b/examples/blog/README.md index ca87802a6..fa874dba8 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -58,12 +58,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -| :---------------- | :------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/blog/package.json b/examples/blog/package.json index 616a44a75..737770dd3 100644 --- a/examples/blog/package.json +++ b/examples/blog/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/preact": "^0.5.2", diff --git a/examples/component/README.md b/examples/component/README.md index 84e5a6905..8cd73e343 100644 --- a/examples/component/README.md +++ b/examples/component/README.md @@ -33,12 +33,14 @@ This project uses **workspaces** to develop a single package, `@example/my-compo All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/component/demo/package.json b/examples/component/demo/package.json index 18d07c2e9..d5bbc3ff6 100644 --- a/examples/component/demo/package.json +++ b/examples/component/demo/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@example/my-component": "workspace:*", diff --git a/examples/docs/README.md b/examples/docs/README.md index bbaa492cd..447390ae9 100644 --- a/examples/docs/README.md +++ b/examples/docs/README.md @@ -21,12 +21,14 @@ npm init astro -- --template docs All commands are run from the root of the project, from a terminal: -| Command | Action | -| :---------------- | :------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide. diff --git a/examples/docs/package.json b/examples/docs/package.json index 2ec27dc10..5f861e4de 100644 --- a/examples/docs/package.json +++ b/examples/docs/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "dependencies": { "@algolia/client-search": "^4.13.1", diff --git a/examples/env-vars/package.json b/examples/env-vars/package.json index 1ed464652..58c7d8304 100644 --- a/examples/env-vars/package.json +++ b/examples/env-vars/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "astro": "^1.0.0-rc.6" diff --git a/examples/framework-alpine/package.json b/examples/framework-alpine/package.json index 44e492fe3..18cabaff4 100644 --- a/examples/framework-alpine/package.json +++ b/examples/framework-alpine/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@types/alpinejs": "^3.7.0", diff --git a/examples/framework-lit/package.json b/examples/framework-lit/package.json index b7051a88e..3296dcd52 100644 --- a/examples/framework-lit/package.json +++ b/examples/framework-lit/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/lit": "^0.3.2", diff --git a/examples/framework-multiple/package.json b/examples/framework-multiple/package.json index a4e1e2018..006a231a7 100644 --- a/examples/framework-multiple/package.json +++ b/examples/framework-multiple/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/preact": "^0.5.2", diff --git a/examples/framework-preact/package.json b/examples/framework-preact/package.json index e051e18e5..7d27d6c90 100644 --- a/examples/framework-preact/package.json +++ b/examples/framework-preact/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/preact": "^0.5.2", diff --git a/examples/framework-react/package.json b/examples/framework-react/package.json index cf2edbdc2..e0f9e44bc 100644 --- a/examples/framework-react/package.json +++ b/examples/framework-react/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/react": "^0.4.2", diff --git a/examples/framework-solid/package.json b/examples/framework-solid/package.json index bc4f683be..fe426fb66 100644 --- a/examples/framework-solid/package.json +++ b/examples/framework-solid/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/solid-js": "^0.4.1", diff --git a/examples/framework-svelte/package.json b/examples/framework-svelte/package.json index 21ae017d5..d39633b2b 100644 --- a/examples/framework-svelte/package.json +++ b/examples/framework-svelte/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/svelte": "^0.5.1", diff --git a/examples/framework-vue/package.json b/examples/framework-vue/package.json index ad2a7cdd9..cbdc03801 100644 --- a/examples/framework-vue/package.json +++ b/examples/framework-vue/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/vue": "^0.5.0", diff --git a/examples/minimal/README.md b/examples/minimal/README.md index a7bd4a6cb..62b3f469b 100644 --- a/examples/minimal/README.md +++ b/examples/minimal/README.md @@ -31,12 +31,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/minimal/package.json b/examples/minimal/package.json index 626feafd5..e502828c8 100644 --- a/examples/minimal/package.json +++ b/examples/minimal/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "astro": "^1.0.0-rc.6" diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md index 1693feb46..571916240 100644 --- a/examples/non-html-pages/README.md +++ b/examples/non-html-pages/README.md @@ -36,12 +36,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/non-html-pages/package.json b/examples/non-html-pages/package.json index a56660d29..ad1ff179b 100644 --- a/examples/non-html-pages/package.json +++ b/examples/non-html-pages/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "astro": "^1.0.0-rc.6" diff --git a/examples/portfolio/README.md b/examples/portfolio/README.md index 97bc3f322..7b48a8f72 100644 --- a/examples/portfolio/README.md +++ b/examples/portfolio/README.md @@ -12,12 +12,14 @@ npm init astro -- --template portfolio All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/portfolio/package.json b/examples/portfolio/package.json index 253e1977a..79eb3bd9c 100644 --- a/examples/portfolio/package.json +++ b/examples/portfolio/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/preact": "^0.5.2", diff --git a/examples/ssr/package.json b/examples/ssr/package.json index f854c627d..2355ba26e 100644 --- a/examples/ssr/package.json +++ b/examples/ssr/package.json @@ -6,6 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", + "preview": "astro preview", + "astro": "astro", "server": "node server/server.mjs" }, "devDependencies": { diff --git a/examples/subpath/README.md b/examples/subpath/README.md index 36a1b0050..0c138d742 100644 --- a/examples/subpath/README.md +++ b/examples/subpath/README.md @@ -33,12 +33,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/subpath/package.json b/examples/subpath/package.json index c702dc775..cc842f907 100644 --- a/examples/subpath/package.json +++ b/examples/subpath/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/react": "^0.4.2", diff --git a/examples/with-markdown-plugins/package.json b/examples/with-markdown-plugins/package.json index 0f39ad2d7..b208ee2f0 100644 --- a/examples/with-markdown-plugins/package.json +++ b/examples/with-markdown-plugins/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/markdown-remark": "^0.14.0", diff --git a/examples/with-markdown-shiki/package.json b/examples/with-markdown-shiki/package.json index a7e8e8638..46201599a 100644 --- a/examples/with-markdown-shiki/package.json +++ b/examples/with-markdown-shiki/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/markdown-remark": "^0.14.0", diff --git a/examples/with-mdx/package.json b/examples/with-mdx/package.json index 7853a8759..7eaf81e9f 100644 --- a/examples/with-mdx/package.json +++ b/examples/with-mdx/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/mdx": "^0.6.0", diff --git a/examples/with-nanostores/package.json b/examples/with-nanostores/package.json index e4dc46eae..4944eaaaa 100644 --- a/examples/with-nanostores/package.json +++ b/examples/with-nanostores/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "dependencies": { "@nanostores/preact": "^0.1.3", diff --git a/examples/with-tailwindcss/package.json b/examples/with-tailwindcss/package.json index d713ac555..5137ac8d7 100644 --- a/examples/with-tailwindcss/package.json +++ b/examples/with-tailwindcss/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "@astrojs/tailwind": "^0.2.5", diff --git a/examples/with-vite-plugin-pwa/README.md b/examples/with-vite-plugin-pwa/README.md index 4a726dd44..3b5b359b0 100644 --- a/examples/with-vite-plugin-pwa/README.md +++ b/examples/with-vite-plugin-pwa/README.md @@ -31,12 +31,14 @@ Any static assets, like images, can be placed in the `public/` directory. All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------- |:-------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | +| Command | Action | +| :--------------------- | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro --help` | Get help using the Astro CLI | ## 👀 Want to learn more? diff --git a/examples/with-vite-plugin-pwa/package.json b/examples/with-vite-plugin-pwa/package.json index 88ea76eaf..c1b3b604a 100644 --- a/examples/with-vite-plugin-pwa/package.json +++ b/examples/with-vite-plugin-pwa/package.json @@ -6,7 +6,8 @@ "dev": "astro dev", "start": "astro dev", "build": "astro build", - "preview": "astro preview" + "preview": "astro preview", + "astro": "astro" }, "devDependencies": { "astro": "^1.0.0-rc.6", diff --git a/examples/with-vitest/package.json b/examples/with-vitest/package.json index c445064c9..4c52c99a7 100644 --- a/examples/with-vitest/package.json +++ b/examples/with-vitest/package.json @@ -8,6 +8,7 @@ "start": "astro dev", "build": "astro build", "preview": "astro preview", + "astro": "astro", "test": "vitest" }, "devDependencies": {