mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-22 13:45:18 +00:00
chore(docs): setup case-police guard (#4065)
* chore: setup `case-police` guard * chore: fix cases * chore: upgrade deps
This commit is contained in:
Anthony Fu
GitHub
parent
a1cbbb71a8
commit
6577602894
@ -12,7 +12,7 @@ Learn more in [Introduction](/getting-started/introduction).
|
||||
You can start playing with Nuxt 3 in your browser using our online sandboxes:
|
||||
|
||||
:button-link[Play on StackBlitz]{href="https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz" blank}
|
||||
:button-link[Play on CodeSandBox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox" blank}
|
||||
:button-link[Play on CodeSandbox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox" blank}
|
||||
|
||||
## New project
|
||||
|
||||
|
||||
@ -255,10 +255,10 @@ export default defineNuxtConfig({
|
||||
// Disable nuxt 3 compatible `nuxtApp` interface
|
||||
// app: false,
|
||||
|
||||
// Disable composition API support
|
||||
// Disable Composition API support
|
||||
// capi: false,
|
||||
|
||||
// ... or just disable legacy composition API support
|
||||
// ... or just disable legacy Composition API support
|
||||
// capi: {
|
||||
// legacy: false
|
||||
// },
|
||||
|
||||
@ -30,7 +30,7 @@ Most applications need multiple pages and a way to navigate between them. This i
|
||||
### Example
|
||||
|
||||
:button-link[Open on StackBlitz]{href="https://stackblitz.com/edit/github-9hzuns?file=app.vue" blank}
|
||||
:button-link[Open on CodeSandBox]{href="https://codesandbox.io/s/nuxt-3-components-auto-import-2xq9z?file=/app.vue" blank}
|
||||
:button-link[Open on CodeSandbox]{href="https://codesandbox.io/s/nuxt-3-components-auto-import-2xq9z?file=/app.vue" blank}
|
||||
|
||||
The `app.vue` file is the entrypoint, which represents the page displayed in the browser window.
|
||||
|
||||
@ -98,7 +98,7 @@ Used with the `setup` keyword in the `<script>` definition, here is the above co
|
||||
</script>
|
||||
```
|
||||
|
||||
The goal of Nuxt 3 is to provide a great developer experience around the composition API.
|
||||
The goal of Nuxt 3 is to provide a great developer experience around the Composition API.
|
||||
|
||||
- Use auto-imported [Reactivity functions](https://vuejs.org/api/reactivity-core.html) from Vue and Nuxt 3 [built-in composables](/docs/usage/data-fetching).
|
||||
- Write your own auto-imported reusable functions in the `composables/` directory.
|
||||
|
||||
@ -33,6 +33,8 @@ Because these component names match native HTML elements, it is very important t
|
||||
|
||||
For example:
|
||||
|
||||
<!-- @case-police-ignore html -->
|
||||
|
||||
```html{}[app.vue]
|
||||
<template>
|
||||
<div>
|
||||
|
||||
@ -12,7 +12,7 @@ Nuxt 3 is a complete rewrite of Nuxt 2, and also based on a new set of underlyin
|
||||
|
||||
Some of these significant changes include:
|
||||
|
||||
1. Moving from Vue 2 to Vue 3, including defaulting to the composition API and script setup.
|
||||
1. Moving from Vue 2 to Vue 3, including defaulting to the Composition API and script setup.
|
||||
1. Moving from webpack 4 and Babel to Vite or webpack 5 and esbuild.
|
||||
1. Moving from a runtime Nuxt dependency to a minimal, standalone server compiled with nitropack.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ Nuxt 3 plugins are **not** fully backward compatible with Nuxt 2.
|
||||
|
||||
### Vue Compatibility
|
||||
|
||||
Plugins or components using the composition API need exclusive Vue 2 or Vue 3 support.
|
||||
Plugins or components using the Composition API need exclusive Vue 2 or Vue 3 support.
|
||||
|
||||
By using [vue-demi](https://github.com/vueuse/vue-demi) they should be compatible with both Nuxt 2 and 3.
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ vercel
|
||||
|
||||
## Git
|
||||
|
||||
1. Push your code to your git repository (GitHub, GitLab, BitBucket).
|
||||
1. Push your code to your git repository (GitHub, GitLab, Bitbucket).
|
||||
2. [Import your project](https://vercel.com/new) into Vercel.
|
||||
3. Vercel will detect that you are using Nuxt and will enable the correct settings for your deployment.
|
||||
4. Your application is deployed! (e.g. [nuxt.vercel.app](https://nuxt.vercel.app/))
|
||||
|
||||
@ -25,11 +25,11 @@ If your issue concerns Vue 3 or Vite, please try to reproduce it first with the
|
||||
**Nuxt 3**:
|
||||
|
||||
:button-link[Nuxt 3 on StackBlitz]{href="https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz" blank}
|
||||
:button-link[Nuxt 3 on CodeSandBox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox" blank}
|
||||
:button-link[Nuxt 3 on CodeSandbox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox" blank}
|
||||
|
||||
**Nuxt Bridge**:
|
||||
|
||||
:button-link[Nuxt Bridge on CodeSandBox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v2-bridge-codesandbox" blank}
|
||||
:button-link[Nuxt Bridge on CodeSandbox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v2-bridge-codesandbox" blank}
|
||||
|
||||
**Vue 3**:
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Test Utils | Q1 2022 | [nuxt/framework#3198](https://github.com/nuxt/framework
|
||||
Nuxt 3 RC | Q1 2022 | [nuxt/framework#3447](https://github.com/nuxt/framework/discussions/3447) | Nuxt v3 first release candidate
|
||||
Extending | Q1 2022 | [nuxt/framework#3222](https://github.com/nuxt/framework/issues/3222) | Native extending and theme support
|
||||
Content v2 | Q1 2022 | - | A rewrite of [nuxt/content](https://github.com/nuxt/content) for Nuxt 3 support
|
||||
Devtools | Q2 2022 | - | An integrated devtools experience for Nuxt
|
||||
DevTools | Q2 2022 | - | An integrated devtools experience for Nuxt
|
||||
Auth | Q2 2022 | - | A rewrite of [nuxt-community/auth-module](https://github.com/nuxt-community/auth-module) for Nuxt 3 support
|
||||
SEO & PWA | Q2 2022 | [nuxt/framework#1823](https://github.com/nuxt/framework/discussions/1823) | Migrating from [nuxt-community/pwa-module](https://github.com/nuxt-community/pwa-module) for built-in SEO utils and service worker support
|
||||
Translations | Q2/Q3 2022 | [nuxt/translations#4](https://github.com/nuxt/translations/discussions/4) (private) | A collaborative project for a stable translation process for Nuxt 3 docs. Currently pending for ideas and documentation tooling support (content v2 with remote sources).
|
||||
|
||||
@ -87,7 +87,7 @@ Nuxt 3 has been re-architected with a smaller core and optimized for faster perf
|
||||
::section-content-item
|
||||
---
|
||||
soon: true
|
||||
title: Nuxt Devtools
|
||||
title: Nuxt DevTools
|
||||
description: 'Work faster with info and quick fixes right in the browser.'
|
||||
image: IconDevtools
|
||||
imageClass: w-10 h-10
|
||||
@ -180,7 +180,7 @@ Nuxt 3 has been re-architected with a smaller core and optimized for faster perf
|
||||
::list{.mb-8}
|
||||
- Using [Nitro server](/concepts/server-engine) with Nuxt 2
|
||||
- Using Composition API (same as Nuxt 3) with Nuxt 2
|
||||
- Using new CLI and Devtools with Nuxt 2
|
||||
- Using new CLI and DevTools with Nuxt 2
|
||||
- Progressively upgrade to Nuxt 3
|
||||
- Compatibility with Nuxt 2 module ecosystem
|
||||
- Upgrade piece by piece (Nitro, Composition API, Nuxt Kit)
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
"example": "yarn workspace example-$0 dev",
|
||||
"example:build": "yarn workspace example-$0 build",
|
||||
"lint": "eslint --ext .vue,.ts,.js,.mjs .",
|
||||
"lint:docs": "./node_modules/.bin/markdownlint ./",
|
||||
"lint:docs": "./node_modules/.bin/markdownlint ./ && case-police '**/*.md'",
|
||||
"nuxi": "./node_modules/.bin/nuxi",
|
||||
"nuxt": "./node_modules/.bin/nuxi",
|
||||
"play": "echo use yarn dev && exit 1",
|
||||
@ -43,6 +43,7 @@
|
||||
"@types/node": "^16.11.26",
|
||||
"@types/object-hash": "^2",
|
||||
"@unocss/reset": "^0.30.11",
|
||||
"case-police": "^0.5.1",
|
||||
"esbuild": "^0.14.31",
|
||||
"eslint": "^8.12.0",
|
||||
"eslint-plugin-jsdoc": "^38.1.6",
|
||||
|
||||
10
yarn.lock
10
yarn.lock
@ -7300,6 +7300,15 @@ __metadata:
|
||||
languageName: node
|
||||
linkType: hard
|
||||
|
||||
"case-police@npm:^0.5.1":
|
||||
version: 0.5.1
|
||||
resolution: "case-police@npm:0.5.1"
|
||||
bin:
|
||||
case-police: bin/case-police.mjs
|
||||
checksum: 315d1e58c684c944454e5734b923e3e9ae061e63cb3c866ccf9fb3b88fd23321a9caab4b7c8841a488af66524ce13107ceb8f47916e2659133a0493f59c29a28
|
||||
languageName: node
|
||||
linkType: hard
|
||||
|
||||
"caseless@npm:~0.12.0":
|
||||
version: 0.12.0
|
||||
resolution: "caseless@npm:0.12.0"
|
||||
@ -15739,6 +15748,7 @@ __metadata:
|
||||
"@types/node": ^16.11.26
|
||||
"@types/object-hash": ^2
|
||||
"@unocss/reset": ^0.30.11
|
||||
case-police: ^0.5.1
|
||||
esbuild: ^0.14.31
|
||||
eslint: ^8.12.0
|
||||
eslint-plugin-jsdoc: ^38.1.6
|
||||
|
||||
Loading…
Reference in New Issue
Block a user