-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathsidekick.yaml
169 lines (169 loc) · 6.39 KB
/
sidekick.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
- type: folder
name: app
path: /app
files:
- type: folder
name: src
path: /app/src
files:
- type: folder
name: utils
path: /app/src/utils
files:
- type: file
name: common.ts
path: /app/src/utils/common.ts
summary: A function that merges two objects into one
languages: TypeScript
imports: []
functions:
- number: 1
name: mergeObjects
summary: Merges two objects into one
return: Record<string, any>
- type: file
name: slugify.ts
path: /app/src/utils/slugify.ts
summary: >-
A function that takes a string and returns a slugified version
of it
languages: TypeScript
imports: []
functions:
- number: 1
name: slugify
summary: Takes a string and returns a slugified version of it
- type: file
name: link.ts
path: /app/src/utils/link.ts
summary: >-
Defines a single function to extract the directory from a given
link.
languages: TypeScript
imports: []
functions:
- number: 1
name: getLinkDirectory
summary: Extracts directory from a given link.
return: string
- type: file
name: async.ts
path: /app/src/utils/async.ts
summary: >-
Defines a function to limit the number of promises that can be
executed concurrently
languages: TypeScript
imports: []
functions:
- number: 1
name: mapLimit
summary: >-
Limits the number of promises that can be executed
concurrently
return: Promise<R[]>
- type: file
name: color.ts
path: /app/src/utils/color.ts
summary: >-
Defines a function to get the contrast color of a given
background color.
languages: TypeScript
imports:
- name: tinycolor2
type: library
functions:
- number: 1
name: getContrastColor
return: string
summary: Returns the contrast color of a given background color.
- type: file
name: async_caller.ts
path: /app/src/utils/async_caller.ts
summary: >-
A class that can be used to make async calls with concurrency
and retry logic.
languages: TypeScript
imports:
- p-retry
- p-queue
functions:
- number: 1
name: AsyncCaller
summary: >-
A class that can be used to make async calls with
concurrency and retry logic.
- number: 2
name: call
summary: A function that makes an async call with retry logic.
- number: 3
name: fetch
summary: A function that makes an async call to fetch data.
- type: file
name: license.ts
path: /app/src/utils/license.ts
summary: >-
Contains functions to check if an organization is above a
certain plan, if it is paid, and to get limits based on a plan
languages: TypeScript
imports:
- '@prisma/client'
functions:
- number: 1
name: isAbovePro
summary: Checks if an organization is above the professional plan
return: boolean
- number: 2
name: isPaid
summary: Checks if an organization is paid
return: boolean
- number: 3
name: getLimits
summary: Returns limits based on a plan
return: object
- type: file
name: api.ts
path: /app/src/utils/api.ts
summary: >-
Creates a client-side entrypoint for tRPC API, creates type-safe
React Query hooks, and inference helpers for input and output
types.
languages: TypeScript
imports:
- '@trpc/client'
- '@trpc/next'
- '@trpc/server'
- react-hot-toast
- superjson
- cors
- ~/server/api/root
- next
functions:
- number: 1
name: api
summary: >-
Creates a set of type-safe react-query hooks for your tRPC
API.
- number: 2
name: RouterInputs
summary: Inference helper for inputs.
- number: 3
name: RouterOutputs
summary: Inference helper for outputs.
- number: 4
name: runCorsMiddleware
summary: Runs CORS middleware.
summary: >-
The /app/src/utils folder contains various utility files for
functions such as merging objects, slugifying strings, extracting
directories, limiting promises, handling colors, making async calls,
managing licenses, and creating API entrypoints.
summary: >-
The /app/src folder contains the utils subfolder, which includes utility
files for various functions like object merging, string slugifying,
directory extraction, promise limiting, color handling, async calls,
license management, and API entrypoint creation.
summary: >-
The /app folder contains the /app/src folder with a utils subfolder, housing
utility files for functions like object merging, slugifying, directory
extraction, promise limiting, color handling, async calls, license
management, and API entrypoint creation.