Skip to content

Visualize Your Ideas With Code

docs: add deprecation support (#131)

Jacob9d1b6041a43b
diff --git a/packages/core/src/utils/deprecate.ts b/packages/core/src/utils/deprecate.ts
index 1f8ed5da..8052548a 100644
--- a/packages/core/src/utils/deprecate.ts
+++ b/packages/core/src/utils/deprecate.ts
@@ -7,12 +7,12 @@ import {useLogger} from './useProject';
* @param message - The log message.
* @param remarks - The optional log remarks.
*/
-export function deprecate<TArgs extends any[], TThis, TReturn>(
- fn: (this: TThis, ...args: TArgs) => TReturn,
+export function deprecate<TArgs extends any[], TReturn>(
+ fn: (...args: TArgs) => TReturn,
message: string,
remarks?: string,
-): (this: TThis, ...args: TArgs) => TReturn {
- return function (...args) {
+): (...args: TArgs) => TReturn {
+ return function (this: any, ...args) {
useLogger().warn({message, remarks, stack: new Error().stack});
return fn.apply(this, args);
};
diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
index edc2b672..3d5b86d1 100644
--- a/packages/core/src/utils/index.ts
+++ b/packages/core/src/utils/index.ts
@@ -27,6 +27,7 @@ import {
} from '../signals';
/**
+ * @internal
* @deprecated Use {@link createRef} instead.
*/
const useRef = deprecate(
@@ -37,6 +38,7 @@ const useRef = deprecate(
);
/**
+ * @internal
* @deprecated Use {@link createSignal} instead.
*/
const createSignal = deprecate(
@@ -47,6 +49,7 @@ const createSignal = deprecate(
);
/**
+ * @internal
* @deprecated Use {@link createComputed} instead.
*/
const createComputed = deprecate(
diff --git a/packages/docs/src/components/Api/Comment/index.tsx b/packages/docs/src/components/Api/Comment/index.tsx
index e6a69128..e4d04616 100644
--- a/packages/docs/src/components/Api/Comment/index.tsx
+++ b/packages/docs/src/components/Api/Comment/index.tsx
@@ -17,16 +17,20 @@ export default function Comment({
<>
<Summary id={comment?.summaryId} />
<Summary id={remarks?.contentId} />
- {full && <ExamplesAndSeeAlso comment={comment} />}
+ {full && <FullComment comment={comment} />}
</>
);
}
-function ExamplesAndSeeAlso({comment}: {comment: JSONOutput.Comment}) {
+function FullComment({comment}: {comment: JSONOutput.Comment}) {
const examples = useMemo(
() => comment?.blockTags?.filter(({tag}) => tag === '@example') ?? [],
[comment],
);
+ const deprecated = useMemo(
+ () => comment?.blockTags?.find(({tag}) => tag === '@deprecated'),
+ [comment],
+ );
const seeAlso = useMemo(
() => comment?.blockTags?.find(({tag}) => tag === '@see'),
[comment],
@@ -42,6 +46,12 @@ function ExamplesAndSeeAlso({comment}: {comment: JSONOutput.Comment}) {
))}
</>
)}
+ {deprecated && (
+ <>
+ <h4>Deprecated</h4>
+ <Summary id={deprecated.contentId} />
+ </>
+ )}
{seeAlso && (
<>
<h4>See also</h4>
diff --git a/packages/docs/src/components/Api/Type/NamedTupleMemberType.tsx b/packages/docs/src/components/Api/Type/NamedTupleMemberType.tsx
new file mode 100644
index 00000000..218ef810
--- /dev/null
+++ b/packages/docs/src/components/Api/Type/NamedTupleMemberType.tsx
@@ -0,0 +1,16 @@
+import React from 'react';
+
+import type {JSONOutput} from 'typedoc';
+import Type from '@site/src/components/Api/Type';
+
+export default function NamedTupleMemberType({
+ type,
+}: {
+ type: JSONOutput.NamedTupleMemberType;
+}) {
+ return (
+ <>
+ {type.name}: <Type type={type.element} />
+ </>
+ );
+}
diff --git a/packages/docs/src/components/Api/Type/TupleType.tsx b/packages/docs/src/components/Api/Type/TupleType.tsx
index 92e6cf83..efa35d5f 100644
--- a/packages/docs/src/components/Api/Type/TupleType.tsx
+++ b/packages/docs/src/components/Api/Type/TupleType.tsx
@@ -5,11 +5,13 @@ import Type from '@site/src/components/Api/Type';
import TokenList, {ListType} from '@site/src/components/Api/Code/TokenList';
export default function TupleType({type}: {type: JSONOutput.TupleType}) {
- return (
+ return type.elements ? (
<TokenList type={ListType.Square}>
{type.elements.map((type, index) => (
<Type key={index} type={type} />
))}
</TokenList>
+ ) : (
+ <>[]</>
);
}
diff --git a/packages/docs/src/components/Api/Type/index.tsx b/packages/docs/src/components/Api/Type/index.tsx
index 593a3991..a268fd47 100644
--- a/packages/docs/src/components/Api/Type/index.tsx
+++ b/packages/docs/src/components/Api/Type/index.tsx
@@ -15,6 +15,7 @@ import InferredType from '@site/src/components/Api/Type/InferredType';
import IndexedAccessType from '@site/src/components/Api/Type/IndexedAccessType';
import TypeOperatorType from '@site/src/components/Api/Type/TypeOperatorType';
import MappedType from '@site/src/components/Api/Type/MappedType';
+import NamedTupleMemberType from '@site/src/components/Api/Type/NamedTupleMemberType';
import type {JSONOutput} from 'typedoc';
export interface CodeTypeProps {
@@ -35,7 +36,7 @@ export default function CodeType(props: CodeTypeProps) {
case 'query':
return QueryType;
case 'named-tuple-member':
- break;
+ return NamedTupleMemberType;
case 'optional':
break;
case 'union':