Compare commits
53 Commits
@vercel/bu
...
@vercel/py
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
47e3381c6d | ||
|
|
33aefdc029 | ||
|
|
30fe76a0cf | ||
|
|
97ef88dc28 | ||
|
|
f679098d7a | ||
|
|
2b57e12ad3 | ||
|
|
c4e94ad03f | ||
|
|
32afd67d29 | ||
|
|
7523e39f18 | ||
|
|
99f2f2f1ba | ||
|
|
63830d38ce | ||
|
|
f3428dd212 | ||
|
|
5eb8b16cbd | ||
|
|
226bf02be2 | ||
|
|
8505872f55 | ||
|
|
7db6436797 | ||
|
|
e2d76e9c92 | ||
|
|
337cb21d67 | ||
|
|
6bfff3e9eb | ||
|
|
ac5b259c11 | ||
|
|
bfc553db11 | ||
|
|
2b101d4692 | ||
|
|
3316f38cb4 | ||
|
|
7837387127 | ||
|
|
f478200dd3 | ||
|
|
c29de8206a | ||
|
|
a2df3b5463 | ||
|
|
73446e544a | ||
|
|
21ff4a58c3 | ||
|
|
2b9eb02b8c | ||
|
|
4ef4722460 | ||
|
|
be5308b137 | ||
|
|
08a83a94f8 | ||
|
|
543ffdfe5c | ||
|
|
c11527e904 | ||
|
|
d296064386 | ||
|
|
400a6c42bd | ||
|
|
71b3ded398 | ||
|
|
fc3fa61b59 | ||
|
|
1f98c4fee7 | ||
|
|
1cb5a91727 | ||
|
|
e8c7db59cf | ||
|
|
57b230e25f | ||
|
|
ab3fb25790 | ||
|
|
88d98f7497 | ||
|
|
90c1895949 | ||
|
|
46a1f3670b | ||
|
|
4b025fee92 | ||
|
|
dc8293dc13 | ||
|
|
78883dea23 | ||
|
|
b5b792e42f | ||
|
|
8993a3c4af | ||
|
|
57241aad81 |
10
.github/workflows/test.yml
vendored
@@ -17,6 +17,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
outputs:
|
outputs:
|
||||||
tests: ${{ steps['set-tests'].outputs['tests'] }}
|
tests: ${{ steps['set-tests'].outputs['tests'] }}
|
||||||
|
dplUrl: ${{ steps.waitForTarball.outputs.url }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: git --version
|
- run: git --version
|
||||||
@@ -32,6 +33,12 @@ jobs:
|
|||||||
echo "Files to test:"
|
echo "Files to test:"
|
||||||
echo "$TESTS_ARRAY"
|
echo "$TESTS_ARRAY"
|
||||||
echo "::set-output name=tests::$TESTS_ARRAY"
|
echo "::set-output name=tests::$TESTS_ARRAY"
|
||||||
|
- uses: patrickedqvist/wait-for-vercel-preview@ae34b392ef30297f2b672f9afb3c329bde9bd487
|
||||||
|
id: waitForTarball
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
max_timeout: 360
|
||||||
|
check_interval: 5
|
||||||
|
|
||||||
test:
|
test:
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
@@ -69,13 +76,14 @@ jobs:
|
|||||||
- run: yarn install --network-timeout 1000000
|
- run: yarn install --network-timeout 1000000
|
||||||
|
|
||||||
- name: Build ${{matrix.packageName}} and all its dependencies
|
- name: Build ${{matrix.packageName}} and all its dependencies
|
||||||
run: yarn turbo run build --cache-dir=".turbo" --scope=${{matrix.packageName}} --include-dependencies --no-deps
|
run: node_modules/.bin/turbo run build --cache-dir=".turbo" --scope=${{matrix.packageName}} --include-dependencies --no-deps
|
||||||
env:
|
env:
|
||||||
FORCE_COLOR: '1'
|
FORCE_COLOR: '1'
|
||||||
- name: Test ${{matrix.packageName}}
|
- name: Test ${{matrix.packageName}}
|
||||||
run: node_modules/.bin/turbo run test --cache-dir=".turbo" --scope=${{matrix.packageName}} --no-deps -- ${{ join(matrix.testPaths, ' ') }}
|
run: node_modules/.bin/turbo run test --cache-dir=".turbo" --scope=${{matrix.packageName}} --no-deps -- ${{ join(matrix.testPaths, ' ') }}
|
||||||
shell: bash
|
shell: bash
|
||||||
env:
|
env:
|
||||||
|
VERCEL_CLI_VERSION: ${{ needs.setup.outputs.dplUrl }}/tarballs/vercel.tgz
|
||||||
VERCEL_TEAM_TOKEN: ${{ secrets.VERCEL_TEAM_TOKEN }}
|
VERCEL_TEAM_TOKEN: ${{ secrets.VERCEL_TEAM_TOKEN }}
|
||||||
VERCEL_REGISTRATION_URL: ${{ secrets.VERCEL_REGISTRATION_URL }}
|
VERCEL_REGISTRATION_URL: ${{ secrets.VERCEL_REGISTRATION_URL }}
|
||||||
FORCE_COLOR: '1'
|
FORCE_COLOR: '1'
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
# Runtime Developer Reference
|
# Runtime Developer Reference
|
||||||
|
|
||||||
The following page is a reference for how to create a Runtime by implementing
|
The following page is a reference for how to create a Runtime by implementing
|
||||||
the Runtime API interface.
|
the Runtime API interface. It's a way to add support for a new programming language to Vercel.
|
||||||
|
|
||||||
|
> Note: If you're the author of a web framework, please use the [Build Output API](https://vercel.com/docs/build-output-api/v3) instead to make your framework compatible with Vercel.
|
||||||
|
|
||||||
A Runtime is an npm module that implements the following interface:
|
A Runtime is an npm module that implements the following interface:
|
||||||
|
|
||||||
|
|||||||
@@ -35,6 +35,6 @@ For details on how to use Vercel, check out our [documentation](https://vercel.c
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
- [Code of Conduct](https://github.com/vercel/vercel/blob/main/.github/CODE_OF_CONDUCT.md)
|
- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
|
||||||
- [Contributing Guidelines](https://github.com/vercel/vercel/blob/main/.github/CONTRIBUTING.md)
|
- [Contributing Guidelines](./.github/CONTRIBUTING.md)
|
||||||
- [MIT License](https://github.com/vercel/vercel/blob/main/LICENSE)
|
- [MIT License](./LICENSE)
|
||||||
|
|||||||
@@ -5,8 +5,7 @@
|
|||||||
"description": "API for the vercel/vercel repo",
|
"description": "API for the vercel/vercel repo",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"//TODO": "We should add this pkg to yarn workspaces",
|
"//TODO": "We should add this pkg to yarn workspaces"
|
||||||
"vercel-build": "cd .. && yarn install && yarn vercel-build"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@sentry/node": "5.11.1",
|
"@sentry/node": "5.11.1",
|
||||||
|
|||||||
@@ -15,5 +15,5 @@ _Live Example: https://docusaurus-2-template.vercel.app_
|
|||||||
To get started with Docusaurus on Vercel, you can use the [Docusaurus CLI](https://v2.docusaurus.io/docs/installation#scaffold-project-website) to initialize the project:
|
To get started with Docusaurus on Vercel, you can use the [Docusaurus CLI](https://v2.docusaurus.io/docs/installation#scaffold-project-website) to initialize the project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ npx @docusaurus/init@next init my-website classic
|
npx create-docusaurus@latest my-website classic
|
||||||
```
|
```
|
||||||
|
|||||||
3
examples/docusaurus-2/babel.config.js
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||||
|
};
|
||||||
@@ -1,10 +1,11 @@
|
|||||||
---
|
---
|
||||||
id: hola
|
slug: first-blog-post
|
||||||
title: Hola
|
title: First Blog Post
|
||||||
author: Gao Wei
|
authors:
|
||||||
author_title: Docusaurus Core Team
|
name: Gao Wei
|
||||||
author_url: https://github.com/wgao19
|
title: Docusaurus Core Team
|
||||||
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
|
url: https://github.com/wgao19
|
||||||
|
image_url: https://github.com/wgao19.png
|
||||||
tags: [hola, docusaurus]
|
tags: [hola, docusaurus]
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
id: hello-world
|
|
||||||
title: Hello
|
|
||||||
author: Endilie Yacop Sucipto
|
|
||||||
author_title: Maintainer of Docusaurus
|
|
||||||
author_url: https://github.com/endiliey
|
|
||||||
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
|
||||||
tags: [hello, docusaurus]
|
|
||||||
---
|
|
||||||
|
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
|
||||||
|
|
||||||
<!--truncate-->
|
|
||||||
|
|
||||||
This is a test post.
|
|
||||||
|
|
||||||
A whole bunch of other information.
|
|
||||||
44
examples/docusaurus-2/blog/2019-05-29-long-blog-post.md
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
---
|
||||||
|
slug: long-blog-post
|
||||||
|
title: Long Blog Post
|
||||||
|
authors: endi
|
||||||
|
tags: [hello, docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
This is the summary of a very long blog post,
|
||||||
|
|
||||||
|
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
|
||||||
|
|
||||||
|
<!--truncate-->
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
id: welcome
|
|
||||||
title: Welcome
|
|
||||||
author: Yangshun Tay
|
|
||||||
author_title: Front End Engineer @ Facebook
|
|
||||||
author_url: https://github.com/yangshun
|
|
||||||
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4
|
|
||||||
tags: [facebook, hello, docusaurus]
|
|
||||||
---
|
|
||||||
|
|
||||||
Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well!
|
|
||||||
|
|
||||||
Delete the whole directory if you don't want the blog features. As simple as that!
|
|
||||||
20
examples/docusaurus-2/blog/2021-08-01-mdx-blog-post.mdx
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: mdx-blog-post
|
||||||
|
title: MDX Blog Post
|
||||||
|
authors: [slorber]
|
||||||
|
tags: [docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Use the power of React to create interactive blog posts.
|
||||||
|
|
||||||
|
```js
|
||||||
|
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||||
|
|
||||||
|
:::
|
||||||
|
After Width: | Height: | Size: 94 KiB |
25
examples/docusaurus-2/blog/2021-08-26-welcome/index.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
slug: welcome
|
||||||
|
title: Welcome
|
||||||
|
authors: [slorber, yangshun]
|
||||||
|
tags: [facebook, hello, docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
|
||||||
|
|
||||||
|
Simply add Markdown files (or folders) to the `blog` directory.
|
||||||
|
|
||||||
|
Regular blog authors can be added to `authors.yml`.
|
||||||
|
|
||||||
|
The blog post date can be extracted from filenames, such as:
|
||||||
|
|
||||||
|
- `2019-05-30-welcome.md`
|
||||||
|
- `2019-05-30-welcome/index.md`
|
||||||
|
|
||||||
|
A blog post folder can be convenient to co-locate blog post images:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The blog supports tags as well!
|
||||||
|
|
||||||
|
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
|
||||||
17
examples/docusaurus-2/blog/authors.yml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
endi:
|
||||||
|
name: Endilie Yacop Sucipto
|
||||||
|
title: Maintainer of Docusaurus
|
||||||
|
url: https://github.com/endiliey
|
||||||
|
image_url: https://github.com/endiliey.png
|
||||||
|
|
||||||
|
yangshun:
|
||||||
|
name: Yangshun Tay
|
||||||
|
title: Front End Engineer @ Facebook
|
||||||
|
url: https://github.com/yangshun
|
||||||
|
image_url: https://github.com/yangshun.png
|
||||||
|
|
||||||
|
slorber:
|
||||||
|
name: Sébastien Lorber
|
||||||
|
title: Docusaurus maintainer
|
||||||
|
url: https://sebastienlorber.com
|
||||||
|
image_url: https://github.com/slorber.png
|
||||||
@@ -1,202 +0,0 @@
|
|||||||
---
|
|
||||||
id: doc1
|
|
||||||
title: Style Guide
|
|
||||||
sidebar_label: Style Guide
|
|
||||||
---
|
|
||||||
|
|
||||||
You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
|
|
||||||
|
|
||||||
## Markdown Syntax
|
|
||||||
|
|
||||||
To serve as an example page when styling markdown based Docusaurus sites.
|
|
||||||
|
|
||||||
## Headers
|
|
||||||
|
|
||||||
# H1 - Create the best documentation
|
|
||||||
|
|
||||||
## H2 - Create the best documentation
|
|
||||||
|
|
||||||
### H3 - Create the best documentation
|
|
||||||
|
|
||||||
#### H4 - Create the best documentation
|
|
||||||
|
|
||||||
##### H5 - Create the best documentation
|
|
||||||
|
|
||||||
###### H6 - Create the best documentation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Emphasis
|
|
||||||
|
|
||||||
Emphasis, aka italics, with _asterisks_ or _underscores_.
|
|
||||||
|
|
||||||
Strong emphasis, aka bold, with **asterisks** or **underscores**.
|
|
||||||
|
|
||||||
Combined emphasis with **asterisks and _underscores_**.
|
|
||||||
|
|
||||||
Strikethrough uses two tildes. ~~Scratch this.~~
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Lists
|
|
||||||
|
|
||||||
1. First ordered list item
|
|
||||||
1. Another item ⋅⋅\* Unordered sub-list.
|
|
||||||
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
|
|
||||||
1. And another item.
|
|
||||||
|
|
||||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
|
||||||
|
|
||||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
|
||||||
|
|
||||||
- Unordered list can use asterisks
|
|
||||||
|
|
||||||
* Or minuses
|
|
||||||
|
|
||||||
- Or pluses
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
[I'm an inline-style link](https://www.google.com)
|
|
||||||
|
|
||||||
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
|
|
||||||
|
|
||||||
[I'm a reference-style link][arbitrary case-insensitive reference text]
|
|
||||||
|
|
||||||
[I'm a relative reference to a repository file](../blob/master/LICENSE)
|
|
||||||
|
|
||||||
[You can use numbers for reference-style link definitions][1]
|
|
||||||
|
|
||||||
Or leave it empty and use the [link text itself].
|
|
||||||
|
|
||||||
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com> and sometimes example.com (but not on Github, for example).
|
|
||||||
|
|
||||||
Some text to show that the reference links can follow later.
|
|
||||||
|
|
||||||
[arbitrary case-insensitive reference text]: https://www.mozilla.org
|
|
||||||
[1]: http://slashdot.org
|
|
||||||
[link text itself]: http://www.reddit.com
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Images
|
|
||||||
|
|
||||||
Here's our logo (hover to see the title text):
|
|
||||||
|
|
||||||
Inline-style: 
|
|
||||||
|
|
||||||
Reference-style: ![alt text][logo]
|
|
||||||
|
|
||||||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Code
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var s = 'JavaScript syntax highlighting';
|
|
||||||
alert(s);
|
|
||||||
```
|
|
||||||
|
|
||||||
```python
|
|
||||||
s = "Python syntax highlighting"
|
|
||||||
print(s)
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
No language indicated, so no syntax highlighting.
|
|
||||||
But let's throw in a <b>tag</b>.
|
|
||||||
```
|
|
||||||
|
|
||||||
```js {2}
|
|
||||||
function highlightMe() {
|
|
||||||
console.log('This line can be highlighted!');
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tables
|
|
||||||
|
|
||||||
Colons can be used to align columns.
|
|
||||||
|
|
||||||
| Tables | Are | Cool |
|
|
||||||
| ------------- | :-----------: | -----: |
|
|
||||||
| col 3 is | right-aligned | \$1600 |
|
|
||||||
| col 2 is | centered | \$12 |
|
|
||||||
| zebra stripes | are neat | \$1 |
|
|
||||||
|
|
||||||
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
|
|
||||||
|
|
||||||
| Markdown | Less | Pretty |
|
|
||||||
| -------- | --------- | ---------- |
|
|
||||||
| _Still_ | `renders` | **nicely** |
|
|
||||||
| 1 | 2 | 3 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Blockquotes
|
|
||||||
|
|
||||||
> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
|
|
||||||
|
|
||||||
Quote break.
|
|
||||||
|
|
||||||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Inline HTML
|
|
||||||
|
|
||||||
<dl>
|
|
||||||
<dt>Definition list</dt>
|
|
||||||
<dd>Is something people use sometimes.</dd>
|
|
||||||
|
|
||||||
<dt>Markdown in HTML</dt>
|
|
||||||
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
|
|
||||||
</dl>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Line Breaks
|
|
||||||
|
|
||||||
Here's a line for us to start with.
|
|
||||||
|
|
||||||
This line is separated from the one above by two newlines, so it will be a _separate paragraph_.
|
|
||||||
|
|
||||||
This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Admonitions
|
|
||||||
|
|
||||||
:::note
|
|
||||||
|
|
||||||
This is a note
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
This is a tip
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::important
|
|
||||||
|
|
||||||
This is important
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::caution
|
|
||||||
|
|
||||||
This is a caution
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
|
|
||||||
This is a warning
|
|
||||||
|
|
||||||
:::
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
id: doc2
|
|
||||||
title: Document Number 2
|
|
||||||
---
|
|
||||||
|
|
||||||
This is a link to [another document.](doc3.md) This is a link to an [external page.](http://www.example.com)
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
id: doc3
|
|
||||||
title: This is Document Number 3
|
|
||||||
---
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ac euismod odio, eu consequat dui. Nullam molestie consectetur risus id imperdiet. Proin sodales ornare turpis, non mollis massa ultricies id. Nam at nibh scelerisque, feugiat ante non, dapibus tortor. Vivamus volutpat diam quis tellus elementum bibendum. Praesent semper gravida velit quis aliquam. Etiam in cursus neque. Nam lectus ligula, malesuada et mauris a, bibendum faucibus mi. Phasellus ut interdum felis. Phasellus in odio pulvinar, porttitor urna eget, fringilla lectus. Aliquam sollicitudin est eros. Mauris consectetur quam vitae mauris interdum hendrerit. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
|
||||||
|
|
||||||
Duis et egestas libero, imperdiet faucibus ipsum. Sed posuere eget urna vel feugiat. Vivamus a arcu sagittis, fermentum urna dapibus, congue lectus. Fusce vulputate porttitor nisl, ac cursus elit volutpat vitae. Nullam vitae ipsum egestas, convallis quam non, porta nibh. Morbi gravida erat nec neque bibendum, eu pellentesque velit posuere. Fusce aliquam erat eu massa eleifend tristique.
|
|
||||||
|
|
||||||
Sed consequat sollicitudin ipsum eget tempus. Integer a aliquet velit. In justo nibh, pellentesque non suscipit eget, gravida vel lacus. Donec odio ante, malesuada in massa quis, pharetra tristique ligula. Donec eros est, tristique eget finibus quis, semper non nisl. Vivamus et elit nec enim ornare placerat. Sed posuere odio a elit cursus sagittis.
|
|
||||||
|
|
||||||
Phasellus feugiat purus eu tortor ultrices finibus. Ut libero nibh, lobortis et libero nec, dapibus posuere eros. Sed sagittis euismod justo at consectetur. Nulla finibus libero placerat, cursus sapien at, eleifend ligula. Vivamus elit nisl, hendrerit ac nibh eu, ultrices tempus dui. Nam tellus neque, commodo non rhoncus eu, gravida in risus. Nullam id iaculis tortor.
|
|
||||||
|
|
||||||
Nullam at odio in sem varius tempor sit amet vel lorem. Etiam eu hendrerit nisl. Fusce nibh mauris, vulputate sit amet ex vitae, congue rhoncus nisl. Sed eget tellus purus. Nullam tempus commodo erat ut tristique. Cras accumsan massa sit amet justo consequat eleifend. Integer scelerisque vitae tellus id consectetur.
|
|
||||||
47
examples/docusaurus-2/docs/intro.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Tutorial Intro
|
||||||
|
|
||||||
|
Let's discover **Docusaurus in less than 5 minutes**.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Get started by **creating a new site**.
|
||||||
|
|
||||||
|
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||||
|
|
||||||
|
### What you'll need
|
||||||
|
|
||||||
|
- [Node.js](https://nodejs.org/en/download/) version 16.14 or above:
|
||||||
|
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||||
|
|
||||||
|
## Generate a new site
|
||||||
|
|
||||||
|
Generate a new Docusaurus site using the **classic template**.
|
||||||
|
|
||||||
|
The classic template will automatically be added to your project after you run the command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm init docusaurus@latest my-website classic
|
||||||
|
```
|
||||||
|
|
||||||
|
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||||
|
|
||||||
|
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||||
|
|
||||||
|
## Start your site
|
||||||
|
|
||||||
|
Run the development server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd my-website
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||||
|
|
||||||
|
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||||
|
|
||||||
|
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
id: mdx
|
|
||||||
title: Powered by MDX
|
|
||||||
---
|
|
||||||
|
|
||||||
You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/).
|
|
||||||
|
|
||||||
export const Highlight = ({children, color}) => ( <span style={{
|
|
||||||
backgroundColor: color,
|
|
||||||
borderRadius: '2px',
|
|
||||||
color: '#fff',
|
|
||||||
padding: '0.2rem',
|
|
||||||
}}> {children} </span> );
|
|
||||||
|
|
||||||
<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.
|
|
||||||
|
|
||||||
I can write **Markdown** alongside my _JSX_!
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"label": "Tutorial - Basics",
|
||||||
|
"position": 2,
|
||||||
|
"link": {
|
||||||
|
"type": "generated-index",
|
||||||
|
"description": "5 minutes to learn the most important Docusaurus concepts."
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 6
|
||||||
|
---
|
||||||
|
|
||||||
|
# Congratulations!
|
||||||
|
|
||||||
|
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||||
|
|
||||||
|
Docusaurus has **much more to offer**!
|
||||||
|
|
||||||
|
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||||
|
|
||||||
|
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||||
|
|
||||||
|
## What's next?
|
||||||
|
|
||||||
|
- Read the [official documentation](https://docusaurus.io/).
|
||||||
|
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||||
|
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||||
|
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||||
|
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Create a Blog Post
|
||||||
|
|
||||||
|
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||||
|
|
||||||
|
## Create your first Post
|
||||||
|
|
||||||
|
Create a file at `blog/2021-02-28-greetings.md`:
|
||||||
|
|
||||||
|
```md title="blog/2021-02-28-greetings.md"
|
||||||
|
---
|
||||||
|
slug: greetings
|
||||||
|
title: Greetings!
|
||||||
|
authors:
|
||||||
|
- name: Joel Marcey
|
||||||
|
title: Co-creator of Docusaurus 1
|
||||||
|
url: https://github.com/JoelMarcey
|
||||||
|
image_url: https://github.com/JoelMarcey.png
|
||||||
|
- name: Sébastien Lorber
|
||||||
|
title: Docusaurus maintainer
|
||||||
|
url: https://sebastienlorber.com
|
||||||
|
image_url: https://github.com/slorber.png
|
||||||
|
tags: [greetings]
|
||||||
|
---
|
||||||
|
|
||||||
|
Congratulations, you have made your first post!
|
||||||
|
|
||||||
|
Feel free to play around and edit this post as much you like.
|
||||||
|
```
|
||||||
|
|
||||||
|
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Create a Document
|
||||||
|
|
||||||
|
Documents are **groups of pages** connected through:
|
||||||
|
|
||||||
|
- a **sidebar**
|
||||||
|
- **previous/next navigation**
|
||||||
|
- **versioning**
|
||||||
|
|
||||||
|
## Create your first Doc
|
||||||
|
|
||||||
|
Create a Markdown file at `docs/hello.md`:
|
||||||
|
|
||||||
|
```md title="docs/hello.md"
|
||||||
|
# Hello
|
||||||
|
|
||||||
|
This is my **first Docusaurus document**!
|
||||||
|
```
|
||||||
|
|
||||||
|
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||||
|
|
||||||
|
## Configure the Sidebar
|
||||||
|
|
||||||
|
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||||
|
|
||||||
|
Add metadata to customize the sidebar label and position:
|
||||||
|
|
||||||
|
```md title="docs/hello.md" {1-4}
|
||||||
|
---
|
||||||
|
sidebar_label: 'Hi!'
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hello
|
||||||
|
|
||||||
|
This is my **first Docusaurus document**!
|
||||||
|
```
|
||||||
|
|
||||||
|
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
||||||
|
|
||||||
|
```js title="sidebars.js"
|
||||||
|
module.exports = {
|
||||||
|
tutorialSidebar: [
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Tutorial',
|
||||||
|
// highlight-next-line
|
||||||
|
items: ['hello'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
43
examples/docusaurus-2/docs/tutorial-basics/create-a-page.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Create a Page
|
||||||
|
|
||||||
|
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||||
|
|
||||||
|
- `src/pages/index.js` → `localhost:3000/`
|
||||||
|
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||||
|
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
|
||||||
|
|
||||||
|
## Create your first React Page
|
||||||
|
|
||||||
|
Create a file at `src/pages/my-react-page.js`:
|
||||||
|
|
||||||
|
```jsx title="src/pages/my-react-page.js"
|
||||||
|
import React from 'react';
|
||||||
|
import Layout from '@theme/Layout';
|
||||||
|
|
||||||
|
export default function MyReactPage() {
|
||||||
|
return (
|
||||||
|
<Layout>
|
||||||
|
<h1>My React page</h1>
|
||||||
|
<p>This is a React page</p>
|
||||||
|
</Layout>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
|
||||||
|
|
||||||
|
## Create your first Markdown Page
|
||||||
|
|
||||||
|
Create a file at `src/pages/my-markdown-page.md`:
|
||||||
|
|
||||||
|
```mdx title="src/pages/my-markdown-page.md"
|
||||||
|
# My Markdown page
|
||||||
|
|
||||||
|
This is a Markdown page
|
||||||
|
```
|
||||||
|
|
||||||
|
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
|
# Deploy your site
|
||||||
|
|
||||||
|
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||||
|
|
||||||
|
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||||
|
|
||||||
|
## Build your site
|
||||||
|
|
||||||
|
Build your site **for production**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
The static files are generated in the `build` folder.
|
||||||
|
|
||||||
|
## Deploy your site
|
||||||
|
|
||||||
|
Test your production build locally:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run serve
|
||||||
|
```
|
||||||
|
|
||||||
|
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||||
|
|
||||||
|
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||||
146
examples/docusaurus-2/docs/tutorial-basics/markdown-features.mdx
Normal file
@@ -0,0 +1,146 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
|
# Markdown Features
|
||||||
|
|
||||||
|
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
||||||
|
|
||||||
|
## Front Matter
|
||||||
|
|
||||||
|
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
||||||
|
|
||||||
|
```text title="my-doc.md"
|
||||||
|
// highlight-start
|
||||||
|
---
|
||||||
|
id: my-doc-id
|
||||||
|
title: My document title
|
||||||
|
description: My document description
|
||||||
|
slug: /my-custom-url
|
||||||
|
---
|
||||||
|
// highlight-end
|
||||||
|
|
||||||
|
## Markdown heading
|
||||||
|
|
||||||
|
Markdown text with [links](./hello.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
Regular Markdown links are supported, using url paths or relative file paths.
|
||||||
|
|
||||||
|
```md
|
||||||
|
Let's see how to [Create a page](/create-a-page).
|
||||||
|
```
|
||||||
|
|
||||||
|
```md
|
||||||
|
Let's see how to [Create a page](./create-a-page.md).
|
||||||
|
```
|
||||||
|
|
||||||
|
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
||||||
|
|
||||||
|
## Images
|
||||||
|
|
||||||
|
Regular Markdown images are supported.
|
||||||
|
|
||||||
|
You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
|
||||||
|
|
||||||
|
```md
|
||||||
|

|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You can reference images relative to the current file as well, as shown in [the extra guides](../tutorial-extras/manage-docs-versions.md).
|
||||||
|
|
||||||
|
## Code Blocks
|
||||||
|
|
||||||
|
Markdown code blocks are supported with Syntax highlighting.
|
||||||
|
|
||||||
|
```jsx title="src/components/HelloDocusaurus.js"
|
||||||
|
function HelloDocusaurus() {
|
||||||
|
return (
|
||||||
|
<h1>Hello, Docusaurus!</h1>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsx title="src/components/HelloDocusaurus.js"
|
||||||
|
function HelloDocusaurus() {
|
||||||
|
return <h1>Hello, Docusaurus!</h1>;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Admonitions
|
||||||
|
|
||||||
|
Docusaurus has a special syntax to create admonitions and callouts:
|
||||||
|
|
||||||
|
:::tip My tip
|
||||||
|
|
||||||
|
Use this awesome feature option
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::danger Take care
|
||||||
|
|
||||||
|
This action is dangerous
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::tip My tip
|
||||||
|
|
||||||
|
Use this awesome feature option
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::danger Take care
|
||||||
|
|
||||||
|
This action is dangerous
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## MDX and React Components
|
||||||
|
|
||||||
|
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
export const Highlight = ({children, color}) => (
|
||||||
|
<span
|
||||||
|
style={{
|
||||||
|
backgroundColor: color,
|
||||||
|
borderRadius: '20px',
|
||||||
|
color: '#fff',
|
||||||
|
padding: '10px',
|
||||||
|
cursor: 'pointer',
|
||||||
|
}}
|
||||||
|
onClick={() => {
|
||||||
|
alert(`You clicked the color ${color} with label ${children}`)
|
||||||
|
}}>
|
||||||
|
{children}
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
|
||||||
|
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||||
|
|
||||||
|
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||||
|
```
|
||||||
|
|
||||||
|
export const Highlight = ({children, color}) => (
|
||||||
|
<span
|
||||||
|
style={{
|
||||||
|
backgroundColor: color,
|
||||||
|
borderRadius: '20px',
|
||||||
|
color: '#fff',
|
||||||
|
padding: '10px',
|
||||||
|
cursor: 'pointer',
|
||||||
|
}}
|
||||||
|
onClick={() => {
|
||||||
|
alert(`You clicked the color ${color} with label ${children}`);
|
||||||
|
}}>
|
||||||
|
{children}
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
|
||||||
|
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||||
|
|
||||||
|
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"label": "Tutorial - Extras",
|
||||||
|
"position": 3,
|
||||||
|
"link": {
|
||||||
|
"type": "generated-index"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 27 KiB |
@@ -0,0 +1,55 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Manage Docs Versions
|
||||||
|
|
||||||
|
Docusaurus can manage multiple versions of your docs.
|
||||||
|
|
||||||
|
## Create a docs version
|
||||||
|
|
||||||
|
Release a version 1.0 of your project:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run docusaurus docs:version 1.0
|
||||||
|
```
|
||||||
|
|
||||||
|
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
||||||
|
|
||||||
|
Your docs now have 2 versions:
|
||||||
|
|
||||||
|
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
||||||
|
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
||||||
|
|
||||||
|
## Add a Version Dropdown
|
||||||
|
|
||||||
|
To navigate seamlessly across versions, add a version dropdown.
|
||||||
|
|
||||||
|
Modify the `docusaurus.config.js` file:
|
||||||
|
|
||||||
|
```js title="docusaurus.config.js"
|
||||||
|
module.exports = {
|
||||||
|
themeConfig: {
|
||||||
|
navbar: {
|
||||||
|
items: [
|
||||||
|
// highlight-start
|
||||||
|
{
|
||||||
|
type: 'docsVersionDropdown',
|
||||||
|
},
|
||||||
|
// highlight-end
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
The docs version dropdown appears in your navbar:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Update an existing version
|
||||||
|
|
||||||
|
It is possible to edit versioned docs in their respective folder:
|
||||||
|
|
||||||
|
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
||||||
|
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Translate your site
|
||||||
|
|
||||||
|
Let's translate `docs/intro.md` to French.
|
||||||
|
|
||||||
|
## Configure i18n
|
||||||
|
|
||||||
|
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
||||||
|
|
||||||
|
```js title="docusaurus.config.js"
|
||||||
|
module.exports = {
|
||||||
|
i18n: {
|
||||||
|
defaultLocale: 'en',
|
||||||
|
locales: ['en', 'fr'],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Translate a doc
|
||||||
|
|
||||||
|
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
||||||
|
|
||||||
|
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
||||||
|
|
||||||
|
## Start your localized site
|
||||||
|
|
||||||
|
Start your site on the French locale:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run start -- --locale fr
|
||||||
|
```
|
||||||
|
|
||||||
|
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
|
||||||
|
In development, you can only use one locale at a same time.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Add a Locale Dropdown
|
||||||
|
|
||||||
|
To navigate seamlessly across languages, add a locale dropdown.
|
||||||
|
|
||||||
|
Modify the `docusaurus.config.js` file:
|
||||||
|
|
||||||
|
```js title="docusaurus.config.js"
|
||||||
|
module.exports = {
|
||||||
|
themeConfig: {
|
||||||
|
navbar: {
|
||||||
|
items: [
|
||||||
|
// highlight-start
|
||||||
|
{
|
||||||
|
type: 'localeDropdown',
|
||||||
|
},
|
||||||
|
// highlight-end
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
The locale dropdown now appears in your navbar:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Build your localized site
|
||||||
|
|
||||||
|
Build your site for a specific locale:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build -- --locale fr
|
||||||
|
```
|
||||||
|
|
||||||
|
Or build your site to include all the locales at once:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
@@ -1,26 +1,75 @@
|
|||||||
module.exports = {
|
// @ts-check
|
||||||
|
// Note: type annotations allow type checking and IDEs autocompletion
|
||||||
|
|
||||||
|
const lightCodeTheme = require('prism-react-renderer/themes/github');
|
||||||
|
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
||||||
|
|
||||||
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
|
const config = {
|
||||||
title: 'My Site',
|
title: 'My Site',
|
||||||
tagline: 'The tagline of my site',
|
tagline: 'Dinosaurs are cool',
|
||||||
url: 'https://your-docusaurus-test-site.com',
|
url: 'https://your-docusaurus-test-site.com',
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
|
onBrokenLinks: 'throw',
|
||||||
|
onBrokenMarkdownLinks: 'warn',
|
||||||
favicon: 'img/favicon.ico',
|
favicon: 'img/favicon.ico',
|
||||||
|
|
||||||
|
// GitHub pages deployment config.
|
||||||
|
// If you aren't using GitHub pages, you don't need these.
|
||||||
organizationName: 'facebook', // Usually your GitHub org/user name.
|
organizationName: 'facebook', // Usually your GitHub org/user name.
|
||||||
projectName: 'docusaurus', // Usually your repo name.
|
projectName: 'docusaurus', // Usually your repo name.
|
||||||
themeConfig: {
|
|
||||||
|
// Even if you don't use internalization, you can use this field to set useful
|
||||||
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
||||||
|
// to replace "en" with "zh-Hans".
|
||||||
|
i18n: {
|
||||||
|
defaultLocale: 'en',
|
||||||
|
locales: ['en'],
|
||||||
|
},
|
||||||
|
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
'classic',
|
||||||
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
|
({
|
||||||
|
docs: {
|
||||||
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
|
// Please change this to your repo.
|
||||||
|
// Remove this to remove the "edit this page" links.
|
||||||
|
editUrl:
|
||||||
|
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
||||||
|
},
|
||||||
|
blog: {
|
||||||
|
showReadingTime: true,
|
||||||
|
// Please change this to your repo.
|
||||||
|
// Remove this to remove the "edit this page" links.
|
||||||
|
editUrl:
|
||||||
|
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
||||||
|
},
|
||||||
|
theme: {
|
||||||
|
customCss: require.resolve('./src/css/custom.css'),
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
|
||||||
|
themeConfig:
|
||||||
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
|
({
|
||||||
navbar: {
|
navbar: {
|
||||||
title: 'My Site',
|
title: 'My Site',
|
||||||
logo: {
|
logo: {
|
||||||
alt: 'My Site Logo',
|
alt: 'My Site Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/logo.svg',
|
||||||
},
|
},
|
||||||
links: [
|
items: [
|
||||||
{
|
{
|
||||||
to: 'docs/doc1',
|
type: 'doc',
|
||||||
activeBasePath: 'docs',
|
docId: 'intro',
|
||||||
label: 'Docs',
|
|
||||||
position: 'left',
|
position: 'left',
|
||||||
|
label: 'Tutorial',
|
||||||
},
|
},
|
||||||
{to: 'blog', label: 'Blog', position: 'left'},
|
{to: '/blog', label: 'Blog', position: 'left'},
|
||||||
{
|
{
|
||||||
href: 'https://github.com/facebook/docusaurus',
|
href: 'https://github.com/facebook/docusaurus',
|
||||||
label: 'GitHub',
|
label: 'GitHub',
|
||||||
@@ -35,12 +84,8 @@ module.exports = {
|
|||||||
title: 'Docs',
|
title: 'Docs',
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Style Guide',
|
label: 'Tutorial',
|
||||||
to: 'docs/doc1',
|
to: '/docs/intro',
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Second Doc',
|
|
||||||
to: 'docs/doc2',
|
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -66,7 +111,7 @@ module.exports = {
|
|||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: 'Blog',
|
label: 'Blog',
|
||||||
to: 'blog',
|
to: '/blog',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'GitHub',
|
label: 'GitHub',
|
||||||
@@ -77,27 +122,11 @@ module.exports = {
|
|||||||
],
|
],
|
||||||
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
|
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
|
||||||
},
|
},
|
||||||
|
prism: {
|
||||||
|
theme: lightCodeTheme,
|
||||||
|
darkTheme: darkCodeTheme,
|
||||||
},
|
},
|
||||||
presets: [
|
}),
|
||||||
[
|
|
||||||
'@docusaurus/preset-classic',
|
|
||||||
{
|
|
||||||
docs: {
|
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
|
||||||
// Please change this to your repo.
|
|
||||||
editUrl:
|
|
||||||
'https://github.com/facebook/docusaurus/edit/master/website/',
|
|
||||||
},
|
|
||||||
blog: {
|
|
||||||
showReadingTime: true,
|
|
||||||
// Please change this to your repo.
|
|
||||||
editUrl:
|
|
||||||
'https://github.com/facebook/docusaurus/edit/master/website/blog/',
|
|
||||||
},
|
|
||||||
theme: {
|
|
||||||
customCss: require.resolve('./src/css/custom.css'),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
module.exports = config;
|
||||||
|
|||||||
@@ -1,23 +1,31 @@
|
|||||||
{
|
{
|
||||||
"name": "docusaurus-2",
|
|
||||||
"version": "0.0.0",
|
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"docusaurus": "docusaurus",
|
||||||
"start": "docusaurus start",
|
"start": "docusaurus start",
|
||||||
"build": "docusaurus build",
|
"build": "docusaurus build",
|
||||||
"swizzle": "docusaurus swizzle",
|
"swizzle": "docusaurus swizzle",
|
||||||
"deploy": "docusaurus deploy"
|
"deploy": "docusaurus deploy",
|
||||||
|
"clear": "docusaurus clear",
|
||||||
|
"serve": "docusaurus serve",
|
||||||
|
"write-translations": "docusaurus write-translations",
|
||||||
|
"write-heading-ids": "docusaurus write-heading-ids"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/core": "^2.0.0-alpha.54",
|
"@docusaurus/core": "2.0.1",
|
||||||
"@docusaurus/preset-classic": "^2.0.0-alpha.54",
|
"@docusaurus/preset-classic": "2.0.1",
|
||||||
"classnames": "^2.2.6",
|
"@mdx-js/react": "^1.6.22",
|
||||||
"react": "^16.8.4",
|
"clsx": "^1.2.1",
|
||||||
"react-dom": "^16.8.4"
|
"prism-react-renderer": "^1.3.5",
|
||||||
|
"react": "^17.0.2",
|
||||||
|
"react-dom": "^17.0.2"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@docusaurus/module-type-aliases": "2.0.1"
|
||||||
},
|
},
|
||||||
"browserslist": {
|
"browserslist": {
|
||||||
"production": [
|
"production": [
|
||||||
">0.2%",
|
">0.5%",
|
||||||
"not dead",
|
"not dead",
|
||||||
"not op_mini all"
|
"not op_mini all"
|
||||||
],
|
],
|
||||||
@@ -26,5 +34,8 @@
|
|||||||
"last 1 firefox version",
|
"last 1 firefox version",
|
||||||
"last 1 safari version"
|
"last 1 safari version"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16.14"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,31 @@
|
|||||||
module.exports = {
|
/**
|
||||||
someSidebar: {
|
* Creating a sidebar enables you to:
|
||||||
Docusaurus: ['doc1', 'doc2', 'doc3'],
|
- create an ordered group of docs
|
||||||
Features: ['mdx'],
|
- render a sidebar for each doc of that group
|
||||||
|
- provide next/previous navigation
|
||||||
|
|
||||||
|
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||||
|
|
||||||
|
Create as many sidebars as you want.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// @ts-check
|
||||||
|
|
||||||
|
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||||
|
const sidebars = {
|
||||||
|
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||||
|
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||||
|
|
||||||
|
// But you can create a sidebar manually
|
||||||
|
/*
|
||||||
|
tutorialSidebar: [
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Tutorial',
|
||||||
|
items: ['hello'],
|
||||||
},
|
},
|
||||||
|
],
|
||||||
|
*/
|
||||||
};
|
};
|
||||||
|
|
||||||
|
module.exports = sidebars;
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import clsx from 'clsx';
|
||||||
|
import styles from './styles.module.css';
|
||||||
|
|
||||||
|
const FeatureList = [
|
||||||
|
{
|
||||||
|
title: 'Easy to Use',
|
||||||
|
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Docusaurus was designed from the ground up to be easily installed and
|
||||||
|
used to get your website up and running quickly.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Focus on What Matters',
|
||||||
|
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Docusaurus lets you focus on your docs, and we'll do the chores. Go
|
||||||
|
ahead and move your docs into the <code>docs</code> directory.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Powered by React',
|
||||||
|
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
|
||||||
|
description: (
|
||||||
|
<>
|
||||||
|
Extend or customize your website layout by reusing React. Docusaurus can
|
||||||
|
be extended while reusing the same header and footer.
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function Feature({Svg, title, description}) {
|
||||||
|
return (
|
||||||
|
<div className={clsx('col col--4')}>
|
||||||
|
<div className="text--center">
|
||||||
|
<Svg className={styles.featureSvg} role="img" />
|
||||||
|
</div>
|
||||||
|
<div className="text--center padding-horiz--md">
|
||||||
|
<h3>{title}</h3>
|
||||||
|
<p>{description}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function HomepageFeatures() {
|
||||||
|
return (
|
||||||
|
<section className={styles.features}>
|
||||||
|
<div className="container">
|
||||||
|
<div className="row">
|
||||||
|
{FeatureList.map((props, idx) => (
|
||||||
|
<Feature key={idx} {...props} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
.features {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
padding: 2rem 0;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.featureSvg {
|
||||||
|
height: 200px;
|
||||||
|
width: 200px;
|
||||||
|
}
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
/* stylelint-disable docusaurus/copyright-header */
|
|
||||||
/**
|
/**
|
||||||
* Any CSS included here will be global. The classic template
|
* Any CSS included here will be global. The classic template
|
||||||
* bundles Infima by default. Infima is a CSS framework designed to
|
* bundles Infima by default. Infima is a CSS framework designed to
|
||||||
@@ -7,19 +6,25 @@
|
|||||||
|
|
||||||
/* You can override the default Infima variables here. */
|
/* You can override the default Infima variables here. */
|
||||||
:root {
|
:root {
|
||||||
--ifm-color-primary: #25c2a0;
|
--ifm-color-primary: #2e8555;
|
||||||
--ifm-color-primary-dark: rgb(33, 175, 144);
|
--ifm-color-primary-dark: #29784c;
|
||||||
--ifm-color-primary-darker: rgb(31, 165, 136);
|
--ifm-color-primary-darker: #277148;
|
||||||
--ifm-color-primary-darkest: rgb(26, 136, 112);
|
--ifm-color-primary-darkest: #205d3b;
|
||||||
--ifm-color-primary-light: rgb(70, 203, 174);
|
--ifm-color-primary-light: #33925d;
|
||||||
--ifm-color-primary-lighter: rgb(102, 212, 189);
|
--ifm-color-primary-lighter: #359962;
|
||||||
--ifm-color-primary-lightest: rgb(146, 224, 208);
|
--ifm-color-primary-lightest: #3cad6e;
|
||||||
--ifm-code-font-size: 95%;
|
--ifm-code-font-size: 95%;
|
||||||
|
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
||||||
}
|
}
|
||||||
|
|
||||||
.docusaurus-highlight-code-line {
|
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||||
background-color: rgb(72, 77, 91);
|
[data-theme='dark'] {
|
||||||
display: block;
|
--ifm-color-primary: #25c2a0;
|
||||||
margin: 0 calc(-1 * var(--ifm-pre-padding));
|
--ifm-color-primary-dark: #21af90;
|
||||||
padding: 0 var(--ifm-pre-padding);
|
--ifm-color-primary-darker: #1fa588;
|
||||||
|
--ifm-color-primary-darkest: #1a8870;
|
||||||
|
--ifm-color-primary-light: #29d5b0;
|
||||||
|
--ifm-color-primary-lighter: #32d8b4;
|
||||||
|
--ifm-color-primary-lightest: #4fddbf;
|
||||||
|
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,97 +1,41 @@
|
|||||||
import React from 'react';
|
import React from 'react';
|
||||||
import classnames from 'classnames';
|
import clsx from 'clsx';
|
||||||
import Layout from '@theme/Layout';
|
|
||||||
import Link from '@docusaurus/Link';
|
import Link from '@docusaurus/Link';
|
||||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
import Layout from '@theme/Layout';
|
||||||
import styles from './styles.module.css';
|
import HomepageFeatures from '@site/src/components/HomepageFeatures';
|
||||||
|
|
||||||
const features = [
|
import styles from './index.module.css';
|
||||||
{
|
|
||||||
title: <>Easy to Use</>,
|
|
||||||
imageUrl: 'img/undraw_docusaurus_mountain.svg',
|
|
||||||
description: (
|
|
||||||
<>
|
|
||||||
Docusaurus was designed from the ground up to be easily installed and
|
|
||||||
used to get your website up and running quickly.
|
|
||||||
</>
|
|
||||||
),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: <>Focus on What Matters</>,
|
|
||||||
imageUrl: 'img/undraw_docusaurus_tree.svg',
|
|
||||||
description: (
|
|
||||||
<>
|
|
||||||
Docusaurus lets you focus on your docs, and we'll do the chores. Go
|
|
||||||
ahead and move your docs into the <code>docs</code> directory.
|
|
||||||
</>
|
|
||||||
),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: <>Powered by React</>,
|
|
||||||
imageUrl: 'img/undraw_docusaurus_react.svg',
|
|
||||||
description: (
|
|
||||||
<>
|
|
||||||
Extend or customize your website layout by reusing React. Docusaurus can
|
|
||||||
be extended while reusing the same header and footer.
|
|
||||||
</>
|
|
||||||
),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
function Feature({imageUrl, title, description}) {
|
function HomepageHeader() {
|
||||||
const imgUrl = useBaseUrl(imageUrl);
|
const {siteConfig} = useDocusaurusContext();
|
||||||
return (
|
return (
|
||||||
<div className={classnames('col col--4', styles.feature)}>
|
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||||
{imgUrl && (
|
|
||||||
<div className="text--center">
|
|
||||||
<img className={styles.featureImage} src={imgUrl} alt={title} />
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
<h3>{title}</h3>
|
|
||||||
<p>{description}</p>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function Home() {
|
|
||||||
const context = useDocusaurusContext();
|
|
||||||
const {siteConfig = {}} = context;
|
|
||||||
return (
|
|
||||||
<Layout
|
|
||||||
title={`Hello from ${siteConfig.title}`}
|
|
||||||
description="Description will go into a meta tag in <head />">
|
|
||||||
<header className={classnames('hero hero--primary', styles.heroBanner)}>
|
|
||||||
<div className="container">
|
<div className="container">
|
||||||
<h1 className="hero__title">{siteConfig.title}</h1>
|
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||||
<div className={styles.buttons}>
|
<div className={styles.buttons}>
|
||||||
<Link
|
<Link
|
||||||
className={classnames(
|
className="button button--secondary button--lg"
|
||||||
'button button--outline button--secondary button--lg',
|
to="/docs/intro">
|
||||||
styles.getStarted,
|
Docusaurus Tutorial - 5min ⏱️
|
||||||
)}
|
|
||||||
to={useBaseUrl('docs/doc1')}>
|
|
||||||
Get Started
|
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function Home() {
|
||||||
|
const {siteConfig} = useDocusaurusContext();
|
||||||
|
return (
|
||||||
|
<Layout
|
||||||
|
title={`Hello from ${siteConfig.title}`}
|
||||||
|
description="Description will go into a meta tag in <head />">
|
||||||
|
<HomepageHeader />
|
||||||
<main>
|
<main>
|
||||||
{features && features.length && (
|
<HomepageFeatures />
|
||||||
<section className={styles.features}>
|
|
||||||
<div className="container">
|
|
||||||
<div className="row">
|
|
||||||
{features.map((props, idx) => (
|
|
||||||
<Feature key={idx} {...props} />
|
|
||||||
))}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
)}
|
|
||||||
</main>
|
</main>
|
||||||
</Layout>
|
</Layout>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export default Home;
|
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
/* stylelint-disable docusaurus/copyright-header */
|
|
||||||
/**
|
/**
|
||||||
* CSS files with the .module.css suffix will be treated as CSS modules
|
* CSS files with the .module.css suffix will be treated as CSS modules
|
||||||
* and scoped locally.
|
* and scoped locally.
|
||||||
@@ -11,7 +10,7 @@
|
|||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media screen and (max-width: 966px) {
|
@media screen and (max-width: 996px) {
|
||||||
.heroBanner {
|
.heroBanner {
|
||||||
padding: 2rem;
|
padding: 2rem;
|
||||||
}
|
}
|
||||||
@@ -22,15 +21,3 @@
|
|||||||
align-items: center;
|
align-items: center;
|
||||||
justify-content: center;
|
justify-content: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.features {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
padding: 2rem 0;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.featureImage {
|
|
||||||
height: 200px;
|
|
||||||
width: 200px;
|
|
||||||
}
|
|
||||||
7
examples/docusaurus-2/src/pages/markdown-page.md
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Markdown page example
|
||||||
|
---
|
||||||
|
|
||||||
|
# Markdown page example
|
||||||
|
|
||||||
|
You don't need React to write simple standalone pages.
|
||||||
0
examples/docusaurus-2/static/.nojekyll
Normal file
BIN
examples/docusaurus-2/static/img/docusaurus.png
Normal file
|
After Width: | Height: | Size: 5.0 KiB |
|
Before Width: | Height: | Size: 766 B After Width: | Height: | Size: 3.5 KiB |
@@ -1,4 +1,5 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" width="1088" height="687.962" viewBox="0 0 1088 687.962">
|
<svg xmlns="http://www.w3.org/2000/svg" width="1088" height="687.962" viewBox="0 0 1088 687.962">
|
||||||
|
<title>Easy to Use</title>
|
||||||
<g id="Group_12" data-name="Group 12" transform="translate(-57 -56)">
|
<g id="Group_12" data-name="Group 12" transform="translate(-57 -56)">
|
||||||
<g id="Group_11" data-name="Group 11" transform="translate(57 56)">
|
<g id="Group_11" data-name="Group 11" transform="translate(57 56)">
|
||||||
<path id="Path_83" data-name="Path 83" d="M1017.81,560.461c-5.27,45.15-16.22,81.4-31.25,110.31-20,38.52-54.21,54.04-84.77,70.28a193.275,193.275,0,0,1-27.46,11.94c-55.61,19.3-117.85,14.18-166.74,3.99a657.282,657.282,0,0,0-104.09-13.16q-14.97-.675-29.97-.67c-15.42.02-293.07,5.29-360.67-131.57-16.69-33.76-28.13-75-32.24-125.27-11.63-142.12,52.29-235.46,134.74-296.47,155.97-115.41,369.76-110.57,523.43,7.88C941.15,276.621,1036.99,396.031,1017.81,560.461Z" transform="translate(-56 -106.019)" fill="#3f3d56"/>
|
<path id="Path_83" data-name="Path 83" d="M1017.81,560.461c-5.27,45.15-16.22,81.4-31.25,110.31-20,38.52-54.21,54.04-84.77,70.28a193.275,193.275,0,0,1-27.46,11.94c-55.61,19.3-117.85,14.18-166.74,3.99a657.282,657.282,0,0,0-104.09-13.16q-14.97-.675-29.97-.67c-15.42.02-293.07,5.29-360.67-131.57-16.69-33.76-28.13-75-32.24-125.27-11.63-142.12,52.29-235.46,134.74-296.47,155.97-115.41,369.76-110.57,523.43,7.88C941.15,276.621,1036.99,396.031,1017.81,560.461Z" transform="translate(-56 -106.019)" fill="#3f3d56"/>
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
@@ -1,4 +1,5 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" width="1041.277" height="554.141" viewBox="0 0 1041.277 554.141">
|
<svg xmlns="http://www.w3.org/2000/svg" width="1041.277" height="554.141" viewBox="0 0 1041.277 554.141">
|
||||||
|
<title>Powered by React</title>
|
||||||
<g id="Group_24" data-name="Group 24" transform="translate(-440 -263)">
|
<g id="Group_24" data-name="Group 24" transform="translate(-440 -263)">
|
||||||
<g id="Group_23" data-name="Group 23" transform="translate(439.989 262.965)">
|
<g id="Group_23" data-name="Group 23" transform="translate(439.989 262.965)">
|
||||||
<path id="Path_299" data-name="Path 299" d="M1040.82,611.12q-1.74,3.75-3.47,7.4-2.7,5.67-5.33,11.12c-.78,1.61-1.56,3.19-2.32,4.77-8.6,17.57-16.63,33.11-23.45,45.89A73.21,73.21,0,0,1,942.44,719l-151.65,1.65h-1.6l-13,.14-11.12.12-34.1.37h-1.38l-17.36.19h-.53l-107,1.16-95.51,1-11.11.12-69,.75H429l-44.75.48h-.48l-141.5,1.53-42.33.46a87.991,87.991,0,0,1-10.79-.54h0c-1.22-.14-2.44-.3-3.65-.49a87.38,87.38,0,0,1-51.29-27.54C116,678.37,102.75,655,93.85,629.64q-1.93-5.49-3.6-11.12C59.44,514.37,97,380,164.6,290.08q4.25-5.64,8.64-11l.07-.08c20.79-25.52,44.1-46.84,68.93-62,44-26.91,92.75-34.49,140.7-11.9,40.57,19.12,78.45,28.11,115.17,30.55,3.71.24,7.42.42,11.11.53,84.23,2.65,163.17-27.7,255.87-47.29,3.69-.78,7.39-1.55,11.12-2.28,66.13-13.16,139.49-20.1,226.73-5.51a189.089,189.089,0,0,1,26.76,6.4q5.77,1.86,11.12,4c41.64,16.94,64.35,48.24,74,87.46q1.37,5.46,2.37,11.11C1134.3,384.41,1084.19,518.23,1040.82,611.12Z" transform="translate(-79.34 -172.91)" fill="#f2f2f2"/>
|
<path id="Path_299" data-name="Path 299" d="M1040.82,611.12q-1.74,3.75-3.47,7.4-2.7,5.67-5.33,11.12c-.78,1.61-1.56,3.19-2.32,4.77-8.6,17.57-16.63,33.11-23.45,45.89A73.21,73.21,0,0,1,942.44,719l-151.65,1.65h-1.6l-13,.14-11.12.12-34.1.37h-1.38l-17.36.19h-.53l-107,1.16-95.51,1-11.11.12-69,.75H429l-44.75.48h-.48l-141.5,1.53-42.33.46a87.991,87.991,0,0,1-10.79-.54h0c-1.22-.14-2.44-.3-3.65-.49a87.38,87.38,0,0,1-51.29-27.54C116,678.37,102.75,655,93.85,629.64q-1.93-5.49-3.6-11.12C59.44,514.37,97,380,164.6,290.08q4.25-5.64,8.64-11l.07-.08c20.79-25.52,44.1-46.84,68.93-62,44-26.91,92.75-34.49,140.7-11.9,40.57,19.12,78.45,28.11,115.17,30.55,3.71.24,7.42.42,11.11.53,84.23,2.65,163.17-27.7,255.87-47.29,3.69-.78,7.39-1.55,11.12-2.28,66.13-13.16,139.49-20.1,226.73-5.51a189.089,189.089,0,0,1,26.76,6.4q5.77,1.86,11.12,4c41.64,16.94,64.35,48.24,74,87.46q1.37,5.46,2.37,11.11C1134.3,384.41,1084.19,518.23,1040.82,611.12Z" transform="translate(-79.34 -172.91)" fill="#f2f2f2"/>
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@vercel/build-utils",
|
"name": "@vercel/build-utils",
|
||||||
"version": "5.0.5",
|
"version": "5.3.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "./dist/index.js",
|
"main": "./dist/index.js",
|
||||||
"types": "./dist/index.d.js",
|
"types": "./dist/index.d.js",
|
||||||
@@ -14,8 +14,7 @@
|
|||||||
"build": "node build",
|
"build": "node build",
|
||||||
"test": "jest --env node --verbose --runInBand --bail",
|
"test": "jest --env node --verbose --runInBand --bail",
|
||||||
"test-unit": "yarn test test/unit.*test.*",
|
"test-unit": "yarn test test/unit.*test.*",
|
||||||
"test-integration-once": "yarn test test/integration.test.ts",
|
"test-integration-once": "yarn test test/integration.test.ts"
|
||||||
"prepublishOnly": "node build"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@iarna/toml": "2.2.3",
|
"@iarna/toml": "2.2.3",
|
||||||
@@ -31,7 +30,7 @@
|
|||||||
"@types/node-fetch": "^2.1.6",
|
"@types/node-fetch": "^2.1.6",
|
||||||
"@types/semver": "6.0.0",
|
"@types/semver": "6.0.0",
|
||||||
"@types/yazl": "2.4.2",
|
"@types/yazl": "2.4.2",
|
||||||
"@vercel/ncc": "0.34.0",
|
"@vercel/ncc": "0.24.0",
|
||||||
"aggregate-error": "3.0.1",
|
"aggregate-error": "3.0.1",
|
||||||
"async-retry": "1.2.3",
|
"async-retry": "1.2.3",
|
||||||
"async-sema": "2.1.4",
|
"async-sema": "2.1.4",
|
||||||
|
|||||||
@@ -27,9 +27,7 @@ async function prepareSymlinkTarget(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (file.type === 'FileRef' || file.type === 'FileBlob') {
|
if (file.type === 'FileRef' || file.type === 'FileBlob') {
|
||||||
const targetPathBufferPromise = await streamToBuffer(
|
const targetPathBufferPromise = streamToBuffer(await file.toStreamAsync());
|
||||||
await file.toStreamAsync()
|
|
||||||
);
|
|
||||||
const [targetPathBuffer] = await Promise.all([
|
const [targetPathBuffer] = await Promise.all([
|
||||||
targetPathBufferPromise,
|
targetPathBufferPromise,
|
||||||
mkdirPromise,
|
mkdirPromise,
|
||||||
@@ -42,9 +40,15 @@ async function prepareSymlinkTarget(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function downloadFile(file: File, fsPath: string): Promise<FileFsRef> {
|
export async function downloadFile(
|
||||||
|
file: File,
|
||||||
|
fsPath: string
|
||||||
|
): Promise<FileFsRef> {
|
||||||
const { mode } = file;
|
const { mode } = file;
|
||||||
|
|
||||||
|
// If the source is a symlink, try to create it instead of copying the file.
|
||||||
|
// Note: creating symlinks on Windows requires admin priviliges or symlinks
|
||||||
|
// enabled in the group policy. We may want to improve the error message.
|
||||||
if (isSymbolicLink(mode)) {
|
if (isSymbolicLink(mode)) {
|
||||||
const target = await prepareSymlinkTarget(file, fsPath);
|
const target = await prepareSymlinkTarget(file, fsPath);
|
||||||
|
|
||||||
@@ -92,12 +96,28 @@ export default async function download(
|
|||||||
await removeFile(basePath, name);
|
await removeFile(basePath, name);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If a file didn't change, do not re-download it.
|
// If a file didn't change, do not re-download it.
|
||||||
if (Array.isArray(filesChanged) && !filesChanged.includes(name)) {
|
if (Array.isArray(filesChanged) && !filesChanged.includes(name)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Some builders resolve symlinks and return both
|
||||||
|
// a file, node_modules/<symlink>/package.json, and
|
||||||
|
// node_modules/<symlink>, a symlink.
|
||||||
|
// Removing the file matches how the yazl lambda zip
|
||||||
|
// behaves so we can use download() with `vercel build`.
|
||||||
|
const parts = name.split('/');
|
||||||
|
for (let i = 1; i < parts.length; i++) {
|
||||||
|
const dir = parts.slice(0, i).join('/');
|
||||||
|
const parent = files[dir];
|
||||||
|
if (parent && isSymbolicLink(parent.mode)) {
|
||||||
|
console.warn(
|
||||||
|
`Warning: file "${name}" is within a symlinked directory "${dir}" and will be ignored`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const file = files[name];
|
const file = files[name];
|
||||||
const fsPath = path.join(basePath, name);
|
const fsPath = path.join(basePath, name);
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ const allOptions = [
|
|||||||
major: 12,
|
major: 12,
|
||||||
range: '12.x',
|
range: '12.x',
|
||||||
runtime: 'nodejs12.x',
|
runtime: 'nodejs12.x',
|
||||||
discontinueDate: new Date('2022-08-09'),
|
discontinueDate: new Date('2022-10-01'),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
major: 10,
|
major: 10,
|
||||||
|
|||||||
32
packages/build-utils/src/get-prefixed-env-vars.ts
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
type Envs = { [key: string]: string | undefined };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the framework-specific prefixed System Environment Variables.
|
||||||
|
* See https://vercel.com/docs/concepts/projects/environment-variables#system-environment-variables
|
||||||
|
* @param envPrefix - Prefix, typically from `@vercel/frameworks`
|
||||||
|
* @param envs - Environment Variables, typically from `process.env`
|
||||||
|
*/
|
||||||
|
export function getPrefixedEnvVars({
|
||||||
|
envPrefix,
|
||||||
|
envs,
|
||||||
|
}: {
|
||||||
|
envPrefix: string | undefined;
|
||||||
|
envs: Envs;
|
||||||
|
}): Envs {
|
||||||
|
const vercelSystemEnvPrefix = 'VERCEL_';
|
||||||
|
const newEnvs: Envs = {};
|
||||||
|
if (envPrefix && envs.VERCEL_URL) {
|
||||||
|
Object.keys(envs)
|
||||||
|
.filter(key => key.startsWith(vercelSystemEnvPrefix))
|
||||||
|
.forEach(key => {
|
||||||
|
const newKey = `${envPrefix}${key}`;
|
||||||
|
if (!(newKey in envs)) {
|
||||||
|
newEnvs[newKey] = envs[key];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
// Tell turbo to exclude all Vercel System Env Vars
|
||||||
|
// See https://github.com/vercel/turborepo/pull/1622
|
||||||
|
newEnvs.TURBO_CI_VENDOR_ENV_KEY = `${envPrefix}${vercelSystemEnvPrefix}`;
|
||||||
|
}
|
||||||
|
return newEnvs;
|
||||||
|
}
|
||||||
@@ -4,7 +4,11 @@ import FileRef from './file-ref';
|
|||||||
import { Lambda, createLambda, getLambdaOptionsFromFunction } from './lambda';
|
import { Lambda, createLambda, getLambdaOptionsFromFunction } from './lambda';
|
||||||
import { NodejsLambda } from './nodejs-lambda';
|
import { NodejsLambda } from './nodejs-lambda';
|
||||||
import { Prerender } from './prerender';
|
import { Prerender } from './prerender';
|
||||||
import download, { DownloadedFiles, isSymbolicLink } from './fs/download';
|
import download, {
|
||||||
|
downloadFile,
|
||||||
|
DownloadedFiles,
|
||||||
|
isSymbolicLink,
|
||||||
|
} from './fs/download';
|
||||||
import getWriteableDirectory from './fs/get-writable-directory';
|
import getWriteableDirectory from './fs/get-writable-directory';
|
||||||
import glob, { GlobOptions } from './fs/glob';
|
import glob, { GlobOptions } from './fs/glob';
|
||||||
import rename from './fs/rename';
|
import rename from './fs/rename';
|
||||||
@@ -36,6 +40,7 @@ import streamToBuffer from './fs/stream-to-buffer';
|
|||||||
import debug from './debug';
|
import debug from './debug';
|
||||||
import getIgnoreFilter from './get-ignore-filter';
|
import getIgnoreFilter from './get-ignore-filter';
|
||||||
import { getPlatformEnv } from './get-platform-env';
|
import { getPlatformEnv } from './get-platform-env';
|
||||||
|
import { getPrefixedEnvVars } from './get-prefixed-env-vars';
|
||||||
|
|
||||||
export {
|
export {
|
||||||
FileBlob,
|
FileBlob,
|
||||||
@@ -46,6 +51,7 @@ export {
|
|||||||
createLambda,
|
createLambda,
|
||||||
Prerender,
|
Prerender,
|
||||||
download,
|
download,
|
||||||
|
downloadFile,
|
||||||
DownloadedFiles,
|
DownloadedFiles,
|
||||||
getWriteableDirectory,
|
getWriteableDirectory,
|
||||||
glob,
|
glob,
|
||||||
@@ -71,6 +77,7 @@ export {
|
|||||||
getDiscontinuedNodeVersions,
|
getDiscontinuedNodeVersions,
|
||||||
getSpawnOptions,
|
getSpawnOptions,
|
||||||
getPlatformEnv,
|
getPlatformEnv,
|
||||||
|
getPrefixedEnvVars,
|
||||||
streamToBuffer,
|
streamToBuffer,
|
||||||
debug,
|
debug,
|
||||||
isSymbolicLink,
|
isSymbolicLink,
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ export interface LambdaOptionsBase {
|
|||||||
allowQuery?: string[];
|
allowQuery?: string[];
|
||||||
regions?: string[];
|
regions?: string[];
|
||||||
supportsMultiPayloads?: boolean;
|
supportsMultiPayloads?: boolean;
|
||||||
|
supportsWrapper?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface LambdaOptionsWithFiles extends LambdaOptionsBase {
|
export interface LambdaOptionsWithFiles extends LambdaOptionsBase {
|
||||||
@@ -58,6 +59,7 @@ export class Lambda {
|
|||||||
*/
|
*/
|
||||||
zipBuffer?: Buffer;
|
zipBuffer?: Buffer;
|
||||||
supportsMultiPayloads?: boolean;
|
supportsMultiPayloads?: boolean;
|
||||||
|
supportsWrapper?: boolean;
|
||||||
|
|
||||||
constructor(opts: LambdaOptions) {
|
constructor(opts: LambdaOptions) {
|
||||||
const {
|
const {
|
||||||
@@ -69,6 +71,7 @@ export class Lambda {
|
|||||||
allowQuery,
|
allowQuery,
|
||||||
regions,
|
regions,
|
||||||
supportsMultiPayloads,
|
supportsMultiPayloads,
|
||||||
|
supportsWrapper,
|
||||||
} = opts;
|
} = opts;
|
||||||
if ('files' in opts) {
|
if ('files' in opts) {
|
||||||
assert(typeof opts.files === 'object', '"files" must be an object');
|
assert(typeof opts.files === 'object', '"files" must be an object');
|
||||||
@@ -103,6 +106,13 @@ export class Lambda {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (supportsWrapper !== undefined) {
|
||||||
|
assert(
|
||||||
|
typeof supportsWrapper === 'boolean',
|
||||||
|
'"supportsWrapper" is not a boolean'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
if (regions !== undefined) {
|
if (regions !== undefined) {
|
||||||
assert(Array.isArray(regions), '"regions" is not an Array');
|
assert(Array.isArray(regions), '"regions" is not an Array');
|
||||||
assert(
|
assert(
|
||||||
@@ -121,6 +131,7 @@ export class Lambda {
|
|||||||
this.regions = regions;
|
this.regions = regions;
|
||||||
this.zipBuffer = 'zipBuffer' in opts ? opts.zipBuffer : undefined;
|
this.zipBuffer = 'zipBuffer' in opts ? opts.zipBuffer : undefined;
|
||||||
this.supportsMultiPayloads = supportsMultiPayloads;
|
this.supportsMultiPayloads = supportsMultiPayloads;
|
||||||
|
this.supportsWrapper = supportsWrapper;
|
||||||
}
|
}
|
||||||
|
|
||||||
async createZip(): Promise<Buffer> {
|
async createZip(): Promise<Buffer> {
|
||||||
|
|||||||
20
packages/build-utils/test/integration.test.ts
vendored
@@ -1,22 +1,12 @@
|
|||||||
import path from 'path';
|
import path from 'path';
|
||||||
import fs from 'fs-extra';
|
import fs from 'fs-extra';
|
||||||
import {
|
import {
|
||||||
packAndDeploy,
|
|
||||||
testDeployment,
|
testDeployment,
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
} from '../../../test/lib/deployment/test-deployment';
|
} from '../../../test/lib/deployment/test-deployment';
|
||||||
|
|
||||||
jest.setTimeout(4 * 60 * 1000);
|
jest.setTimeout(4 * 60 * 1000);
|
||||||
|
|
||||||
const builderUrl = '@canary';
|
|
||||||
let buildUtilsUrl: string;
|
|
||||||
|
|
||||||
beforeAll(async () => {
|
|
||||||
const buildUtilsPath = path.resolve(__dirname, '..');
|
|
||||||
buildUtilsUrl = await packAndDeploy(buildUtilsPath);
|
|
||||||
console.log('buildUtilsUrl', buildUtilsUrl);
|
|
||||||
});
|
|
||||||
|
|
||||||
const fixturesPath = path.resolve(__dirname, 'fixtures');
|
const fixturesPath = path.resolve(__dirname, 'fixtures');
|
||||||
|
|
||||||
// Fixtures that have separate tests and should be skipped in the loop
|
// Fixtures that have separate tests and should be skipped in the loop
|
||||||
@@ -42,10 +32,7 @@ for (const fixture of fs.readdirSync(fixturesPath)) {
|
|||||||
// eslint-disable-next-line no-loop-func
|
// eslint-disable-next-line no-loop-func
|
||||||
it(`Should build "${fixture}"`, async () => {
|
it(`Should build "${fixture}"`, async () => {
|
||||||
await expect(
|
await expect(
|
||||||
testDeployment(
|
testDeployment(path.join(fixturesPath, fixture))
|
||||||
{ builderUrl, buildUtilsUrl },
|
|
||||||
path.join(fixturesPath, fixture)
|
|
||||||
)
|
|
||||||
).resolves.toBeDefined();
|
).resolves.toBeDefined();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -68,10 +55,7 @@ for (const builder of buildersToTestWith) {
|
|||||||
// eslint-disable-next-line no-loop-func
|
// eslint-disable-next-line no-loop-func
|
||||||
it(`Should build "${builder}/${fixture}"`, async () => {
|
it(`Should build "${builder}/${fixture}"`, async () => {
|
||||||
await expect(
|
await expect(
|
||||||
testDeployment(
|
testDeployment(path.join(fixturesPath2, fixture))
|
||||||
{ builderUrl, buildUtilsUrl },
|
|
||||||
path.join(fixturesPath2, fixture)
|
|
||||||
)
|
|
||||||
).resolves.toBeDefined();
|
).resolves.toBeDefined();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
87
packages/build-utils/test/unit.get-prefixed-env-vars.test.ts
vendored
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
import { getPrefixedEnvVars } from '../src';
|
||||||
|
|
||||||
|
describe('Test `getPrefixedEnvVars()`', () => {
|
||||||
|
const cases: Array<{
|
||||||
|
name: string;
|
||||||
|
args: Parameters<typeof getPrefixedEnvVars>[0];
|
||||||
|
want: ReturnType<typeof getPrefixedEnvVars>;
|
||||||
|
}> = [
|
||||||
|
{
|
||||||
|
name: 'should work with NEXT_PUBLIC_',
|
||||||
|
args: {
|
||||||
|
envPrefix: 'NEXT_PUBLIC_',
|
||||||
|
envs: {
|
||||||
|
VERCEL: '1',
|
||||||
|
VERCEL_URL: 'example.vercel.sh',
|
||||||
|
USER_ENV_VAR_NOT_VERCEL: 'example.com',
|
||||||
|
FOO: 'bar',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: {
|
||||||
|
NEXT_PUBLIC_VERCEL_URL: 'example.vercel.sh',
|
||||||
|
TURBO_CI_VENDOR_ENV_KEY: 'NEXT_PUBLIC_VERCEL_',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'should work with GATSBY_',
|
||||||
|
args: {
|
||||||
|
envPrefix: 'GATSBY_',
|
||||||
|
envs: {
|
||||||
|
USER_ENV_VAR_NOT_VERCEL: 'example.com',
|
||||||
|
FOO: 'bar',
|
||||||
|
VERCEL_URL: 'example.vercel.sh',
|
||||||
|
VERCEL_ENV: 'production',
|
||||||
|
VERCEL_REGION: 'iad1',
|
||||||
|
VERCEL_GIT_COMMIT_AUTHOR_LOGIN: 'rauchg',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: {
|
||||||
|
GATSBY_VERCEL_URL: 'example.vercel.sh',
|
||||||
|
GATSBY_VERCEL_ENV: 'production',
|
||||||
|
GATSBY_VERCEL_REGION: 'iad1',
|
||||||
|
GATSBY_VERCEL_GIT_COMMIT_AUTHOR_LOGIN: 'rauchg',
|
||||||
|
TURBO_CI_VENDOR_ENV_KEY: 'GATSBY_VERCEL_',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'should not return anything if no system env vars detected',
|
||||||
|
args: {
|
||||||
|
envPrefix: 'GATSBY_',
|
||||||
|
envs: {
|
||||||
|
USER_ENV_VAR_NOT_VERCEL: 'example.com',
|
||||||
|
FOO: 'bar',
|
||||||
|
BLARG_VERCEL_THING: 'fake',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: {},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'should not return anything if envPrefix is empty string',
|
||||||
|
args: {
|
||||||
|
envPrefix: '',
|
||||||
|
envs: {
|
||||||
|
VERCEL: '1',
|
||||||
|
VERCEL_URL: 'example.vercel.sh',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: {},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'should not return anything if envPrefix is undefined',
|
||||||
|
args: {
|
||||||
|
envPrefix: undefined,
|
||||||
|
envs: {
|
||||||
|
VERCEL: '1',
|
||||||
|
VERCEL_URL: 'example.vercel.sh',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: {},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const { name, args, want } of cases) {
|
||||||
|
it(name, () => {
|
||||||
|
expect(getPrefixedEnvVars(args)).toEqual(want);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
53
packages/build-utils/test/unit.test.ts
vendored
@@ -170,6 +170,53 @@ it('should create zip files with symlinks properly', async () => {
|
|||||||
assert(aStat.isFile());
|
assert(aStat.isFile());
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should download symlinks even with incorrect file', async () => {
|
||||||
|
if (process.platform === 'win32') {
|
||||||
|
console.log('Skipping test on windows');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const files = {
|
||||||
|
'dir/file.txt': new FileBlob({
|
||||||
|
mode: 33188,
|
||||||
|
contentType: undefined,
|
||||||
|
data: 'file text',
|
||||||
|
}),
|
||||||
|
linkdir: new FileBlob({
|
||||||
|
mode: 41453,
|
||||||
|
contentType: undefined,
|
||||||
|
data: 'dir',
|
||||||
|
}),
|
||||||
|
'linkdir/file.txt': new FileBlob({
|
||||||
|
mode: 33188,
|
||||||
|
contentType: undefined,
|
||||||
|
data: 'this file should be discarded',
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
const outDir = path.join(__dirname, 'symlinks-out');
|
||||||
|
await fs.remove(outDir);
|
||||||
|
await fs.mkdirp(outDir);
|
||||||
|
|
||||||
|
await download(files, outDir);
|
||||||
|
|
||||||
|
const [dir, file, linkdir] = await Promise.all([
|
||||||
|
fs.lstat(path.join(outDir, 'dir')),
|
||||||
|
fs.lstat(path.join(outDir, 'dir/file.txt')),
|
||||||
|
fs.lstat(path.join(outDir, 'linkdir')),
|
||||||
|
]);
|
||||||
|
expect(dir.isFile()).toBe(false);
|
||||||
|
expect(dir.isSymbolicLink()).toBe(false);
|
||||||
|
|
||||||
|
expect(file.isFile()).toBe(true);
|
||||||
|
expect(file.isSymbolicLink()).toBe(false);
|
||||||
|
|
||||||
|
expect(linkdir.isSymbolicLink()).toBe(true);
|
||||||
|
|
||||||
|
expect(warningMessages).toEqual([
|
||||||
|
'Warning: file "linkdir/file.txt" is within a symlinked directory "linkdir" and will be ignored',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
it('should only match supported node versions, otherwise throw an error', async () => {
|
it('should only match supported node versions, otherwise throw an error', async () => {
|
||||||
expect(await getSupportedNodeVersion('12.x', false)).toHaveProperty(
|
expect(await getSupportedNodeVersion('12.x', false)).toHaveProperty(
|
||||||
'major',
|
'major',
|
||||||
@@ -347,7 +394,7 @@ it('should get latest node version', async () => {
|
|||||||
it('should throw for discontinued versions', async () => {
|
it('should throw for discontinued versions', async () => {
|
||||||
// Mock a future date so that Node 8 and 10 become discontinued
|
// Mock a future date so that Node 8 and 10 become discontinued
|
||||||
const realDateNow = Date.now.bind(global.Date);
|
const realDateNow = Date.now.bind(global.Date);
|
||||||
global.Date.now = () => new Date('2022-09-01').getTime();
|
global.Date.now = () => new Date('2022-10-15').getTime();
|
||||||
|
|
||||||
expect(getSupportedNodeVersion('8.10.x', false)).rejects.toThrow();
|
expect(getSupportedNodeVersion('8.10.x', false)).rejects.toThrow();
|
||||||
expect(getSupportedNodeVersion('8.10.x', true)).rejects.toThrow();
|
expect(getSupportedNodeVersion('8.10.x', true)).rejects.toThrow();
|
||||||
@@ -389,8 +436,8 @@ it('should warn for deprecated versions, soon to be discontinued', async () => {
|
|||||||
expect(warningMessages).toStrictEqual([
|
expect(warningMessages).toStrictEqual([
|
||||||
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set "engines": { "node": "16.x" } in your `package.json` file to use Node.js 16.',
|
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set "engines": { "node": "16.x" } in your `package.json` file to use Node.js 16.',
|
||||||
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set Node.js Version to 16.x in your Project Settings to use Node.js 16.',
|
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set Node.js Version to 16.x in your Project Settings to use Node.js 16.',
|
||||||
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-08-09 will fail to build. Please set "engines": { "node": "16.x" } in your `package.json` file to use Node.js 16.',
|
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-10-01 will fail to build. Please set "engines": { "node": "16.x" } in your `package.json` file to use Node.js 16.',
|
||||||
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-08-09 will fail to build. Please set Node.js Version to 16.x in your Project Settings to use Node.js 16.',
|
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-10-01 will fail to build. Please set Node.js Version to 16.x in your Project Settings to use Node.js 16.',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
global.Date.now = realDateNow;
|
global.Date.now = realDateNow;
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "vercel",
|
"name": "vercel",
|
||||||
"version": "27.3.0",
|
"version": "27.3.8",
|
||||||
"preferGlobal": true,
|
"preferGlobal": true,
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"description": "The command-line interface for Vercel",
|
"description": "The command-line interface for Vercel",
|
||||||
@@ -16,7 +16,6 @@
|
|||||||
"test-unit": "yarn test test/unit/",
|
"test-unit": "yarn test test/unit/",
|
||||||
"test-integration-cli": "rimraf test/fixtures/integration && ava test/integration.js --serial --fail-fast --verbose",
|
"test-integration-cli": "rimraf test/fixtures/integration && ava test/integration.js --serial --fail-fast --verbose",
|
||||||
"test-integration-dev": "yarn test test/dev/",
|
"test-integration-dev": "yarn test test/dev/",
|
||||||
"prepublishOnly": "yarn build",
|
|
||||||
"coverage": "codecov",
|
"coverage": "codecov",
|
||||||
"build": "ts-node ./scripts/build.ts",
|
"build": "ts-node ./scripts/build.ts",
|
||||||
"dev": "ts-node ./src/index.ts"
|
"dev": "ts-node ./src/index.ts"
|
||||||
@@ -42,16 +41,16 @@
|
|||||||
"node": ">= 14"
|
"node": ">= 14"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@vercel/build-utils": "5.0.5",
|
"@vercel/build-utils": "5.3.0",
|
||||||
"@vercel/go": "2.0.9",
|
"@vercel/go": "2.0.16",
|
||||||
"@vercel/hydrogen": "0.0.6",
|
"@vercel/hydrogen": "0.0.13",
|
||||||
"@vercel/next": "3.1.9",
|
"@vercel/next": "3.1.16",
|
||||||
"@vercel/node": "2.5.0",
|
"@vercel/node": "2.5.7",
|
||||||
"@vercel/python": "3.1.1",
|
"@vercel/python": "3.1.8",
|
||||||
"@vercel/redwood": "1.0.10",
|
"@vercel/redwood": "1.0.17",
|
||||||
"@vercel/remix": "1.0.11",
|
"@vercel/remix": "1.0.18",
|
||||||
"@vercel/ruby": "1.3.17",
|
"@vercel/ruby": "1.3.24",
|
||||||
"@vercel/static-build": "1.0.10",
|
"@vercel/static-build": "1.0.17",
|
||||||
"update-notifier": "5.1.0"
|
"update-notifier": "5.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@@ -97,11 +96,11 @@
|
|||||||
"@types/which": "1.3.2",
|
"@types/which": "1.3.2",
|
||||||
"@types/write-json-file": "2.2.1",
|
"@types/write-json-file": "2.2.1",
|
||||||
"@types/yauzl-promise": "2.1.0",
|
"@types/yauzl-promise": "2.1.0",
|
||||||
"@vercel/client": "12.1.4",
|
"@vercel/client": "12.1.11",
|
||||||
"@vercel/frameworks": "1.1.1",
|
"@vercel/frameworks": "1.1.3",
|
||||||
"@vercel/fs-detectors": "2.0.1",
|
"@vercel/fs-detectors": "2.0.5",
|
||||||
"@vercel/fun": "1.0.4",
|
"@vercel/fun": "1.0.4",
|
||||||
"@vercel/ncc": "0.34.0",
|
"@vercel/ncc": "0.24.0",
|
||||||
"@zeit/source-map-support": "0.6.2",
|
"@zeit/source-map-support": "0.6.2",
|
||||||
"ajv": "6.12.2",
|
"ajv": "6.12.2",
|
||||||
"alpha-sort": "2.0.1",
|
"alpha-sort": "2.0.1",
|
||||||
|
|||||||
@@ -157,7 +157,7 @@ export default async function main(client: Client): Promise<number> {
|
|||||||
client.output.print(
|
client.output.print(
|
||||||
`No Project Settings found locally. Run ${cli.getCommandName(
|
`No Project Settings found locally. Run ${cli.getCommandName(
|
||||||
'pull --yes'
|
'pull --yes'
|
||||||
)} to retreive them.`
|
)} to retrieve them.`
|
||||||
);
|
);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
@@ -469,6 +469,8 @@ async function doBuild(
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
} catch (err: any) {
|
} catch (err: any) {
|
||||||
|
output.prettyError(err);
|
||||||
|
|
||||||
const writeConfigJsonPromise = fs.writeJSON(
|
const writeConfigJsonPromise = fs.writeJSON(
|
||||||
join(outputDir, 'config.json'),
|
join(outputDir, 'config.json'),
|
||||||
{ version: 3 },
|
{ version: 3 },
|
||||||
|
|||||||
@@ -16,26 +16,27 @@ export const help = () => `
|
|||||||
dev Start a local development server
|
dev Start a local development server
|
||||||
env Manages the Environment Variables for your current Project
|
env Manages the Environment Variables for your current Project
|
||||||
git Manage Git provider repository for your current Project
|
git Manage Git provider repository for your current Project
|
||||||
|
help [cmd] Displays complete help for [cmd]
|
||||||
init [example] Initialize an example project
|
init [example] Initialize an example project
|
||||||
ls | list [app] Lists deployments
|
|
||||||
inspect [id] Displays information related to a deployment
|
inspect [id] Displays information related to a deployment
|
||||||
link [path] Link local directory to a Vercel Project
|
link [path] Link local directory to a Vercel Project
|
||||||
|
ls | list [app] Lists deployments
|
||||||
login [email] Logs into your account or creates a new one
|
login [email] Logs into your account or creates a new one
|
||||||
logout Logs out of your account
|
logout Logs out of your account
|
||||||
pull [path] Pull your Project Settings from the cloud
|
pull [path] Pull your Project Settings from the cloud
|
||||||
switch [scope] Switches between teams and your personal account
|
switch [scope] Switches between teams and your personal account
|
||||||
help [cmd] Displays complete help for [cmd]
|
|
||||||
|
|
||||||
${chalk.dim('Advanced')}
|
${chalk.dim('Advanced')}
|
||||||
|
|
||||||
rm | remove [id] Removes a deployment
|
alias [cmd] Manages your domain aliases
|
||||||
bisect Use binary search to find the deployment that introduced a bug
|
bisect Use binary search to find the deployment that introduced a bug
|
||||||
domains [name] Manages your domain names
|
|
||||||
projects Manages your Projects
|
|
||||||
dns [name] Manages your DNS records
|
|
||||||
certs [cmd] Manages your SSL certificates
|
certs [cmd] Manages your SSL certificates
|
||||||
secrets [name] Manages your global Secrets, for use in Environment Variables
|
dns [name] Manages your DNS records
|
||||||
|
domains [name] Manages your domain names
|
||||||
logs [url] Displays the logs for a deployment
|
logs [url] Displays the logs for a deployment
|
||||||
|
projects Manages your Projects
|
||||||
|
rm | remove [id] Removes a deployment
|
||||||
|
secrets [name] Manages your global Secrets, for use in Environment Variables
|
||||||
teams Manages your teams
|
teams Manages your teams
|
||||||
whoami Shows the username of the currently logged in user
|
whoami Shows the username of the currently logged in user
|
||||||
|
|
||||||
|
|||||||
@@ -61,7 +61,6 @@ export default async function dev(
|
|||||||
}
|
}
|
||||||
|
|
||||||
let devCommand: string | undefined;
|
let devCommand: string | undefined;
|
||||||
let frameworkSlug: string | undefined;
|
|
||||||
let projectSettings: ProjectSettings | undefined;
|
let projectSettings: ProjectSettings | undefined;
|
||||||
let projectEnvs: ProjectEnvVariable[] = [];
|
let projectEnvs: ProjectEnvVariable[] = [];
|
||||||
let systemEnvValues: string[] = [];
|
let systemEnvValues: string[] = [];
|
||||||
@@ -77,10 +76,6 @@ export default async function dev(
|
|||||||
const framework = frameworks.find(f => f.slug === project.framework);
|
const framework = frameworks.find(f => f.slug === project.framework);
|
||||||
|
|
||||||
if (framework) {
|
if (framework) {
|
||||||
if (framework.slug) {
|
|
||||||
frameworkSlug = framework.slug;
|
|
||||||
}
|
|
||||||
|
|
||||||
const defaults = framework.settings.devCommand.value;
|
const defaults = framework.settings.devCommand.value;
|
||||||
if (defaults) {
|
if (defaults) {
|
||||||
devCommand = defaults;
|
devCommand = defaults;
|
||||||
@@ -120,7 +115,6 @@ export default async function dev(
|
|||||||
const devServer = new DevServer(cwd, {
|
const devServer = new DevServer(cwd, {
|
||||||
output,
|
output,
|
||||||
devCommand,
|
devCommand,
|
||||||
frameworkSlug,
|
|
||||||
projectSettings,
|
projectSettings,
|
||||||
projectEnvs,
|
projectEnvs,
|
||||||
systemEnvValues,
|
systemEnvValues,
|
||||||
|
|||||||
13
packages/cli/src/commands/env/pull.ts
vendored
@@ -130,6 +130,12 @@ export default async function pull(
|
|||||||
|
|
||||||
await outputFile(fullPath, contents, 'utf8');
|
await outputFile(fullPath, contents, 'utf8');
|
||||||
|
|
||||||
|
if (deltaString) {
|
||||||
|
output.print('\n' + deltaString);
|
||||||
|
} else if (oldEnv && exists) {
|
||||||
|
output.log('No changes found.');
|
||||||
|
}
|
||||||
|
|
||||||
output.print(
|
output.print(
|
||||||
`${prependEmoji(
|
`${prependEmoji(
|
||||||
`${exists ? 'Updated' : 'Created'} ${chalk.bold(
|
`${exists ? 'Updated' : 'Created'} ${chalk.bold(
|
||||||
@@ -139,13 +145,6 @@ export default async function pull(
|
|||||||
)}\n`
|
)}\n`
|
||||||
);
|
);
|
||||||
|
|
||||||
output.print('\n');
|
|
||||||
if (deltaString) {
|
|
||||||
output.print(deltaString);
|
|
||||||
} else if (oldEnv && exists) {
|
|
||||||
output.log('No changes found.');
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ import { Build } from '../types';
|
|||||||
import title from 'title';
|
import title from 'title';
|
||||||
import { isErrnoException } from '../util/is-error';
|
import { isErrnoException } from '../util/is-error';
|
||||||
import { isAPIError } from '../util/errors-ts';
|
import { isAPIError } from '../util/errors-ts';
|
||||||
|
import { URL } from 'url';
|
||||||
|
|
||||||
const help = () => {
|
const help = () => {
|
||||||
console.log(`
|
console.log(`
|
||||||
@@ -66,7 +67,7 @@ export default async function main(client: Client) {
|
|||||||
const { print, log, error } = client.output;
|
const { print, log, error } = client.output;
|
||||||
|
|
||||||
// extract the first parameter
|
// extract the first parameter
|
||||||
const [, deploymentIdOrHost] = argv._;
|
let [, deploymentIdOrHost] = argv._;
|
||||||
|
|
||||||
if (argv._.length !== 2) {
|
if (argv._.length !== 2) {
|
||||||
error(`${getCommandName('inspect <url>')} expects exactly one argument`);
|
error(`${getCommandName('inspect <url>')} expects exactly one argument`);
|
||||||
@@ -90,12 +91,16 @@ export default async function main(client: Client) {
|
|||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
|
|
||||||
// resolve the deployment, since we might have been given an alias
|
|
||||||
const depFetchStart = Date.now();
|
const depFetchStart = Date.now();
|
||||||
|
|
||||||
|
try {
|
||||||
|
deploymentIdOrHost = new URL(deploymentIdOrHost).hostname;
|
||||||
|
} catch {}
|
||||||
client.output.spinner(
|
client.output.spinner(
|
||||||
`Fetching deployment "${deploymentIdOrHost}" in ${chalk.bold(contextName)}`
|
`Fetching deployment "${deploymentIdOrHost}" in ${chalk.bold(contextName)}`
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// resolve the deployment, since we might have been given an alias
|
||||||
try {
|
try {
|
||||||
deployment = await getDeployment(client, deploymentIdOrHost);
|
deployment = await getDeployment(client, deploymentIdOrHost);
|
||||||
} catch (err: unknown) {
|
} catch (err: unknown) {
|
||||||
|
|||||||
@@ -226,7 +226,8 @@ async function run({ output, contextName, currentTeam, client }) {
|
|||||||
|
|
||||||
if (theSecret) {
|
if (theSecret) {
|
||||||
const yes =
|
const yes =
|
||||||
argv.yes || (await readConfirmation(output, theSecret, contextName));
|
argv.yes ||
|
||||||
|
(await readConfirmation(client, output, theSecret, contextName));
|
||||||
if (!yes) {
|
if (!yes) {
|
||||||
output.print(`Aborted. Secret not deleted.\n`);
|
output.print(`Aborted. Secret not deleted.\n`);
|
||||||
return 0;
|
return 0;
|
||||||
@@ -353,7 +354,7 @@ async function run({ output, contextName, currentTeam, client }) {
|
|||||||
return 2;
|
return 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function readConfirmation(output, secret, contextName) {
|
async function readConfirmation(client, output, secret, contextName) {
|
||||||
const time = chalk.gray(`${ms(new Date() - new Date(secret.created))} ago`);
|
const time = chalk.gray(`${ms(new Date() - new Date(secret.created))} ago`);
|
||||||
const tbl = table([[chalk.bold(secret.name), time]], {
|
const tbl = table([[chalk.bold(secret.name), time]], {
|
||||||
align: ['r', 'l'],
|
align: ['r', 'l'],
|
||||||
@@ -367,5 +368,5 @@ async function readConfirmation(output, secret, contextName) {
|
|||||||
);
|
);
|
||||||
output.print(` ${tbl}\n`);
|
output.print(` ${tbl}\n`);
|
||||||
|
|
||||||
return confirm(`${chalk.bold.red('Are you sure?')}`, false);
|
return confirm(client, `${chalk.bold.red('Are you sure?')}`, false);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ try {
|
|||||||
// Test to see if cwd has been deleted before
|
// Test to see if cwd has been deleted before
|
||||||
// importing 3rd party packages that might need cwd.
|
// importing 3rd party packages that might need cwd.
|
||||||
process.cwd();
|
process.cwd();
|
||||||
} catch (err) {
|
} catch (err: unknown) {
|
||||||
if (isError(err) && err.message.includes('uv_cwd')) {
|
if (isError(err) && err.message.includes('uv_cwd')) {
|
||||||
console.error('Error! The current working directory does not exist.');
|
console.error('Error! The current working directory does not exist.');
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
@@ -40,8 +40,8 @@ import getConfig from './util/get-config';
|
|||||||
import * as configFiles from './util/config/files';
|
import * as configFiles from './util/config/files';
|
||||||
import getGlobalPathConfig from './util/config/global-path';
|
import getGlobalPathConfig from './util/config/global-path';
|
||||||
import {
|
import {
|
||||||
getDefaultConfig,
|
defaultAuthConfig,
|
||||||
getDefaultAuthConfig,
|
defaultGlobalConfig,
|
||||||
} from './util/config/get-default';
|
} from './util/config/get-default';
|
||||||
import * as ERRORS from './util/errors-ts';
|
import * as ERRORS from './util/errors-ts';
|
||||||
import { APIError } from './util/errors-ts';
|
import { APIError } from './util/errors-ts';
|
||||||
@@ -50,7 +50,7 @@ import getUpdateCommand from './util/get-update-command';
|
|||||||
import { metrics, shouldCollectMetrics } from './util/metrics';
|
import { metrics, shouldCollectMetrics } from './util/metrics';
|
||||||
import { getCommandName, getTitleName } from './util/pkg-name';
|
import { getCommandName, getTitleName } from './util/pkg-name';
|
||||||
import doLoginPrompt from './util/login/prompt';
|
import doLoginPrompt from './util/login/prompt';
|
||||||
import { GlobalConfig } from './types';
|
import { AuthConfig, GlobalConfig } from './types';
|
||||||
import { VercelConfig } from '@vercel/client';
|
import { VercelConfig } from '@vercel/client';
|
||||||
|
|
||||||
const isCanary = pkg.version.includes('canary');
|
const isCanary = pkg.version.includes('canary');
|
||||||
@@ -208,160 +208,59 @@ const main = async () => {
|
|||||||
VERCEL_DIR
|
VERCEL_DIR
|
||||||
)}" ${errorToString(err)}`
|
)}" ${errorToString(err)}`
|
||||||
);
|
);
|
||||||
}
|
|
||||||
|
|
||||||
let migrated = false;
|
|
||||||
let configExists;
|
|
||||||
|
|
||||||
try {
|
|
||||||
configExists = existsSync(VERCEL_CONFIG_PATH);
|
|
||||||
} catch (err: unknown) {
|
|
||||||
console.error(
|
|
||||||
error(
|
|
||||||
`${
|
|
||||||
'An unexpected error occurred while trying to find the ' +
|
|
||||||
`config file "${hp(VERCEL_CONFIG_PATH)}" `
|
|
||||||
}${errorToString(err)}`
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
let config: GlobalConfig | null = null;
|
|
||||||
|
|
||||||
if (configExists) {
|
|
||||||
try {
|
|
||||||
config = configFiles.readConfigFile();
|
|
||||||
} catch (err) {
|
|
||||||
console.error(
|
|
||||||
error(
|
|
||||||
`${
|
|
||||||
'An unexpected error occurred while trying to read the ' +
|
|
||||||
`config in "${hp(VERCEL_CONFIG_PATH)}" `
|
|
||||||
}${errorToString(err)}`
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
// This is from when Vercel CLI supported
|
let config: GlobalConfig;
|
||||||
// multiple providers. In that case, we really
|
try {
|
||||||
// need to migrate.
|
config = configFiles.readConfigFile();
|
||||||
if (
|
} catch (err: unknown) {
|
||||||
// @ts-ignore
|
if (isErrnoException(err) && err.code === 'ENOENT') {
|
||||||
config.sh ||
|
config = defaultGlobalConfig;
|
||||||
// @ts-ignore
|
|
||||||
config.user ||
|
|
||||||
// @ts-ignore
|
|
||||||
typeof config.user === 'object' ||
|
|
||||||
typeof config.currentTeam === 'object'
|
|
||||||
) {
|
|
||||||
configExists = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!configExists) {
|
|
||||||
const results = await getDefaultConfig(config);
|
|
||||||
|
|
||||||
config = results.config;
|
|
||||||
migrated = results.migrated;
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
configFiles.writeToConfigFile(config);
|
configFiles.writeToConfigFile(config);
|
||||||
} catch (err: unknown) {
|
} catch (err: unknown) {
|
||||||
console.error(
|
output.error(
|
||||||
error(
|
`An unexpected error occurred while trying to save the config to "${hp(
|
||||||
`${
|
VERCEL_CONFIG_PATH
|
||||||
'An unexpected error occurred while trying to write the ' +
|
)}" ${errorToString(err)}`
|
||||||
`default config to "${hp(VERCEL_CONFIG_PATH)}" `
|
);
|
||||||
}${errorToString(err)}`
|
return 1;
|
||||||
)
|
}
|
||||||
|
} else {
|
||||||
|
output.error(
|
||||||
|
`An unexpected error occurred while trying to read the config in "${hp(
|
||||||
|
VERCEL_CONFIG_PATH
|
||||||
|
)}" ${errorToString(err)}`
|
||||||
);
|
);
|
||||||
|
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let authConfigExists;
|
let authConfig: AuthConfig;
|
||||||
|
|
||||||
try {
|
|
||||||
authConfigExists = existsSync(VERCEL_AUTH_CONFIG_PATH);
|
|
||||||
} catch (err: unknown) {
|
|
||||||
console.error(
|
|
||||||
error(
|
|
||||||
`${
|
|
||||||
'An unexpected error occurred while trying to find the ' +
|
|
||||||
`auth file "${hp(VERCEL_AUTH_CONFIG_PATH)}" `
|
|
||||||
}${errorToString(err)}`
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
let authConfig = null;
|
|
||||||
|
|
||||||
const subcommandsWithoutToken = [
|
|
||||||
'login',
|
|
||||||
'logout',
|
|
||||||
'help',
|
|
||||||
'init',
|
|
||||||
'update',
|
|
||||||
'build',
|
|
||||||
];
|
|
||||||
|
|
||||||
if (authConfigExists) {
|
|
||||||
try {
|
try {
|
||||||
authConfig = configFiles.readAuthConfigFile();
|
authConfig = configFiles.readAuthConfigFile();
|
||||||
} catch (err: unknown) {
|
} catch (err: unknown) {
|
||||||
console.error(
|
if (isErrnoException(err) && err.code === 'ENOENT') {
|
||||||
error(
|
authConfig = defaultAuthConfig;
|
||||||
`${
|
|
||||||
'An unexpected error occurred while trying to read the ' +
|
|
||||||
`auth config in "${hp(VERCEL_AUTH_CONFIG_PATH)}" `
|
|
||||||
}${errorToString(err)}`
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// This is from when Vercel CLI supported
|
|
||||||
// multiple providers. In that case, we really
|
|
||||||
// need to migrate.
|
|
||||||
// @ts-ignore
|
|
||||||
if (authConfig.credentials) {
|
|
||||||
authConfigExists = false;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
const results = await getDefaultAuthConfig(authConfig);
|
|
||||||
|
|
||||||
authConfig = results.config;
|
|
||||||
migrated = results.migrated;
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
configFiles.writeToAuthConfigFile(authConfig);
|
configFiles.writeToAuthConfigFile(authConfig);
|
||||||
} catch (err: unknown) {
|
} catch (err: unknown) {
|
||||||
console.error(
|
output.error(
|
||||||
error(
|
`An unexpected error occurred while trying to write the auth config to "${hp(
|
||||||
`${
|
VERCEL_AUTH_CONFIG_PATH
|
||||||
'An unexpected error occurred while trying to write the ' +
|
)}" ${errorToString(err)}`
|
||||||
`default config to "${hp(VERCEL_AUTH_CONFIG_PATH)}" `
|
|
||||||
}${errorToString(err)}`
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
}
|
} else {
|
||||||
|
output.error(
|
||||||
// Let the user know we migrated the config
|
`An unexpected error occurred while trying to read the auth config in "${hp(
|
||||||
if (migrated) {
|
VERCEL_AUTH_CONFIG_PATH
|
||||||
const directory = param(hp(VERCEL_DIR));
|
)}" ${errorToString(err)}`
|
||||||
debug(
|
|
||||||
`The credentials and configuration within the ${directory} directory were upgraded`
|
|
||||||
);
|
);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (typeof argv['--api'] === 'string') {
|
if (typeof argv['--api'] === 'string') {
|
||||||
@@ -371,18 +270,12 @@ const main = async () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// eslint-disable-next-line no-new
|
|
||||||
new URL(apiUrl);
|
new URL(apiUrl);
|
||||||
} catch (err) {
|
} catch (err: unknown) {
|
||||||
output.error(`Please provide a valid URL instead of ${highlight(apiUrl)}.`);
|
output.error(`Please provide a valid URL instead of ${highlight(apiUrl)}.`);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!config) {
|
|
||||||
output.error(`Vercel global config was not loaded.`);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Shared API `Client` instance for all sub-commands to utilize
|
// Shared API `Client` instance for all sub-commands to utilize
|
||||||
client = new Client({
|
client = new Client({
|
||||||
apiUrl,
|
apiUrl,
|
||||||
@@ -430,6 +323,15 @@ const main = async () => {
|
|||||||
client.argv.push('-h');
|
client.argv.push('-h');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const subcommandsWithoutToken = [
|
||||||
|
'login',
|
||||||
|
'logout',
|
||||||
|
'help',
|
||||||
|
'init',
|
||||||
|
'update',
|
||||||
|
'build',
|
||||||
|
];
|
||||||
|
|
||||||
// Prompt for login if there is no current token
|
// Prompt for login if there is no current token
|
||||||
if (
|
if (
|
||||||
(!authConfig || !authConfig.token) &&
|
(!authConfig || !authConfig.token) &&
|
||||||
|
|||||||
@@ -20,13 +20,15 @@ export interface JSONObject {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface AuthConfig {
|
export interface AuthConfig {
|
||||||
_?: string;
|
'// Note'?: string;
|
||||||
|
'// Docs'?: string;
|
||||||
token?: string;
|
token?: string;
|
||||||
skipWrite?: boolean;
|
skipWrite?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface GlobalConfig {
|
export interface GlobalConfig {
|
||||||
_?: string;
|
'// Note'?: string;
|
||||||
|
'// Docs'?: string;
|
||||||
currentTeam?: string;
|
currentTeam?: string;
|
||||||
includeScheme?: string;
|
includeScheme?: string;
|
||||||
collectMetrics?: boolean;
|
collectMetrics?: boolean;
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ export async function resolveBuilders(
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (name === '@vercel/static') {
|
if (name === '@vercel/static' || name === '@now/static') {
|
||||||
// `@vercel/static` is a special-case built-in builder
|
// `@vercel/static` is a special-case built-in builder
|
||||||
builders.set(name, {
|
builders.set(name, {
|
||||||
builder: staticBuilder,
|
builder: staticBuilder,
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ import {
|
|||||||
PackageJson,
|
PackageJson,
|
||||||
Prerender,
|
Prerender,
|
||||||
download,
|
download,
|
||||||
|
downloadFile,
|
||||||
EdgeFunction,
|
EdgeFunction,
|
||||||
BuildResultBuildOutput,
|
BuildResultBuildOutput,
|
||||||
getLambdaOptionsFromFunction,
|
getLambdaOptionsFromFunction,
|
||||||
@@ -266,9 +267,7 @@ async function writeStaticFile(
|
|||||||
const dest = join(outputDir, 'static', fsPath);
|
const dest = join(outputDir, 'static', fsPath);
|
||||||
await fs.mkdirp(dirname(dest));
|
await fs.mkdirp(dirname(dest));
|
||||||
|
|
||||||
// TODO: handle (or skip) symlinks?
|
await downloadFile(file, dest);
|
||||||
const stream = file.toStream();
|
|
||||||
await pipe(stream, fs.createWriteStream(dest, { mode: file.mode }));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,75 +1,15 @@
|
|||||||
import { AuthConfig, GlobalConfig } from '../../types';
|
import { AuthConfig, GlobalConfig } from '../../types';
|
||||||
|
|
||||||
export const getDefaultConfig = async (existingCopy?: GlobalConfig | null) => {
|
export const defaultGlobalConfig: GlobalConfig = {
|
||||||
let migrated = false;
|
'// Note':
|
||||||
|
'This is your Vercel config file. For more information see the global configuration documentation.',
|
||||||
const config: GlobalConfig = {
|
'// Docs':
|
||||||
_: 'This is your Vercel config file. For more information see the global configuration documentation: https://vercel.com/docs/configuration#global',
|
'https://vercel.com/docs/project-configuration#global-configuration/config-json',
|
||||||
collectMetrics: true,
|
collectMetrics: true,
|
||||||
};
|
|
||||||
|
|
||||||
if (existingCopy) {
|
|
||||||
const keep = [
|
|
||||||
'_',
|
|
||||||
'currentTeam',
|
|
||||||
'desktop',
|
|
||||||
'updateChannel',
|
|
||||||
'collectMetrics',
|
|
||||||
'api',
|
|
||||||
// This is deleted later in the code
|
|
||||||
];
|
|
||||||
|
|
||||||
try {
|
|
||||||
const existing = Object.assign({}, existingCopy);
|
|
||||||
// @ts-ignore
|
|
||||||
const sh = Object.assign({}, existing.sh || {});
|
|
||||||
|
|
||||||
Object.assign(config, existing, sh);
|
|
||||||
|
|
||||||
for (const key of Object.keys(config)) {
|
|
||||||
if (!keep.includes(key)) {
|
|
||||||
// @ts-ignore
|
|
||||||
delete config[key];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof config.currentTeam === 'object') {
|
|
||||||
// @ts-ignore
|
|
||||||
config.currentTeam = config.currentTeam.id;
|
|
||||||
}
|
|
||||||
|
|
||||||
// @ts-ignore
|
|
||||||
if (typeof config.user === 'object') {
|
|
||||||
// @ts-ignore
|
|
||||||
config.user = config.user.uid || config.user.id;
|
|
||||||
}
|
|
||||||
|
|
||||||
migrated = true;
|
|
||||||
} catch (err) {}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { config, migrated };
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getDefaultAuthConfig = async (existing?: AuthConfig | null) => {
|
export const defaultAuthConfig: AuthConfig = {
|
||||||
let migrated = false;
|
'// Note': 'This is your Vercel credentials file. DO NOT SHARE!',
|
||||||
|
'// Docs':
|
||||||
const config: AuthConfig = {
|
'https://vercel.com/docs/project-configuration#global-configuration/auth-json',
|
||||||
_: 'This is your Vercel credentials file. DO NOT SHARE! More: https://vercel.com/docs/configuration#global',
|
|
||||||
};
|
|
||||||
|
|
||||||
if (existing) {
|
|
||||||
try {
|
|
||||||
// @ts-ignore
|
|
||||||
const sh = existing.credentials.find(item => item.provider === 'sh');
|
|
||||||
|
|
||||||
if (sh) {
|
|
||||||
config.token = sh.token;
|
|
||||||
}
|
|
||||||
|
|
||||||
migrated = true;
|
|
||||||
} catch (err) {}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { config, migrated };
|
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -131,7 +131,6 @@ export default class DevServer {
|
|||||||
public output: Output;
|
public output: Output;
|
||||||
public proxy: httpProxy;
|
public proxy: httpProxy;
|
||||||
public envConfigs: EnvConfigs;
|
public envConfigs: EnvConfigs;
|
||||||
public frameworkSlug?: string;
|
|
||||||
public files: BuilderInputs;
|
public files: BuilderInputs;
|
||||||
public address: string;
|
public address: string;
|
||||||
public devCacheDir: string;
|
public devCacheDir: string;
|
||||||
@@ -175,7 +174,6 @@ export default class DevServer {
|
|||||||
this.address = '';
|
this.address = '';
|
||||||
this.devCommand = options.devCommand;
|
this.devCommand = options.devCommand;
|
||||||
this.projectSettings = options.projectSettings;
|
this.projectSettings = options.projectSettings;
|
||||||
this.frameworkSlug = options.frameworkSlug;
|
|
||||||
this.caseSensitive = false;
|
this.caseSensitive = false;
|
||||||
this.apiDir = null;
|
this.apiDir = null;
|
||||||
this.apiExtensions = new Set();
|
this.apiExtensions = new Set();
|
||||||
@@ -1556,6 +1554,8 @@ export default class DevServer {
|
|||||||
(err as any).link = 'https://vercel.link/command-not-found';
|
(err as any).link = 'https://vercel.link/command-not-found';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.output.prettyError(err);
|
||||||
|
|
||||||
await this.sendError(
|
await this.sendError(
|
||||||
req,
|
req,
|
||||||
res,
|
res,
|
||||||
@@ -2208,7 +2208,10 @@ export default class DevServer {
|
|||||||
// Because of child process 'pipe' below, isTTY will be false.
|
// Because of child process 'pipe' below, isTTY will be false.
|
||||||
// Most frameworks use `chalk`/`supports-color` so we enable it anyway.
|
// Most frameworks use `chalk`/`supports-color` so we enable it anyway.
|
||||||
FORCE_COLOR: process.stdout.isTTY ? '1' : '0',
|
FORCE_COLOR: process.stdout.isTTY ? '1' : '0',
|
||||||
...(this.frameworkSlug === 'create-react-app' ? { BROWSER: 'none' } : {}),
|
// Prevent framework dev servers from automatically opening a web
|
||||||
|
// browser window, since it will not be the port that `vc dev`
|
||||||
|
// is listening on and thus will be missing Vercel features.
|
||||||
|
BROWSER: 'none',
|
||||||
...process.env,
|
...process.env,
|
||||||
...this.envConfigs.allEnv,
|
...this.envConfigs.allEnv,
|
||||||
PORT: `${port}`,
|
PORT: `${port}`,
|
||||||
|
|||||||
@@ -24,7 +24,6 @@ export { VercelConfig };
|
|||||||
export interface DevServerOptions {
|
export interface DevServerOptions {
|
||||||
output: Output;
|
output: Output;
|
||||||
devCommand?: string;
|
devCommand?: string;
|
||||||
frameworkSlug?: string;
|
|
||||||
projectSettings?: ProjectSettings;
|
projectSettings?: ProjectSettings;
|
||||||
systemEnvValues?: string[];
|
systemEnvValues?: string[];
|
||||||
projectEnvs?: ProjectEnvVariable[];
|
projectEnvs?: ProjectEnvVariable[];
|
||||||
|
|||||||
15
packages/cli/src/util/env/diff-env-files.ts
vendored
@@ -63,18 +63,25 @@ export function buildDeltaString(
|
|||||||
const { added, changed, removed } = findChanges(oldEnv, newEnv);
|
const { added, changed, removed } = findChanges(oldEnv, newEnv);
|
||||||
|
|
||||||
let deltaString = '';
|
let deltaString = '';
|
||||||
|
deltaString += chalk.green(addDeltaSection('+', changed, true));
|
||||||
deltaString += chalk.green(addDeltaSection('+', added));
|
deltaString += chalk.green(addDeltaSection('+', added));
|
||||||
deltaString += chalk.yellow(addDeltaSection('~', changed));
|
|
||||||
deltaString += chalk.red(addDeltaSection('-', removed));
|
deltaString += chalk.red(addDeltaSection('-', removed));
|
||||||
|
|
||||||
return deltaString ? chalk.gray('Changes:\n') + deltaString : deltaString;
|
return deltaString
|
||||||
|
? chalk.gray('Changes:\n') + deltaString + '\n'
|
||||||
|
: deltaString;
|
||||||
}
|
}
|
||||||
|
|
||||||
function addDeltaSection(prefix: string, arr: string[]): string {
|
function addDeltaSection(
|
||||||
|
prefix: string,
|
||||||
|
arr: string[],
|
||||||
|
changed: boolean = false
|
||||||
|
): string {
|
||||||
|
if (arr.length === 0) return '';
|
||||||
return (
|
return (
|
||||||
arr
|
arr
|
||||||
.sort()
|
.sort()
|
||||||
.map(item => `${prefix} ${item}`)
|
.map(item => `${prefix} ${item}${changed ? ' (Updated)' : ''}`)
|
||||||
.join('\n') + '\n'
|
.join('\n') + '\n'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import decamelize from 'decamelize';
|
import { snakeCase } from 'snake-case';
|
||||||
import { upper } from '../lib/upper';
|
import { upper } from '../lib/upper';
|
||||||
|
|
||||||
export const config = {
|
export const config = {
|
||||||
@@ -14,8 +14,8 @@ export default async function edge(request, event) {
|
|||||||
url: request.url,
|
url: request.url,
|
||||||
method: request.method,
|
method: request.method,
|
||||||
body: requestBody,
|
body: requestBody,
|
||||||
decamelized: decamelize('someCamelCaseThing'),
|
snakeCase: snakeCase('someCamelCaseThing'),
|
||||||
uppercase: upper('someThing'),
|
upperCase: upper('someThing'),
|
||||||
optionalChaining: request?.doesnotexist ?? 'fallback',
|
optionalChaining: request?.doesnotexist ?? 'fallback',
|
||||||
ENV_VAR_IN_EDGE: process.env.ENV_VAR_IN_EDGE,
|
ENV_VAR_IN_EDGE: process.env.ENV_VAR_IN_EDGE,
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"private": true,
|
"private": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"decamelize": "6.0.0"
|
"snake-case": "3.0.4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,38 @@
|
|||||||
# yarn lockfile v1
|
# yarn lockfile v1
|
||||||
|
|
||||||
|
|
||||||
decamelize@6.0.0:
|
dot-case@^3.0.4:
|
||||||
version "6.0.0"
|
version "3.0.4"
|
||||||
resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-6.0.0.tgz#8cad4d916fde5c41a264a43d0ecc56fe3d31749e"
|
resolved "https://registry.yarnpkg.com/dot-case/-/dot-case-3.0.4.tgz#9b2b670d00a431667a8a75ba29cd1b98809ce751"
|
||||||
integrity sha512-Fv96DCsdOgB6mdGl67MT5JaTNKRzrzill5OH5s8bjYJXVlcXyPYGyPsUkWyGV5p1TXI5esYIYMMeDJL0hEIwaA==
|
integrity sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==
|
||||||
|
dependencies:
|
||||||
|
no-case "^3.0.4"
|
||||||
|
tslib "^2.0.3"
|
||||||
|
|
||||||
|
lower-case@^2.0.2:
|
||||||
|
version "2.0.2"
|
||||||
|
resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-2.0.2.tgz#6fa237c63dbdc4a82ca0fd882e4722dc5e634e28"
|
||||||
|
integrity sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==
|
||||||
|
dependencies:
|
||||||
|
tslib "^2.0.3"
|
||||||
|
|
||||||
|
no-case@^3.0.4:
|
||||||
|
version "3.0.4"
|
||||||
|
resolved "https://registry.yarnpkg.com/no-case/-/no-case-3.0.4.tgz#d361fd5c9800f558551a8369fc0dcd4662b6124d"
|
||||||
|
integrity sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==
|
||||||
|
dependencies:
|
||||||
|
lower-case "^2.0.2"
|
||||||
|
tslib "^2.0.3"
|
||||||
|
|
||||||
|
snake-case@3.0.4:
|
||||||
|
version "3.0.4"
|
||||||
|
resolved "https://registry.yarnpkg.com/snake-case/-/snake-case-3.0.4.tgz#4f2bbd568e9935abdfd593f34c691dadb49c452c"
|
||||||
|
integrity sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==
|
||||||
|
dependencies:
|
||||||
|
dot-case "^3.0.4"
|
||||||
|
tslib "^2.0.3"
|
||||||
|
|
||||||
|
tslib@^2.0.3:
|
||||||
|
version "2.4.0"
|
||||||
|
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.0.tgz#7cecaa7f073ce680a05847aa77be941098f36dc3"
|
||||||
|
integrity sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==
|
||||||
|
|||||||
@@ -5,6 +5,6 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
)
|
)
|
||||||
|
|
||||||
func Another(w http.ResponseWriter, r *http.Request) {
|
func HandlerAnother(w http.ResponseWriter, r *http.Request) {
|
||||||
fmt.Fprintf(w, "This is another page")
|
fmt.Fprintf(w, "This is another page")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
export const config = {
|
||||||
|
matcher: 'not-a-valid-matcher',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function middleware(request, _event) {
|
||||||
|
return new Response(null);
|
||||||
|
}
|
||||||
@@ -43,8 +43,8 @@ test('[vercel dev] should support edge functions', async () => {
|
|||||||
url: `http://localhost:${port}/api/edge-success`,
|
url: `http://localhost:${port}/api/edge-success`,
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
body: '{"hello":"world"}',
|
body: '{"hello":"world"}',
|
||||||
decamelized: 'some_camel_case_thing',
|
snakeCase: 'some_camel_case_thing',
|
||||||
uppercase: 'SOMETHING',
|
upperCase: 'SOMETHING',
|
||||||
optionalChaining: 'fallback',
|
optionalChaining: 'fallback',
|
||||||
ENV_VAR_IN_EDGE: '1',
|
ENV_VAR_IN_EDGE: '1',
|
||||||
});
|
});
|
||||||
@@ -227,7 +227,7 @@ test('[vercel dev] should handle syntax errors thrown in edge functions', async
|
|||||||
expect(await res.text()).toMatch(
|
expect(await res.text()).toMatch(
|
||||||
/<strong>500<\/strong>: INTERNAL_SERVER_ERROR/g
|
/<strong>500<\/strong>: INTERNAL_SERVER_ERROR/g
|
||||||
);
|
);
|
||||||
expect(stderr).toMatch(/Failed to instantiate edge runtime./g);
|
expect(stderr).toMatch(/Failed to compile user code for edge runtime./g);
|
||||||
expect(stderr).toMatch(/Unexpected end of file/g);
|
expect(stderr).toMatch(/Unexpected end of file/g);
|
||||||
expect(stderr).toMatch(
|
expect(stderr).toMatch(
|
||||||
/Failed to complete request to \/api\/edge-error-syntax: Error: socket hang up/g
|
/Failed to complete request to \/api\/edge-error-syntax: Error: socket hang up/g
|
||||||
@@ -307,6 +307,35 @@ test('[vercel dev] should handle missing handler errors thrown in edge functions
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('[vercel dev] should handle invalid middleware config', async () => {
|
||||||
|
const dir = fixture('middleware-matchers-invalid');
|
||||||
|
const { dev, port, readyResolver } = await testFixture(dir);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await readyResolver;
|
||||||
|
|
||||||
|
let res = await fetch(`http://localhost:${port}/api/whatever`, {
|
||||||
|
method: 'GET',
|
||||||
|
headers: {
|
||||||
|
Accept:
|
||||||
|
'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
validateResponseHeaders(res);
|
||||||
|
|
||||||
|
const { stderr } = await dev.kill('SIGTERM');
|
||||||
|
|
||||||
|
expect(await res.text()).toMatch(
|
||||||
|
/<strong>500<\/strong>: INTERNAL_SERVER_ERROR/g
|
||||||
|
);
|
||||||
|
expect(stderr).toMatch(
|
||||||
|
/Middleware's `config.matcher` .+ Received: not-a-valid-matcher/g
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await dev.kill('SIGTERM');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
test('[vercel dev] should support request body', async () => {
|
test('[vercel dev] should support request body', async () => {
|
||||||
const dir = fixture('node-request-body');
|
const dir = fixture('node-request-body');
|
||||||
const { dev, port, readyResolver } = await testFixture(dir);
|
const { dev, port, readyResolver } = await testFixture(dir);
|
||||||
|
|||||||
@@ -347,6 +347,12 @@ function testFixtureStdio(
|
|||||||
? ['--scope', process.env.VERCEL_TEAM_ID]
|
? ['--scope', process.env.VERCEL_TEAM_ID]
|
||||||
: []),
|
: []),
|
||||||
'deploy',
|
'deploy',
|
||||||
|
...(process.env.VERCEL_CLI_VERSION
|
||||||
|
? [
|
||||||
|
'--build-env',
|
||||||
|
`VERCEL_CLI_VERSION=${process.env.VERCEL_CLI_VERSION}`,
|
||||||
|
]
|
||||||
|
: []),
|
||||||
'--public',
|
'--public',
|
||||||
'--debug',
|
'--debug',
|
||||||
],
|
],
|
||||||
@@ -427,7 +433,7 @@ function testFixtureStdio(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stderr.includes('Command failed') || stderr.includes('Error!')) {
|
if (stderr.includes('Command failed')) {
|
||||||
dev.kill('SIGTERM');
|
dev.kill('SIGTERM');
|
||||||
throw new Error(`Failed for "${directory}" with stderr "${stderr}".`);
|
throw new Error(`Failed for "${directory}" with stderr "${stderr}".`);
|
||||||
}
|
}
|
||||||
|
|||||||
7
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/.vercel/project.json
vendored
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"orgId": ".",
|
||||||
|
"projectId": ".",
|
||||||
|
"settings": {
|
||||||
|
"framework": null
|
||||||
|
}
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/prefer-browser.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/prefer-browser';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "prefer-browser": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/prefer-main.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/prefer-main';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "prefer-main": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/prefer-module.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/prefer-module';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "prefer-module": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/use-browser.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/only-browser';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "use-browser": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/use-classic.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/only-classic';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "use-classic": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/use-main.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/only-main';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "use-main": ' + describeYourself());
|
||||||
|
}
|
||||||
9
packages/cli/test/fixtures/unit/commands/build/import-from-main-keys/api/use-module.js
vendored
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import describeYourself from '../packages/only-module';
|
||||||
|
|
||||||
|
export const config = {
|
||||||
|
runtime: 'experimental-edge',
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return new Response('response from "use-module": ' + describeYourself());
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'only-browser';
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"name": "only-browser",
|
||||||
|
"private": true,
|
||||||
|
"browser": "dist-browser.js"
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'only-classic';
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"name": "only-classic",
|
||||||
|
"private": true
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'only-main';
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"name": "only-main",
|
||||||
|
"private": true,
|
||||||
|
"main": "dist-main.js"
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'only-module';
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"name": "only-module",
|
||||||
|
"private": true,
|
||||||
|
"module": "dist-module.js"
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'browser';
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'main';
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export default function () {
|
||||||
|
return 'module';
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
// Should not be included in the output
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
return 'classic';
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"name": "only-module",
|
||||||
|
"private": true,
|
||||||
|
"main": "dist-main.js",
|
||||||
|
"module": "dist-module.js",
|
||||||
|
"browser": "dist-browser.js"
|
||||||
|
}
|
||||||