docs: show a warning in v1 docs (#7003)

Co-authored-by: Vladimir Sheremet <[email protected]>
vitest-dev · Dec 3, 2024 · 73cb696 · 73cb696
1 parent ef8cc00
commit 73cb696
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 2 deletions.
diff --git a/docs/.vitepress/components.d.ts b/docs/.vitepress/components.d.ts
@@ -13,6 +13,7 @@ declare module 'vue' {
     HomePage: typeof import('./components/HomePage.vue')['default']
     ListItem: typeof import('./components/ListItem.vue')['default']
     NonProjectOption: typeof import('./components/NonProjectOption.vue')['default']
+    OldDocument: typeof import('./components/OldDocument.vue')['default']
     RouterLink: typeof import('vue-router')['RouterLink']
     RouterView: typeof import('vue-router')['RouterView']
     Version: typeof import('./components/Version.vue')['default']

diff --git a/docs/.vitepress/components/OldDocument.vue b/docs/.vitepress/components/OldDocument.vue
@@ -0,0 +1,42 @@
+<template>
+  <div class="old-document">
+    <p>
+      This documentation covers Vitest v1 <strong>(old version)</strong>. For the
+      latest version, see
+      <a href="https://vitest.dev" class="new-document-link">https://vitest.dev</a>.
+    </p>
+  </div>
+</template>
+
+<style>
+:root {
+  --vp-layout-top-height: 96px;
+  @media (min-width: 455px) {
+    --vp-layout-top-height: 64px;
+  }
+  @media (min-width: 960px) {
+    --vp-layout-top-height: 32px;
+  }
+}
+
+.old-document {
+  position: fixed;
+  display: flex;
+  height: var(--vp-layout-top-height);
+  width: 100%;
+  padding: 4px 32px;
+  justify-content: center;
+  align-items: center;
+  color: var(--vp-c-old-document-text);
+  background: var(--vp-c-old-document-bg);
+  z-index: var(--vp-z-index-layout-top);
+
+  .new-document-link {
+    text-decoration: underline;
+    color: var(--vp-c-text-1);
+    &:hover {
+      color: var(--vp-c-text-2);
+    }
+  }
+}
+</style>
diff --git a/docs/.vitepress/style/vars.css b/docs/.vitepress/style/vars.css
@@ -8,6 +8,10 @@
   --vp-c-brand-3: #506e10;
   --vp-c-sponsor: #ca2971;
   --vitest-c-sponsor-hover: #c13071;
+
+  /* Old Document */
+  --vp-c-old-document-bg: #f4f8e0;
+  --vp-c-old-document-text: #2a3a1b;
 }
 
 .dark {
@@ -16,6 +20,10 @@
   --vp-c-brand-3: #acd268;
   --vp-c-sponsor: #ee4e95;
   --vitest-c-sponsor-hover: #e51370;
+
+  /* Old Document */
+  --vp-c-old-document-bg: #2d3b2e;
+  --vp-c-old-document-text: #c5d9b6;
 }
 
 

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -6,6 +6,7 @@ import '../style/main.css'
 import '../style/vars.css'
 import 'uno.css'
 import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client'
+import OldDocument from '../components/OldDocument.vue'
 import HomePage from '../components/HomePage.vue'
 import Version from '../components/Version.vue'
 import '@shikijs/vitepress-twoslash/style.css'
@@ -18,6 +19,7 @@ export default {
   Layout() {
     return h(Theme.Layout, null, {
       'home-features-after': () => h(HomePage),
+      'layout-top': () => h(OldDocument),
     })
   },
   enhanceApp({ app }: EnhanceAppContext) {

diff --git a/packages/coverage-istanbul/src/provider.ts b/packages/coverage-istanbul/src/provider.ts
@@ -13,7 +13,8 @@ import libCoverage from 'istanbul-lib-coverage'
 import libSourceMaps from 'istanbul-lib-source-maps'
 import { type Instrumenter, createInstrumenter } from 'istanbul-lib-instrument'
 
-// @ts-expect-error missing types
+// eslint-disable-next-line ts/prefer-ts-expect-error
+// @ts-ignore missing types
 import _TestExclude from 'test-exclude'
 import { COVERAGE_STORE_KEY } from './constants'
 

diff --git a/packages/coverage-v8/src/provider.ts b/packages/coverage-v8/src/provider.ts
@@ -23,7 +23,8 @@ import { BaseCoverageProvider } from 'vitest/coverage'
 import type { AfterSuiteRunMeta, CoverageProvider, CoverageV8Options, ReportContext, ResolvedCoverageOptions } from 'vitest'
 import type { Vitest } from 'vitest/node'
 
-// @ts-expect-error missing types
+// eslint-disable-next-line ts/prefer-ts-expect-error
+// @ts-ignore missing types
 import _TestExclude from 'test-exclude'
 
 interface TestExclude {