@readme/cli 0.0.27 → 0.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/package.json +5 -5
  2. package/src/cli.js +3 -3
  3. package/src/commands/import-oas.test.js +277 -0
  4. package/src/commands/import.classify.test.js +172 -0
  5. package/src/commands/import.js +2848 -443
  6. package/src/commands/import.landing.test.js +217 -0
  7. package/src/commands/import.slug-planner.test.js +86 -0
  8. package/src/commands/import.staging.test.js +158 -0
  9. package/src/commands/import.test.js +382 -0
  10. package/src/commands/oas-sync.js +362 -92
  11. package/src/prompts/index.js +101 -13
  12. package/src/utils/lint.js +2 -2
  13. package/src/utils/llms.js +224 -0
  14. package/src/utils/llms.test.js +302 -0
  15. package/src/utils/reporter.js +2 -1
  16. package/src/utils/slug-for-entry.js +16 -0
  17. package/src/utils/url-segs.js +124 -0
  18. package/src/utils/url-segs.test.js +239 -0
  19. package/src/validators/components.js +11 -7
  20. package/src/validators/duplicates.js +8 -8
  21. package/src/validators/frontmatter.js +11 -0
  22. package/src/validators/links.js +2 -8
  23. package/src/validators/oas-reference.js +13 -38
  24. package/src/validators/ordering.js +169 -83
  25. package/vendor/TOOLS.md +1 -1
  26. package/src/dev/.next/app-build-manifest.json +0 -20
  27. package/src/dev/.next/build-manifest.json +0 -31
  28. package/src/dev/.next/cache/.rscinfo +0 -1
  29. package/src/dev/.next/cache/next-devtools-config.json +0 -1
  30. package/src/dev/.next/cache/webpack/client-development/0.pack.gz +0 -0
  31. package/src/dev/.next/cache/webpack/client-development/1.pack.gz +0 -0
  32. package/src/dev/.next/cache/webpack/client-development/10.pack.gz +0 -0
  33. package/src/dev/.next/cache/webpack/client-development/11.pack.gz +0 -0
  34. package/src/dev/.next/cache/webpack/client-development/2.pack.gz +0 -0
  35. package/src/dev/.next/cache/webpack/client-development/3.pack.gz +0 -0
  36. package/src/dev/.next/cache/webpack/client-development/3.pack.gz_ +0 -0
  37. package/src/dev/.next/cache/webpack/client-development/4.pack.gz +0 -0
  38. package/src/dev/.next/cache/webpack/client-development/5.pack.gz +0 -0
  39. package/src/dev/.next/cache/webpack/client-development/5.pack.gz_ +0 -0
  40. package/src/dev/.next/cache/webpack/client-development/6.pack.gz +0 -0
  41. package/src/dev/.next/cache/webpack/client-development/7.pack.gz +0 -0
  42. package/src/dev/.next/cache/webpack/client-development/7.pack.gz_ +0 -0
  43. package/src/dev/.next/cache/webpack/client-development/8.pack.gz +0 -0
  44. package/src/dev/.next/cache/webpack/client-development/9.pack.gz +0 -0
  45. package/src/dev/.next/cache/webpack/client-development/index.pack.gz.old +0 -0
  46. package/src/dev/.next/cache/webpack/client-development-fallback/0.pack.gz +0 -0
  47. package/src/dev/.next/cache/webpack/client-development-fallback/1.pack.gz +0 -0
  48. package/src/dev/.next/cache/webpack/client-development-fallback/index.pack.gz +0 -0
  49. package/src/dev/.next/cache/webpack/client-development-fallback/index.pack.gz.old +0 -0
  50. package/src/dev/.next/cache/webpack/edge-server-development/0.pack.gz +0 -0
  51. package/src/dev/.next/cache/webpack/edge-server-development/1.pack.gz +0 -0
  52. package/src/dev/.next/cache/webpack/edge-server-development/index.pack.gz +0 -0
  53. package/src/dev/.next/cache/webpack/edge-server-development/index.pack.gz.old +0 -0
  54. package/src/dev/.next/cache/webpack/server-development/0.pack.gz +0 -0
  55. package/src/dev/.next/cache/webpack/server-development/1.pack.gz +0 -0
  56. package/src/dev/.next/cache/webpack/server-development/10.pack.gz +0 -0
  57. package/src/dev/.next/cache/webpack/server-development/11.pack.gz +0 -0
  58. package/src/dev/.next/cache/webpack/server-development/12.pack.gz +0 -0
  59. package/src/dev/.next/cache/webpack/server-development/13.pack.gz +0 -0
  60. package/src/dev/.next/cache/webpack/server-development/14.pack.gz +0 -0
  61. package/src/dev/.next/cache/webpack/server-development/15.pack.gz +0 -0
  62. package/src/dev/.next/cache/webpack/server-development/2.pack.gz +0 -0
  63. package/src/dev/.next/cache/webpack/server-development/2.pack.gz_ +0 -0
  64. package/src/dev/.next/cache/webpack/server-development/3.pack.gz +0 -0
  65. package/src/dev/.next/cache/webpack/server-development/3.pack.gz_ +0 -0
  66. package/src/dev/.next/cache/webpack/server-development/4.pack.gz +0 -0
  67. package/src/dev/.next/cache/webpack/server-development/5.pack.gz +0 -0
  68. package/src/dev/.next/cache/webpack/server-development/6.pack.gz +0 -0
  69. package/src/dev/.next/cache/webpack/server-development/6.pack.gz_ +0 -0
  70. package/src/dev/.next/cache/webpack/server-development/7.pack.gz +0 -0
  71. package/src/dev/.next/cache/webpack/server-development/7.pack.gz_ +0 -0
  72. package/src/dev/.next/cache/webpack/server-development/8.pack.gz +0 -0
  73. package/src/dev/.next/cache/webpack/server-development/9.pack.gz +0 -0
  74. package/src/dev/.next/cache/webpack/server-development/9.pack.gz_ +0 -0
  75. package/src/dev/.next/cache/webpack/server-development/index.pack.gz +0 -0
  76. package/src/dev/.next/cache/webpack/server-development/index.pack.gz.old +0 -0
  77. package/src/dev/.next/package.json +0 -1
  78. package/src/dev/.next/prerender-manifest.json +0 -11
  79. package/src/dev/.next/react-loadable-manifest.json +0 -1
  80. package/src/dev/.next/routes-manifest.json +0 -1
  81. package/src/dev/.next/server/app/[...slug]/page.js +0 -360
  82. package/src/dev/.next/server/app/[...slug]/page_client-reference-manifest.js +0 -1
  83. package/src/dev/.next/server/app/page.js +0 -349
  84. package/src/dev/.next/server/app/page_client-reference-manifest.js +0 -1
  85. package/src/dev/.next/server/app-paths-manifest.json +0 -3
  86. package/src/dev/.next/server/edge-runtime-webpack.js +0 -1151
  87. package/src/dev/.next/server/interception-route-rewrite-manifest.js +0 -1
  88. package/src/dev/.next/server/middleware-build-manifest.js +0 -33
  89. package/src/dev/.next/server/middleware-manifest.json +0 -32
  90. package/src/dev/.next/server/middleware-react-loadable-manifest.js +0 -1
  91. package/src/dev/.next/server/middleware.js +0 -1113
  92. package/src/dev/.next/server/next-font-manifest.js +0 -1
  93. package/src/dev/.next/server/next-font-manifest.json +0 -1
  94. package/src/dev/.next/server/pages-manifest.json +0 -5
  95. package/src/dev/.next/server/server-reference-manifest.js +0 -1
  96. package/src/dev/.next/server/server-reference-manifest.json +0 -5
  97. package/src/dev/.next/server/static/webpack/633457081244afec._.hot-update.json +0 -1
  98. package/src/dev/.next/server/vendor-chunks/@readme.js +0 -25
  99. package/src/dev/.next/server/vendor-chunks/@swc.js +0 -55
  100. package/src/dev/.next/server/vendor-chunks/next.js +0 -3659
  101. package/src/dev/.next/server/webpack-runtime.js +0 -209
  102. package/src/dev/.next/static/chunks/app/[...slug]/loading.js +0 -28
  103. package/src/dev/.next/static/chunks/app/[...slug]/page.js +0 -28
  104. package/src/dev/.next/static/chunks/app/layout.js +0 -171
  105. package/src/dev/.next/static/chunks/app/page.js +0 -28
  106. package/src/dev/.next/static/chunks/app-pages-internals.js +0 -182
  107. package/src/dev/.next/static/chunks/main-app.js +0 -1882
  108. package/src/dev/.next/static/chunks/polyfills.js +0 -1
  109. package/src/dev/.next/static/chunks/webpack.js +0 -1393
  110. package/src/dev/.next/static/css/app/layout.css +0 -559
  111. package/src/dev/.next/static/development/_buildManifest.js +0 -1
  112. package/src/dev/.next/static/development/_ssgManifest.js +0 -1
  113. package/src/dev/.next/static/webpack/633457081244afec._.hot-update.json +0 -1
  114. package/src/dev/.next/static/webpack/ec52a3fce0f78db0.webpack.hot-update.json +0 -1
  115. package/src/dev/.next/static/webpack/webpack.ec52a3fce0f78db0.hot-update.js +0 -12
  116. package/src/dev/.next/trace +0 -21
  117. package/src/dev/.next/types/app/[...slug]/page.ts +0 -84
  118. package/src/dev/.next/types/app/layout.ts +0 -84
  119. package/src/dev/.next/types/app/page.ts +0 -84
  120. package/src/dev/.next/types/cache-life.d.ts +0 -141
  121. package/src/dev/.next/types/package.json +0 -1
  122. package/src/dev/.next/types/routes.d.ts +0 -55
  123. package/src/validators/numbering.js +0 -134
@@ -1,84 +0,0 @@
1
- // File: /Users/gkoberger/Sites/readme/2026-readme-cli/src/dev/app/[...slug]/page.js
2
- import * as entry from '../../../../app/[...slug]/page.js'
3
- import type { ResolvingMetadata, ResolvingViewport } from 'next/dist/lib/metadata/types/metadata-interface.js'
4
-
5
- type TEntry = typeof import('../../../../app/[...slug]/page.js')
6
-
7
- type SegmentParams<T extends Object = any> = T extends Record<string, any>
8
- ? { [K in keyof T]: T[K] extends string ? string | string[] | undefined : never }
9
- : T
10
-
11
- // Check that the entry is a valid entry
12
- checkFields<Diff<{
13
- default: Function
14
- config?: {}
15
- generateStaticParams?: Function
16
- revalidate?: RevalidateRange<TEntry> | false
17
- dynamic?: 'auto' | 'force-dynamic' | 'error' | 'force-static'
18
- dynamicParams?: boolean
19
- fetchCache?: 'auto' | 'force-no-store' | 'only-no-store' | 'default-no-store' | 'default-cache' | 'only-cache' | 'force-cache'
20
- preferredRegion?: 'auto' | 'global' | 'home' | string | string[]
21
- runtime?: 'nodejs' | 'experimental-edge' | 'edge'
22
- maxDuration?: number
23
-
24
- metadata?: any
25
- generateMetadata?: Function
26
- viewport?: any
27
- generateViewport?: Function
28
- experimental_ppr?: boolean
29
-
30
- }, TEntry, ''>>()
31
-
32
-
33
- // Check the prop type of the entry function
34
- checkFields<Diff<PageProps, FirstArg<TEntry['default']>, 'default'>>()
35
-
36
- // Check the arguments and return type of the generateMetadata function
37
- if ('generateMetadata' in entry) {
38
- checkFields<Diff<PageProps, FirstArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
39
- checkFields<Diff<ResolvingMetadata, SecondArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
40
- }
41
-
42
- // Check the arguments and return type of the generateViewport function
43
- if ('generateViewport' in entry) {
44
- checkFields<Diff<PageProps, FirstArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
45
- checkFields<Diff<ResolvingViewport, SecondArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
46
- }
47
-
48
- // Check the arguments and return type of the generateStaticParams function
49
- if ('generateStaticParams' in entry) {
50
- checkFields<Diff<{ params: SegmentParams }, FirstArg<MaybeField<TEntry, 'generateStaticParams'>>, 'generateStaticParams'>>()
51
- checkFields<Diff<{ __tag__: 'generateStaticParams', __return_type__: any[] | Promise<any[]> }, { __tag__: 'generateStaticParams', __return_type__: ReturnType<MaybeField<TEntry, 'generateStaticParams'>> }>>()
52
- }
53
-
54
- export interface PageProps {
55
- params?: Promise<SegmentParams>
56
- searchParams?: Promise<any>
57
- }
58
- export interface LayoutProps {
59
- children?: React.ReactNode
60
-
61
- params?: Promise<SegmentParams>
62
- }
63
-
64
- // =============
65
- // Utility types
66
- type RevalidateRange<T> = T extends { revalidate: any } ? NonNegative<T['revalidate']> : never
67
-
68
- // If T is unknown or any, it will be an empty {} type. Otherwise, it will be the same as Omit<T, keyof Base>.
69
- type OmitWithTag<T, K extends keyof any, _M> = Omit<T, K>
70
- type Diff<Base, T extends Base, Message extends string = ''> = 0 extends (1 & T) ? {} : OmitWithTag<T, keyof Base, Message>
71
-
72
- type FirstArg<T extends Function> = T extends (...args: [infer T, any]) => any ? unknown extends T ? any : T : never
73
- type SecondArg<T extends Function> = T extends (...args: [any, infer T]) => any ? unknown extends T ? any : T : never
74
- type MaybeField<T, K extends string> = T extends { [k in K]: infer G } ? G extends Function ? G : never : never
75
-
76
-
77
-
78
- function checkFields<_ extends { [k in keyof any]: never }>() {}
79
-
80
- // https://github.com/sindresorhus/type-fest
81
- type Numeric = number | bigint
82
- type Zero = 0 | 0n
83
- type Negative<T extends Numeric> = T extends Zero ? never : `${T}` extends `-${string}` ? T : never
84
- type NonNegative<T extends Numeric> = T extends Zero ? T : Negative<T> extends never ? T : '__invalid_negative_number__'
@@ -1,84 +0,0 @@
1
- // File: /Users/gkoberger/Sites/readme/2026-readme-cli/src/dev/app/layout.js
2
- import * as entry from '../../../app/layout.js'
3
- import type { ResolvingMetadata, ResolvingViewport } from 'next/dist/lib/metadata/types/metadata-interface.js'
4
-
5
- type TEntry = typeof import('../../../app/layout.js')
6
-
7
- type SegmentParams<T extends Object = any> = T extends Record<string, any>
8
- ? { [K in keyof T]: T[K] extends string ? string | string[] | undefined : never }
9
- : T
10
-
11
- // Check that the entry is a valid entry
12
- checkFields<Diff<{
13
- default: Function
14
- config?: {}
15
- generateStaticParams?: Function
16
- revalidate?: RevalidateRange<TEntry> | false
17
- dynamic?: 'auto' | 'force-dynamic' | 'error' | 'force-static'
18
- dynamicParams?: boolean
19
- fetchCache?: 'auto' | 'force-no-store' | 'only-no-store' | 'default-no-store' | 'default-cache' | 'only-cache' | 'force-cache'
20
- preferredRegion?: 'auto' | 'global' | 'home' | string | string[]
21
- runtime?: 'nodejs' | 'experimental-edge' | 'edge'
22
- maxDuration?: number
23
-
24
- metadata?: any
25
- generateMetadata?: Function
26
- viewport?: any
27
- generateViewport?: Function
28
- experimental_ppr?: boolean
29
-
30
- }, TEntry, ''>>()
31
-
32
-
33
- // Check the prop type of the entry function
34
- checkFields<Diff<LayoutProps, FirstArg<TEntry['default']>, 'default'>>()
35
-
36
- // Check the arguments and return type of the generateMetadata function
37
- if ('generateMetadata' in entry) {
38
- checkFields<Diff<LayoutProps, FirstArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
39
- checkFields<Diff<ResolvingMetadata, SecondArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
40
- }
41
-
42
- // Check the arguments and return type of the generateViewport function
43
- if ('generateViewport' in entry) {
44
- checkFields<Diff<LayoutProps, FirstArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
45
- checkFields<Diff<ResolvingViewport, SecondArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
46
- }
47
-
48
- // Check the arguments and return type of the generateStaticParams function
49
- if ('generateStaticParams' in entry) {
50
- checkFields<Diff<{ params: SegmentParams }, FirstArg<MaybeField<TEntry, 'generateStaticParams'>>, 'generateStaticParams'>>()
51
- checkFields<Diff<{ __tag__: 'generateStaticParams', __return_type__: any[] | Promise<any[]> }, { __tag__: 'generateStaticParams', __return_type__: ReturnType<MaybeField<TEntry, 'generateStaticParams'>> }>>()
52
- }
53
-
54
- export interface PageProps {
55
- params?: Promise<SegmentParams>
56
- searchParams?: Promise<any>
57
- }
58
- export interface LayoutProps {
59
- children?: React.ReactNode
60
-
61
- params?: Promise<SegmentParams>
62
- }
63
-
64
- // =============
65
- // Utility types
66
- type RevalidateRange<T> = T extends { revalidate: any } ? NonNegative<T['revalidate']> : never
67
-
68
- // If T is unknown or any, it will be an empty {} type. Otherwise, it will be the same as Omit<T, keyof Base>.
69
- type OmitWithTag<T, K extends keyof any, _M> = Omit<T, K>
70
- type Diff<Base, T extends Base, Message extends string = ''> = 0 extends (1 & T) ? {} : OmitWithTag<T, keyof Base, Message>
71
-
72
- type FirstArg<T extends Function> = T extends (...args: [infer T, any]) => any ? unknown extends T ? any : T : never
73
- type SecondArg<T extends Function> = T extends (...args: [any, infer T]) => any ? unknown extends T ? any : T : never
74
- type MaybeField<T, K extends string> = T extends { [k in K]: infer G } ? G extends Function ? G : never : never
75
-
76
-
77
-
78
- function checkFields<_ extends { [k in keyof any]: never }>() {}
79
-
80
- // https://github.com/sindresorhus/type-fest
81
- type Numeric = number | bigint
82
- type Zero = 0 | 0n
83
- type Negative<T extends Numeric> = T extends Zero ? never : `${T}` extends `-${string}` ? T : never
84
- type NonNegative<T extends Numeric> = T extends Zero ? T : Negative<T> extends never ? T : '__invalid_negative_number__'
@@ -1,84 +0,0 @@
1
- // File: /Users/gkoberger/Sites/readme/2026-readme-cli/src/dev/app/page.js
2
- import * as entry from '../../../app/page.js'
3
- import type { ResolvingMetadata, ResolvingViewport } from 'next/dist/lib/metadata/types/metadata-interface.js'
4
-
5
- type TEntry = typeof import('../../../app/page.js')
6
-
7
- type SegmentParams<T extends Object = any> = T extends Record<string, any>
8
- ? { [K in keyof T]: T[K] extends string ? string | string[] | undefined : never }
9
- : T
10
-
11
- // Check that the entry is a valid entry
12
- checkFields<Diff<{
13
- default: Function
14
- config?: {}
15
- generateStaticParams?: Function
16
- revalidate?: RevalidateRange<TEntry> | false
17
- dynamic?: 'auto' | 'force-dynamic' | 'error' | 'force-static'
18
- dynamicParams?: boolean
19
- fetchCache?: 'auto' | 'force-no-store' | 'only-no-store' | 'default-no-store' | 'default-cache' | 'only-cache' | 'force-cache'
20
- preferredRegion?: 'auto' | 'global' | 'home' | string | string[]
21
- runtime?: 'nodejs' | 'experimental-edge' | 'edge'
22
- maxDuration?: number
23
-
24
- metadata?: any
25
- generateMetadata?: Function
26
- viewport?: any
27
- generateViewport?: Function
28
- experimental_ppr?: boolean
29
-
30
- }, TEntry, ''>>()
31
-
32
-
33
- // Check the prop type of the entry function
34
- checkFields<Diff<PageProps, FirstArg<TEntry['default']>, 'default'>>()
35
-
36
- // Check the arguments and return type of the generateMetadata function
37
- if ('generateMetadata' in entry) {
38
- checkFields<Diff<PageProps, FirstArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
39
- checkFields<Diff<ResolvingMetadata, SecondArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
40
- }
41
-
42
- // Check the arguments and return type of the generateViewport function
43
- if ('generateViewport' in entry) {
44
- checkFields<Diff<PageProps, FirstArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
45
- checkFields<Diff<ResolvingViewport, SecondArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
46
- }
47
-
48
- // Check the arguments and return type of the generateStaticParams function
49
- if ('generateStaticParams' in entry) {
50
- checkFields<Diff<{ params: SegmentParams }, FirstArg<MaybeField<TEntry, 'generateStaticParams'>>, 'generateStaticParams'>>()
51
- checkFields<Diff<{ __tag__: 'generateStaticParams', __return_type__: any[] | Promise<any[]> }, { __tag__: 'generateStaticParams', __return_type__: ReturnType<MaybeField<TEntry, 'generateStaticParams'>> }>>()
52
- }
53
-
54
- export interface PageProps {
55
- params?: Promise<SegmentParams>
56
- searchParams?: Promise<any>
57
- }
58
- export interface LayoutProps {
59
- children?: React.ReactNode
60
-
61
- params?: Promise<SegmentParams>
62
- }
63
-
64
- // =============
65
- // Utility types
66
- type RevalidateRange<T> = T extends { revalidate: any } ? NonNegative<T['revalidate']> : never
67
-
68
- // If T is unknown or any, it will be an empty {} type. Otherwise, it will be the same as Omit<T, keyof Base>.
69
- type OmitWithTag<T, K extends keyof any, _M> = Omit<T, K>
70
- type Diff<Base, T extends Base, Message extends string = ''> = 0 extends (1 & T) ? {} : OmitWithTag<T, keyof Base, Message>
71
-
72
- type FirstArg<T extends Function> = T extends (...args: [infer T, any]) => any ? unknown extends T ? any : T : never
73
- type SecondArg<T extends Function> = T extends (...args: [any, infer T]) => any ? unknown extends T ? any : T : never
74
- type MaybeField<T, K extends string> = T extends { [k in K]: infer G } ? G extends Function ? G : never : never
75
-
76
-
77
-
78
- function checkFields<_ extends { [k in keyof any]: never }>() {}
79
-
80
- // https://github.com/sindresorhus/type-fest
81
- type Numeric = number | bigint
82
- type Zero = 0 | 0n
83
- type Negative<T extends Numeric> = T extends Zero ? never : `${T}` extends `-${string}` ? T : never
84
- type NonNegative<T extends Numeric> = T extends Zero ? T : Negative<T> extends never ? T : '__invalid_negative_number__'
@@ -1,141 +0,0 @@
1
- // Type definitions for Next.js cacheLife configs
2
-
3
- declare module 'next/cache' {
4
- export { unstable_cache } from 'next/dist/server/web/spec-extension/unstable-cache'
5
- export {
6
- revalidateTag,
7
- revalidatePath,
8
- unstable_expireTag,
9
- unstable_expirePath,
10
- } from 'next/dist/server/web/spec-extension/revalidate'
11
- export { unstable_noStore } from 'next/dist/server/web/spec-extension/unstable-no-store'
12
-
13
-
14
- /**
15
- * Cache this `"use cache"` for a timespan defined by the `"default"` profile.
16
- * ```
17
- * stale: 300 seconds (5 minutes)
18
- * revalidate: 900 seconds (15 minutes)
19
- * expire: never
20
- * ```
21
- *
22
- * This cache may be stale on clients for 5 minutes before checking with the server.
23
- * If the server receives a new request after 15 minutes, start revalidating new values in the background.
24
- * It lives for the maximum age of the server cache. If this entry has no traffic for a while, it may serve an old value the next request.
25
- */
26
- export function unstable_cacheLife(profile: "default"): void
27
-
28
- /**
29
- * Cache this `"use cache"` for a timespan defined by the `"seconds"` profile.
30
- * ```
31
- * stale: 30 seconds
32
- * revalidate: 1 seconds
33
- * expire: 60 seconds (1 minute)
34
- * ```
35
- *
36
- * This cache may be stale on clients for 30 seconds before checking with the server.
37
- * If the server receives a new request after 1 seconds, start revalidating new values in the background.
38
- * If this entry has no traffic for 1 minute it will expire. The next request will recompute it.
39
- */
40
- export function unstable_cacheLife(profile: "seconds"): void
41
-
42
- /**
43
- * Cache this `"use cache"` for a timespan defined by the `"minutes"` profile.
44
- * ```
45
- * stale: 300 seconds (5 minutes)
46
- * revalidate: 60 seconds (1 minute)
47
- * expire: 3600 seconds (1 hour)
48
- * ```
49
- *
50
- * This cache may be stale on clients for 5 minutes before checking with the server.
51
- * If the server receives a new request after 1 minute, start revalidating new values in the background.
52
- * If this entry has no traffic for 1 hour it will expire. The next request will recompute it.
53
- */
54
- export function unstable_cacheLife(profile: "minutes"): void
55
-
56
- /**
57
- * Cache this `"use cache"` for a timespan defined by the `"hours"` profile.
58
- * ```
59
- * stale: 300 seconds (5 minutes)
60
- * revalidate: 3600 seconds (1 hour)
61
- * expire: 86400 seconds (1 day)
62
- * ```
63
- *
64
- * This cache may be stale on clients for 5 minutes before checking with the server.
65
- * If the server receives a new request after 1 hour, start revalidating new values in the background.
66
- * If this entry has no traffic for 1 day it will expire. The next request will recompute it.
67
- */
68
- export function unstable_cacheLife(profile: "hours"): void
69
-
70
- /**
71
- * Cache this `"use cache"` for a timespan defined by the `"days"` profile.
72
- * ```
73
- * stale: 300 seconds (5 minutes)
74
- * revalidate: 86400 seconds (1 day)
75
- * expire: 604800 seconds (1 week)
76
- * ```
77
- *
78
- * This cache may be stale on clients for 5 minutes before checking with the server.
79
- * If the server receives a new request after 1 day, start revalidating new values in the background.
80
- * If this entry has no traffic for 1 week it will expire. The next request will recompute it.
81
- */
82
- export function unstable_cacheLife(profile: "days"): void
83
-
84
- /**
85
- * Cache this `"use cache"` for a timespan defined by the `"weeks"` profile.
86
- * ```
87
- * stale: 300 seconds (5 minutes)
88
- * revalidate: 604800 seconds (1 week)
89
- * expire: 2592000 seconds (30 days)
90
- * ```
91
- *
92
- * This cache may be stale on clients for 5 minutes before checking with the server.
93
- * If the server receives a new request after 1 week, start revalidating new values in the background.
94
- * If this entry has no traffic for 30 days it will expire. The next request will recompute it.
95
- */
96
- export function unstable_cacheLife(profile: "weeks"): void
97
-
98
- /**
99
- * Cache this `"use cache"` for a timespan defined by the `"max"` profile.
100
- * ```
101
- * stale: 300 seconds (5 minutes)
102
- * revalidate: 2592000 seconds (30 days)
103
- * expire: never
104
- * ```
105
- *
106
- * This cache may be stale on clients for 5 minutes before checking with the server.
107
- * If the server receives a new request after 30 days, start revalidating new values in the background.
108
- * It lives for the maximum age of the server cache. If this entry has no traffic for a while, it may serve an old value the next request.
109
- */
110
- export function unstable_cacheLife(profile: "max"): void
111
-
112
- /**
113
- * Cache this `"use cache"` using a custom timespan.
114
- * ```
115
- * stale: ... // seconds
116
- * revalidate: ... // seconds
117
- * expire: ... // seconds
118
- * ```
119
- *
120
- * This is similar to Cache-Control: max-age=`stale`,s-max-age=`revalidate`,stale-while-revalidate=`expire-revalidate`
121
- *
122
- * If a value is left out, the lowest of other cacheLife() calls or the default, is used instead.
123
- */
124
- export function unstable_cacheLife(profile: {
125
- /**
126
- * This cache may be stale on clients for ... seconds before checking with the server.
127
- */
128
- stale?: number,
129
- /**
130
- * If the server receives a new request after ... seconds, start revalidating new values in the background.
131
- */
132
- revalidate?: number,
133
- /**
134
- * If this entry has no traffic for ... seconds it will expire. The next request will recompute it.
135
- */
136
- expire?: number
137
- }): void
138
-
139
-
140
- export { cacheTag as unstable_cacheTag } from 'next/dist/server/use-cache/cache-tag'
141
- }
@@ -1 +0,0 @@
1
- {"type": "module"}
@@ -1,55 +0,0 @@
1
- // This file is generated automatically by Next.js
2
- // Do not edit this file manually
3
-
4
- type AppRoutes = never
5
- type PageRoutes = never
6
- type LayoutRoutes = never
7
- type RedirectRoutes = never
8
- type RewriteRoutes = never
9
- type Routes = AppRoutes | PageRoutes | LayoutRoutes | RedirectRoutes | RewriteRoutes
10
-
11
-
12
- interface ParamMap {
13
- }
14
-
15
-
16
- export type ParamsOf<Route extends Routes> = ParamMap[Route]
17
-
18
- interface LayoutSlotMap {
19
- }
20
-
21
-
22
- export type { AppRoutes, PageRoutes, LayoutRoutes, RedirectRoutes, RewriteRoutes, ParamMap }
23
-
24
- declare global {
25
- /**
26
- * Props for Next.js App Router page components
27
- * @example
28
- * ```tsx
29
- * export default function Page(props: PageProps<'/blog/[slug]'>) {
30
- * const { slug } = await props.params
31
- * return <div>Blog post: {slug}</div>
32
- * }
33
- * ```
34
- */
35
- interface PageProps<AppRoute extends AppRoutes> {
36
- params: Promise<ParamMap[AppRoute]>
37
- searchParams: Promise<Record<string, string | string[] | undefined>>
38
- }
39
-
40
- /**
41
- * Props for Next.js App Router layout components
42
- * @example
43
- * ```tsx
44
- * export default function Layout(props: LayoutProps<'/dashboard'>) {
45
- * return <div>{props.children}</div>
46
- * }
47
- * ```
48
- */
49
- type LayoutProps<LayoutRoute extends LayoutRoutes> = {
50
- params: Promise<ParamMap[LayoutRoute]>
51
- children: React.ReactNode
52
- } & {
53
- [K in LayoutSlotMap[LayoutRoute]]: React.ReactNode
54
- }
55
- }
@@ -1,134 +0,0 @@
1
- import fs from 'node:fs'
2
- import path from 'node:path'
3
- import readline from 'node:readline'
4
- import * as styles from '../utils/styles.js'
5
-
6
- export const name = 'numbering'
7
-
8
- const SUFFIX_RE = /-(\d+)$/
9
-
10
- function prompt(question) {
11
- const rl = readline.createInterface({ input: process.stdin, output: process.stdout })
12
- return new Promise((resolve) => {
13
- rl.question(question, (answer) => {
14
- rl.close()
15
- resolve(answer.trim().toLowerCase())
16
- })
17
- })
18
- }
19
-
20
- function updateOrderYaml(fromPath, toPath) {
21
- const dir = path.dirname(fromPath)
22
- const orderFile = path.join(dir, '_order.yaml')
23
- if (!fs.existsSync(orderFile)) return
24
-
25
- const oldSlug = path.basename(fromPath).replace(/\.(md|mdx)$/, '')
26
- const newSlug = path.basename(toPath).replace(/\.(md|mdx)$/, '')
27
-
28
- const content = fs.readFileSync(orderFile, 'utf-8')
29
- const updated = content.replace(new RegExp(`^(- )${oldSlug.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}$`, 'm'), `$1${newSlug}`)
30
-
31
- if (updated !== content) {
32
- fs.writeFileSync(orderFile, updated)
33
- }
34
- }
35
-
36
- export async function validateAll(files, gitRoot, { fix, nonInteractive } = {}) {
37
- const results = []
38
- const renames = []
39
-
40
- // Collect all slugs (filenames without ext) and directory names across the repo.
41
- const allSlugs = new Set()
42
- const allDirs = new Set()
43
- for (const relPath of files) {
44
- allSlugs.add(path.basename(relPath).replace(/\.(md|mdx)$/, ''))
45
- const parts = relPath.split('/')
46
- for (let i = 0; i < parts.length - 1; i++) {
47
- allDirs.add(parts[i])
48
- }
49
- }
50
-
51
- // Check files: if slug ends with -N and the base slug doesn't exist anywhere, warn.
52
- for (const relPath of files) {
53
- const slug = path.basename(relPath).replace(/\.(md|mdx)$/, '')
54
- const match = slug.match(SUFFIX_RE)
55
- if (!match) continue
56
-
57
- const baseSlug = slug.slice(0, -match[0].length)
58
- if (!allSlugs.has(baseSlug)) {
59
- const ext = path.extname(relPath)
60
- const from = path.join(gitRoot, relPath)
61
- const toRel = path.join(path.dirname(relPath), `${baseSlug}${ext}`)
62
- const to = path.join(gitRoot, toRel)
63
-
64
- results.push({
65
- file: relPath,
66
- rule: name,
67
- severity: 'warning',
68
- fixable: true,
69
- message: `Unnecessary suffix: "${slug}${ext}" should be renamed to "${baseSlug}${ext}"`,
70
- })
71
- renames.push({ from, to, label: `${relPath} → ${toRel}` })
72
- }
73
- }
74
-
75
- // Check directories: if a dir name ends with -N and the base dir doesn't exist, warn.
76
- const warnedDirs = new Set()
77
- for (const relPath of files) {
78
- const parts = relPath.split('/')
79
- for (let i = 0; i < parts.length - 1; i++) {
80
- const dirName = parts[i]
81
- if (warnedDirs.has(dirName)) continue
82
-
83
- const match = dirName.match(SUFFIX_RE)
84
- if (!match) continue
85
-
86
- const baseName = dirName.slice(0, -match[0].length)
87
- if (!allDirs.has(baseName)) {
88
- warnedDirs.add(dirName)
89
- const dirPath = parts.slice(0, i + 1).join('/')
90
- const baseDirPath = [...parts.slice(0, i), baseName].join('/')
91
- const from = path.join(gitRoot, dirPath)
92
- const to = path.join(gitRoot, baseDirPath)
93
-
94
- results.push({
95
- file: dirPath,
96
- rule: name,
97
- severity: 'warning',
98
- fixable: true,
99
- message: `Unnecessary suffix: "${dirName}" folder should be renamed to "${baseName}"`,
100
- })
101
- renames.push({ from, to, label: `${dirPath}/ → ${baseDirPath}/` })
102
- }
103
- }
104
- }
105
-
106
- // Interactive rename when --fix is passed.
107
- if (fix && renames.length > 0) {
108
- console.log()
109
- console.log(` The following will be renamed:`)
110
- for (const r of renames) {
111
- console.log(` ${styles.dim(r.label)}`)
112
- }
113
- console.log()
114
- console.log(` ${styles.warn('Note:')} Renaming changes slugs, which could break existing URLs.`)
115
- console.log()
116
-
117
- // assume yes if non-interactive, otherwise prompt for confirmation
118
- const answer = nonInteractive ? 'yes' : await prompt(` Rename ${renames.length} ${renames.length === 1 ? 'path' : 'paths'}? (y/N) `)
119
-
120
- if (answer === 'y' || answer === 'yes') {
121
- // Sort longest path first so nested dirs get renamed before parents.
122
- renames.sort((a, b) => b.from.length - a.from.length)
123
- for (const r of renames) {
124
- fs.renameSync(r.from, r.to)
125
- updateOrderYaml(r.from, r.to)
126
- }
127
- for (const r of results) {
128
- r.message += ' (fixed)'
129
- }
130
- }
131
- }
132
-
133
- return results.length > 0 ? results : null
134
- }