Skip to content

Commit 3cdd2e6

Browse files
fengmk2fengmk2
authored
fix(docs): include docs/ in fmt and lint (#1552)
## Summary - Remove `docs/**` from `fmt.ignorePatterns` and `lint.ignorePatterns` in `vite.config.ts` so the `docs/` directory is formatted and linted with the rest of the repo. - Fix two lint errors that surfaced once `docs/.vitepress` was included: - `docs/.vitepress/tsconfig.json`: replace `noEmit: false` + `emitDeclarationOnly` / `outDir` / `declaration` with `noEmit: true`. This config is editor/lint-only (no build script consumes it), so emit settings were spurious and triggered a `rootDir` error. - `docs/.vitepress/config.mts`: drop `tsconfigPaths: true`. Vitepress bundles upstream `vite@7.3.1` which doesn't have that option on `ResolveOptions` (only Vite+'s fork does), so it was silently ignored at runtime. The `alias` entries below already cover the needed path mappings. ## Test plan - [x] `vp fmt` — reformats 6 previously-skipped files under `docs/` - [x] `vp lint` — 0 warnings, 0 errors across 182 files
1 parent 285d1e0 commit 3cdd2e6

9 files changed

Lines changed: 71 additions & 78 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ export default extendConfig(
115115
include: ['mermaid > @braintree/sanitize-url'],
116116
},
117117
resolve: {
118-
tsconfigPaths: true,
119118
alias: [
120119
{ find: '@local-assets', replacement: resolve(__dirname, 'theme/assets') },
121120
{ find: '@layouts', replacement: resolve(__dirname, 'theme/layouts') },

‎docs/.vitepress/tsconfig.json‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@
55
"lib": ["ES2024", "DOM", "DOM.Iterable"],
66
"moduleResolution": "bundler",
77
"resolveJsonModule": true,
8-
"noEmit": false,
9-
"emitDeclarationOnly": true,
10-
"outDir": "dist",
8+
"noEmit": true,
119
"allowImportingTsExtensions": true,
1210
"strict": true,
13-
"declaration": true,
1411
"skipLibCheck": true,
1512
"esModuleInterop": true,
1613
"allowSyntheticDefaultImports": true,

‎docs/_data/team.ts‎

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,119 @@
1-
import type { DefaultTheme } from "vitepress";
1+
import type { DefaultTheme } from 'vitepress';
22

33
export const core: DefaultTheme.TeamMember[] = [
44
{
5-
avatar: "https://github.com/fengmk2.png",
6-
name: "MK",
5+
avatar: 'https://github.com/fengmk2.png',
6+
name: 'MK',
77
links: [
8-
{ icon: "github", link: "https://github.com/fengmk2" },
9-
{ icon: "x", link: "https://x.com/fengmk2" },
8+
{ icon: 'github', link: 'https://github.com/fengmk2' },
9+
{ icon: 'x', link: 'https://x.com/fengmk2' },
1010
],
1111
},
1212
{
13-
avatar: "https://github.com/branchseer.png",
14-
name: "Wang Chi",
13+
avatar: 'https://github.com/branchseer.png',
14+
name: 'Wang Chi',
1515
links: [
16-
{ icon: "github", link: "https://github.com/branchseer" },
17-
{ icon: "x", link: "https://x.com/branchseer" },
16+
{ icon: 'github', link: 'https://github.com/branchseer' },
17+
{ icon: 'x', link: 'https://x.com/branchseer' },
1818
],
1919
},
2020
{
21-
avatar: "https://github.com/Brooooooklyn.png",
22-
name: "Long Yinan",
21+
avatar: 'https://github.com/Brooooooklyn.png',
22+
name: 'Long Yinan',
2323
links: [
24-
{ icon: "github", link: "https://github.com/Brooooooklyn" },
25-
{ icon: "x", link: "https://x.com/Brooooook_lyn" },
24+
{ icon: 'github', link: 'https://github.com/Brooooooklyn' },
25+
{ icon: 'x', link: 'https://x.com/Brooooook_lyn' },
2626
],
2727
},
2828
{
29-
avatar: "https://github.com/cpojer.png",
30-
name: "Christoph Nakazawa",
29+
avatar: 'https://github.com/cpojer.png',
30+
name: 'Christoph Nakazawa',
3131
links: [
32-
{ icon: "github", link: "https://github.com/cpojer" },
33-
{ icon: "x", link: "https://x.com/cpojer" },
34-
{ icon: "bluesky", link: "https://bsky.app/profile/christoph.nkzw.tech" },
32+
{ icon: 'github', link: 'https://github.com/cpojer' },
33+
{ icon: 'x', link: 'https://x.com/cpojer' },
34+
{ icon: 'bluesky', link: 'https://bsky.app/profile/christoph.nkzw.tech' },
3535
],
3636
},
3737
{
38-
avatar: "https://github.com/TheAlexLichter.png",
39-
name: "Alexander Lichter",
38+
avatar: 'https://github.com/TheAlexLichter.png',
39+
name: 'Alexander Lichter',
4040
links: [
41-
{ icon: "github", link: "https://github.com/TheAlexLichter" },
42-
{ icon: "x", link: "https://x.com/TheAlexLichter" },
43-
{ icon: "bluesky", link: "https://bsky.app/profile/thealexlichter.com" },
41+
{ icon: 'github', link: 'https://github.com/TheAlexLichter' },
42+
{ icon: 'x', link: 'https://x.com/TheAlexLichter' },
43+
{ icon: 'bluesky', link: 'https://bsky.app/profile/thealexlichter.com' },
4444
],
4545
},
4646
{
47-
avatar: "https://github.com/camc314.png",
48-
name: "Cameron Clark",
47+
avatar: 'https://github.com/camc314.png',
48+
name: 'Cameron Clark',
4949
links: [
50-
{ icon: "github", link: "https://github.com/camc314" },
51-
{ icon: "x", link: "https://x.com/cameron_C2" },
50+
{ icon: 'github', link: 'https://github.com/camc314' },
51+
{ icon: 'x', link: 'https://x.com/cameron_C2' },
5252
],
5353
},
5454
{
55-
avatar: "https://github.com/leaysgur.png",
56-
name: "Yuji Sugiura",
55+
avatar: 'https://github.com/leaysgur.png',
56+
name: 'Yuji Sugiura',
5757
links: [
58-
{ icon: "github", link: "https://github.com/leaysgur" },
59-
{ icon: "x", link: "https://x.com/leaysgur" },
58+
{ icon: 'github', link: 'https://github.com/leaysgur' },
59+
{ icon: 'x', link: 'https://x.com/leaysgur' },
6060
],
6161
},
6262
{
63-
avatar: "https://github.com/mdong1909.png",
64-
name: "Michael Dong",
63+
avatar: 'https://github.com/mdong1909.png',
64+
name: 'Michael Dong',
6565
links: [
66-
{ icon: "github", link: "https://github.com/mdong1909" },
67-
{ icon: "x", link: "https://x.com/mdong1909" },
68-
{ icon: "linkedin", link: "https://www.linkedin.com/in/michael-d-612b5b50/" },
66+
{ icon: 'github', link: 'https://github.com/mdong1909' },
67+
{ icon: 'x', link: 'https://x.com/mdong1909' },
68+
{ icon: 'linkedin', link: 'https://www.linkedin.com/in/michael-d-612b5b50/' },
6969
],
7070
},
7171
{
72-
avatar: "https://github.com/kazupon.png",
73-
name: "kazupon",
72+
avatar: 'https://github.com/kazupon.png',
73+
name: 'kazupon',
7474
links: [
75-
{ icon: "github", link: "https://github.com/kazupon" },
76-
{ icon: "x", link: "https://x.com/kazupon" },
77-
{ icon: "bluesky", link: "https://bsky.app/profile/kazupon.dev" },
75+
{ icon: 'github', link: 'https://github.com/kazupon' },
76+
{ icon: 'x', link: 'https://x.com/kazupon' },
77+
{ icon: 'bluesky', link: 'https://bsky.app/profile/kazupon.dev' },
7878
],
7979
},
8080
{
81-
avatar: "https://github.com/ubugeeei.png",
82-
name: "ubugeeei",
81+
avatar: 'https://github.com/ubugeeei.png',
82+
name: 'ubugeeei',
8383
links: [
84-
{ icon: "github", link: "https://github.com/ubugeeei" },
85-
{ icon: "x", link: "https://x.com/ubugeeei" },
84+
{ icon: 'github', link: 'https://github.com/ubugeeei' },
85+
{ icon: 'x', link: 'https://x.com/ubugeeei' },
8686
],
8787
},
8888
{
89-
avatar: "https://github.com/nekomoyi.png",
90-
name: "nekomoyi",
91-
links: [{ icon: "github", link: "https://github.com/nekomoyi" }],
89+
avatar: 'https://github.com/nekomoyi.png',
90+
name: 'nekomoyi',
91+
links: [{ icon: 'github', link: 'https://github.com/nekomoyi' }],
9292
},
9393
{
94-
avatar: "https://github.com/HaasStefan.png",
95-
name: "Stefan Haas",
94+
avatar: 'https://github.com/HaasStefan.png',
95+
name: 'Stefan Haas',
9696
links: [
97-
{ icon: "github", link: "https://github.com/HaasStefan" },
98-
{ icon: "x", link: "https://x.com/StefanvHaas" },
99-
{ icon: "linkedin", link: "https://www.linkedin.com/in/stefan-haas-angular" },
97+
{ icon: 'github', link: 'https://github.com/HaasStefan' },
98+
{ icon: 'x', link: 'https://x.com/StefanvHaas' },
99+
{ icon: 'linkedin', link: 'https://www.linkedin.com/in/stefan-haas-angular' },
100100
],
101101
},
102102
{
103-
avatar: "https://github.com/naokihaba.png",
104-
name: "naokihaba",
103+
avatar: 'https://github.com/naokihaba.png',
104+
name: 'naokihaba',
105105
links: [
106-
{ icon: "github", link: "https://github.com/naokihaba" },
107-
{ icon: "x", link: "https://x.com/naokihaba" },
108-
{ icon: "bluesky", link: "https://bsky.app/profile/naokihaba.com" },
106+
{ icon: 'github', link: 'https://github.com/naokihaba' },
107+
{ icon: 'x', link: 'https://x.com/naokihaba' },
108+
{ icon: 'bluesky', link: 'https://bsky.app/profile/naokihaba.com' },
109109
],
110110
},
111111
{
112-
avatar: "https://github.com/jong-kyung.png",
113-
name: "JongKyung Lee",
112+
avatar: 'https://github.com/jong-kyung.png',
113+
name: 'JongKyung Lee',
114114
links: [
115-
{ icon: "github", link: "https://github.com/jong-kyung" },
116-
{ icon: "linkedin", link: "https://www.linkedin.com/in/jong-kyung" },
115+
{ icon: 'github', link: 'https://github.com/jong-kyung' },
116+
{ icon: 'linkedin', link: 'https://www.linkedin.com/in/jong-kyung' },
117117
],
118118
},
119119
];

‎docs/config/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Vite+ extends the basic Vite configuration with these additions:
2828
- [`test`](/config/test) for Vitest
2929
- [`run`](/config/run) for Vite Task
3030
- [`pack`](/config/pack) for tsdown
31-
- [`staged`](/config/staged) for staged-file checks
31+
- [`staged`](/config/staged) for staged-file checks

‎docs/config/run.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ tasks: {
214214
```
215215

216216
The `base` field is required and controls how the glob pattern is resolved:
217+
217218
- `"package"`: relative to the package directory
218219
- `"workspace"`: relative to the workspace root
219220

‎docs/guide/create.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,12 @@ The manifest lives at `createConfig.templates` in `@org/create`'s `package.json`
174174

175175
Each entry supports:
176176

177-
| Field | Required | Notes |
178-
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
179-
| `name` | yes | Kebab-case identifier. Used by `vp create @org:<name>` for direct selection. Must be unique within the array. |
180-
| `description` | yes | One-line description shown in the picker. |
177+
| Field | Required | Notes |
178+
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
179+
| `name` | yes | Kebab-case identifier. Used by `vp create @org:<name>` for direct selection. Must be unique within the array. |
180+
| `description` | yes | One-line description shown in the picker. |
181181
| `template` | yes | An npm specifier (`@org/template-foo`, optionally `@version`), a GitHub URL (`github:user/repo`), a `vite:*` builtin, a local workspace package name, or a relative path (`./templates/foo`) that resolves against the `@org/create` root. |
182-
| `monorepo` | no | If `true`, marks this entry as a monorepo-creating template. Hidden from the picker when `vp create` runs inside an existing monorepo, mirroring the built-in `vite:monorepo` filter. |
182+
| `monorepo` | no | If `true`, marks this entry as a monorepo-creating template. Hidden from the picker when `vp create` runs inside an existing monorepo, mirroring the built-in `vite:monorepo` filter. |
183183

184184
An invalid manifest is a hard error, not a silent fall-through — a maintainer who shipped a manifest should hear about the offending field, e.g. `@your-org/create: createConfig.templates[2].template must be a non-empty string`.
185185

‎docs/guide/troubleshooting.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ If you are migrating an existing project and it still depends on older Vite or V
2222

2323
The Oxlint type checker path powered by `tsgolint` does not support `baseUrl`, so Vite+ skips `typeAware` and `typeCheck` when that setting is present.
2424

25-
2625
## `vp lint` / `vp fmt` may fail to read `vite.config.ts`
2726

2827
`vp lint`, `vp fmt`, and the Oxc VS Code extension all read the `lint` / `fmt` blocks from `vite.config.ts`. Today that support has important limitations.

‎docs/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@
2424
"vitepress": "2.0.0-alpha.15"
2525
},
2626
"packageManager": "pnpm@10.33.2"
27-
}
27+
}

‎vite.config.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ export default defineConfig({
4747
'**/snap-tests/**',
4848
'**/snap-tests-global/**',
4949
'**/snap-tests-todo/**',
50-
'docs/**',
5150
'packages/*/binding/**',
5251
'packages/core/rollupLicensePlugin.ts',
5352
'packages/core/vite-rolldown.config.ts',
@@ -70,8 +69,6 @@ export default defineConfig({
7069
'packages/cli/snap-tests/check-*/**',
7170
'packages/cli/snap-tests/fmt-ignore-patterns/src/ignored',
7271
'packages/cli/snap-tests-global/migration-lint-staged-ts-config',
73-
'docs/**',
74-
'!docs/.vitepress/**',
7572
'ecosystem-ci/*/**',
7673
'packages/test/**.cjs',
7774
'packages/test/**.cts',

0 commit comments

Comments
 (0)