Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: vite only replace __dirname, __filename, import.meta.url in cjs #7161

Merged
merged 4 commits into from Mar 19, 2022
Merged

docs: vite only replace __dirname, __filename, import.meta.url in cjs #7161

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be07244
docs: vite only replace __dirname, __filename, import.meta.url in cjs
ydcjeff Mar 3, 2022
a47ac01
docs: config replacement happen on TS config file
ydcjeff Mar 5, 2022
3c6a763
chore: apply suggestions from code review
ydcjeff Mar 5, 2022
4e55247
Update docs/config/index.md
ydcjeff Mar 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/config/index.md
View file
Open in desktop
Expand Up @@ -27,14 +27,17 @@ You can also explicitly specify a config file to use with the `--config` CLI opt
vite --config my-config.js
```

Note that Vite will replace `__filename`, `__dirname`, and `import.meta.url`. Using these as variable names will result in an error:
::: tip NOTE
Vite will replace `__filename`, `__dirname`, and `import.meta.url` in **CommonJS** and **TypeScript** config files. Using these as variable names will result in an error:

```js
const __filename = "value"
// will be transformed to
const "path/vite.config.js" = "value"
```

:::

### Config Intellisense

Since Vite ships with TypeScript typings, you can leverage your IDE's intellisense with jsdoc type hints:
Expand Down