@storm-software/tsdoc 0.5.1 → 0.5.3

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.
package/README.md CHANGED
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
21
21
 
22
22
  <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
23
23
 
24
- [![Version](https://img.shields.io/badge/version-0.4.13-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
24
+ [![Version](https://img.shields.io/badge/version-0.5.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25
25
 
26
26
  <!-- prettier-ignore-start -->
27
27
  <!-- markdownlint-disable -->
package/config/core.json CHANGED
@@ -1,239 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
- "extends": ["./base.json", "./api-extractor.json", "./typedoc.json"],
4
- "noStandardTags": false,
5
- "tagDefinitions": [
6
- {
7
- "tagName": "@author",
8
- "syntaxKind": "block"
9
- },
10
- {
11
- "tagName": "@module",
12
- "syntaxKind": "block"
13
- },
14
- {
15
- "tagName": "@mergeModuleWith",
16
- "syntaxKind": "block"
17
- },
18
- {
19
- "tagName": "@type",
20
- "syntaxKind": "block"
21
- },
22
- {
23
- "tagName": "@typedef",
24
- "syntaxKind": "block"
25
- },
26
- {
27
- "tagName": "@callback",
28
- "syntaxKind": "block"
29
- },
30
- {
31
- "tagName": "@prop",
32
- "syntaxKind": "block",
33
- "allowMultiple": true
34
- },
35
- {
36
- "tagName": "@property",
37
- "syntaxKind": "block",
38
- "allowMultiple": true
39
- },
40
- {
41
- "tagName": "@group",
42
- "syntaxKind": "block",
43
- "allowMultiple": true
44
- },
45
- {
46
- "tagName": "@groupDescription",
47
- "syntaxKind": "block",
48
- "allowMultiple": true
49
- },
50
- {
51
- "tagName": "@disableGroups",
52
- "syntaxKind": "modifier",
53
- "allowMultiple": false
54
- },
55
- {
56
- "tagName": "@category",
57
- "syntaxKind": "block",
58
- "allowMultiple": true
59
- },
60
- {
61
- "tagName": "@categoryDescription",
62
- "syntaxKind": "block",
63
- "allowMultiple": true
64
- },
65
- {
66
- "tagName": "@hidden",
67
- "syntaxKind": "modifier"
68
- },
69
- {
70
- "tagName": "@ignore",
71
- "syntaxKind": "modifier"
72
- },
73
- {
74
- "tagName": "@class",
75
- "syntaxKind": "modifier"
76
- },
77
- {
78
- "tagName": "@abstract",
79
- "syntaxKind": "modifier"
80
- },
81
- {
82
- "tagName": "@document",
83
- "syntaxKind": "block"
84
- },
85
- {
86
- "tagName": "@default",
87
- "syntaxKind": "block"
88
- },
89
- {
90
- "tagName": "@extends",
91
- "syntaxKind": "block"
92
- },
93
- {
94
- "tagName": "@augments",
95
- "syntaxKind": "block"
96
- },
97
- {
98
- "tagName": "@return",
99
- "syntaxKind": "block"
100
- },
101
- {
102
- "tagName": "@yields",
103
- "syntaxKind": "block"
104
- },
105
- {
106
- "tagName": "@enum",
107
- "syntaxKind": "modifier"
108
- },
109
- {
110
- "tagName": "@event",
111
- "syntaxKind": "modifier"
112
- },
113
- {
114
- "tagName": "@expand",
115
- "syntaxKind": "modifier"
116
- },
117
- {
118
- "tagName": "@preventExpand",
119
- "syntaxKind": "block"
120
- },
121
- {
122
- "tagName": "@expandType",
123
- "syntaxKind": "block"
124
- },
125
- {
126
- "tagName": "@inline",
127
- "syntaxKind": "modifier"
128
- },
129
- {
130
- "tagName": "@preventInline",
131
- "syntaxKind": "block"
132
- },
133
- {
134
- "tagName": "@inlineType",
135
- "syntaxKind": "block"
136
- },
137
- {
138
- "tagName": "@primaryExport",
139
- "syntaxKind": "modifier"
140
- },
141
- {
142
- "tagName": "@template",
143
- "syntaxKind": "block",
144
- "allowMultiple": true
145
- },
146
- {
147
- "tagName": "@linkcode",
148
- "syntaxKind": "inline",
149
- "allowMultiple": true
150
- },
151
- {
152
- "tagName": "@linkplain",
153
- "syntaxKind": "inline",
154
- "allowMultiple": true
155
- },
156
- {
157
- "tagName": "@include",
158
- "syntaxKind": "inline",
159
- "allowMultiple": true
160
- },
161
- {
162
- "tagName": "@includeCode",
163
- "syntaxKind": "inline",
164
- "allowMultiple": true
165
- },
166
- {
167
- "tagName": "@private",
168
- "syntaxKind": "modifier"
169
- },
170
- {
171
- "tagName": "@protected",
172
- "syntaxKind": "modifier"
173
- },
174
- {
175
- "tagName": "@satisfies",
176
- "syntaxKind": "block"
177
- },
178
- {
179
- "tagName": "@since",
180
- "syntaxKind": "block"
181
- },
182
- {
183
- "tagName": "@license",
184
- "syntaxKind": "block"
185
- },
186
- {
187
- "tagName": "@import",
188
- "syntaxKind": "block"
189
- },
190
- {
191
- "tagName": "@overload",
192
- "syntaxKind": "modifier"
193
- },
194
- {
195
- "tagName": "@namespace",
196
- "syntaxKind": "modifier"
197
- },
198
- {
199
- "tagName": "@interface",
200
- "syntaxKind": "modifier"
201
- },
202
- {
203
- "tagName": "@function",
204
- "syntaxKind": "modifier"
205
- },
206
- {
207
- "tagName": "@showCategories",
208
- "syntaxKind": "modifier"
209
- },
210
- {
211
- "tagName": "@hideCategories",
212
- "syntaxKind": "modifier"
213
- },
214
- {
215
- "tagName": "@showGroups",
216
- "syntaxKind": "modifier"
217
- },
218
- {
219
- "tagName": "@hideGroups",
220
- "syntaxKind": "modifier"
221
- },
222
- {
223
- "tagName": "@hideconstructor",
224
- "syntaxKind": "modifier"
225
- },
226
- {
227
- "tagName": "@jsx",
228
- "syntaxKind": "block"
229
- },
230
- {
231
- "tagName": "@summary",
232
- "syntaxKind": "block"
233
- },
234
- {
235
- "tagName": "@useDeclaredType",
236
- "syntaxKind": "modifier"
237
- }
238
- ]
3
+ "extends": ["./base.json", "./api-extractor.json", "./typedoc.json"]
239
4
  }
package/dist/index.cjs CHANGED
@@ -90,242 +90,7 @@ var callouts_default = {
90
90
  // src/core.json
91
91
  var core_default = {
92
92
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
93
- extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
94
- noStandardTags: false,
95
- tagDefinitions: [
96
- {
97
- tagName: "@author",
98
- syntaxKind: "block"
99
- },
100
- {
101
- tagName: "@module",
102
- syntaxKind: "block"
103
- },
104
- {
105
- tagName: "@mergeModuleWith",
106
- syntaxKind: "block"
107
- },
108
- {
109
- tagName: "@type",
110
- syntaxKind: "block"
111
- },
112
- {
113
- tagName: "@typedef",
114
- syntaxKind: "block"
115
- },
116
- {
117
- tagName: "@callback",
118
- syntaxKind: "block"
119
- },
120
- {
121
- tagName: "@prop",
122
- syntaxKind: "block",
123
- allowMultiple: true
124
- },
125
- {
126
- tagName: "@property",
127
- syntaxKind: "block",
128
- allowMultiple: true
129
- },
130
- {
131
- tagName: "@group",
132
- syntaxKind: "block",
133
- allowMultiple: true
134
- },
135
- {
136
- tagName: "@groupDescription",
137
- syntaxKind: "block",
138
- allowMultiple: true
139
- },
140
- {
141
- tagName: "@disableGroups",
142
- syntaxKind: "modifier",
143
- allowMultiple: false
144
- },
145
- {
146
- tagName: "@category",
147
- syntaxKind: "block",
148
- allowMultiple: true
149
- },
150
- {
151
- tagName: "@categoryDescription",
152
- syntaxKind: "block",
153
- allowMultiple: true
154
- },
155
- {
156
- tagName: "@hidden",
157
- syntaxKind: "modifier"
158
- },
159
- {
160
- tagName: "@ignore",
161
- syntaxKind: "modifier"
162
- },
163
- {
164
- tagName: "@class",
165
- syntaxKind: "modifier"
166
- },
167
- {
168
- tagName: "@abstract",
169
- syntaxKind: "modifier"
170
- },
171
- {
172
- tagName: "@document",
173
- syntaxKind: "block"
174
- },
175
- {
176
- tagName: "@default",
177
- syntaxKind: "block"
178
- },
179
- {
180
- tagName: "@extends",
181
- syntaxKind: "block"
182
- },
183
- {
184
- tagName: "@augments",
185
- syntaxKind: "block"
186
- },
187
- {
188
- tagName: "@return",
189
- syntaxKind: "block"
190
- },
191
- {
192
- tagName: "@yields",
193
- syntaxKind: "block"
194
- },
195
- {
196
- tagName: "@enum",
197
- syntaxKind: "modifier"
198
- },
199
- {
200
- tagName: "@event",
201
- syntaxKind: "modifier"
202
- },
203
- {
204
- tagName: "@expand",
205
- syntaxKind: "modifier"
206
- },
207
- {
208
- tagName: "@preventExpand",
209
- syntaxKind: "block"
210
- },
211
- {
212
- tagName: "@expandType",
213
- syntaxKind: "block"
214
- },
215
- {
216
- tagName: "@inline",
217
- syntaxKind: "modifier"
218
- },
219
- {
220
- tagName: "@preventInline",
221
- syntaxKind: "block"
222
- },
223
- {
224
- tagName: "@inlineType",
225
- syntaxKind: "block"
226
- },
227
- {
228
- tagName: "@primaryExport",
229
- syntaxKind: "modifier"
230
- },
231
- {
232
- tagName: "@template",
233
- syntaxKind: "block",
234
- allowMultiple: true
235
- },
236
- {
237
- tagName: "@linkcode",
238
- syntaxKind: "inline",
239
- allowMultiple: true
240
- },
241
- {
242
- tagName: "@linkplain",
243
- syntaxKind: "inline",
244
- allowMultiple: true
245
- },
246
- {
247
- tagName: "@include",
248
- syntaxKind: "inline",
249
- allowMultiple: true
250
- },
251
- {
252
- tagName: "@includeCode",
253
- syntaxKind: "inline",
254
- allowMultiple: true
255
- },
256
- {
257
- tagName: "@private",
258
- syntaxKind: "modifier"
259
- },
260
- {
261
- tagName: "@protected",
262
- syntaxKind: "modifier"
263
- },
264
- {
265
- tagName: "@satisfies",
266
- syntaxKind: "block"
267
- },
268
- {
269
- tagName: "@since",
270
- syntaxKind: "block"
271
- },
272
- {
273
- tagName: "@license",
274
- syntaxKind: "block"
275
- },
276
- {
277
- tagName: "@import",
278
- syntaxKind: "block"
279
- },
280
- {
281
- tagName: "@overload",
282
- syntaxKind: "modifier"
283
- },
284
- {
285
- tagName: "@namespace",
286
- syntaxKind: "modifier"
287
- },
288
- {
289
- tagName: "@interface",
290
- syntaxKind: "modifier"
291
- },
292
- {
293
- tagName: "@function",
294
- syntaxKind: "modifier"
295
- },
296
- {
297
- tagName: "@showCategories",
298
- syntaxKind: "modifier"
299
- },
300
- {
301
- tagName: "@hideCategories",
302
- syntaxKind: "modifier"
303
- },
304
- {
305
- tagName: "@showGroups",
306
- syntaxKind: "modifier"
307
- },
308
- {
309
- tagName: "@hideGroups",
310
- syntaxKind: "modifier"
311
- },
312
- {
313
- tagName: "@hideconstructor",
314
- syntaxKind: "modifier"
315
- },
316
- {
317
- tagName: "@jsx",
318
- syntaxKind: "block"
319
- },
320
- {
321
- tagName: "@summary",
322
- syntaxKind: "block"
323
- },
324
- {
325
- tagName: "@useDeclaredType",
326
- syntaxKind: "modifier"
327
- }
328
- ]
93
+ extends: ["./base.json", "./api-extractor.json", "./typedoc.json"]
329
94
  };
330
95
 
331
96
  // src/recommended.json
package/dist/index.d.cts CHANGED
@@ -34,16 +34,6 @@ declare const configs: {
34
34
  readonly core: {
35
35
  $schema: string;
36
36
  extends: string[];
37
- noStandardTags: boolean;
38
- tagDefinitions: ({
39
- tagName: string;
40
- syntaxKind: string;
41
- allowMultiple?: undefined;
42
- } | {
43
- tagName: string;
44
- syntaxKind: string;
45
- allowMultiple: boolean;
46
- })[];
47
37
  };
48
38
  readonly callouts: {
49
39
  $schema: string;
package/dist/index.d.ts CHANGED
@@ -34,16 +34,6 @@ declare const configs: {
34
34
  readonly core: {
35
35
  $schema: string;
36
36
  extends: string[];
37
- noStandardTags: boolean;
38
- tagDefinitions: ({
39
- tagName: string;
40
- syntaxKind: string;
41
- allowMultiple?: undefined;
42
- } | {
43
- tagName: string;
44
- syntaxKind: string;
45
- allowMultiple: boolean;
46
- })[];
47
37
  };
48
38
  readonly callouts: {
49
39
  $schema: string;
package/dist/index.js CHANGED
@@ -63,242 +63,7 @@ var callouts_default = {
63
63
  // src/core.json
64
64
  var core_default = {
65
65
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
66
- extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
67
- noStandardTags: false,
68
- tagDefinitions: [
69
- {
70
- tagName: "@author",
71
- syntaxKind: "block"
72
- },
73
- {
74
- tagName: "@module",
75
- syntaxKind: "block"
76
- },
77
- {
78
- tagName: "@mergeModuleWith",
79
- syntaxKind: "block"
80
- },
81
- {
82
- tagName: "@type",
83
- syntaxKind: "block"
84
- },
85
- {
86
- tagName: "@typedef",
87
- syntaxKind: "block"
88
- },
89
- {
90
- tagName: "@callback",
91
- syntaxKind: "block"
92
- },
93
- {
94
- tagName: "@prop",
95
- syntaxKind: "block",
96
- allowMultiple: true
97
- },
98
- {
99
- tagName: "@property",
100
- syntaxKind: "block",
101
- allowMultiple: true
102
- },
103
- {
104
- tagName: "@group",
105
- syntaxKind: "block",
106
- allowMultiple: true
107
- },
108
- {
109
- tagName: "@groupDescription",
110
- syntaxKind: "block",
111
- allowMultiple: true
112
- },
113
- {
114
- tagName: "@disableGroups",
115
- syntaxKind: "modifier",
116
- allowMultiple: false
117
- },
118
- {
119
- tagName: "@category",
120
- syntaxKind: "block",
121
- allowMultiple: true
122
- },
123
- {
124
- tagName: "@categoryDescription",
125
- syntaxKind: "block",
126
- allowMultiple: true
127
- },
128
- {
129
- tagName: "@hidden",
130
- syntaxKind: "modifier"
131
- },
132
- {
133
- tagName: "@ignore",
134
- syntaxKind: "modifier"
135
- },
136
- {
137
- tagName: "@class",
138
- syntaxKind: "modifier"
139
- },
140
- {
141
- tagName: "@abstract",
142
- syntaxKind: "modifier"
143
- },
144
- {
145
- tagName: "@document",
146
- syntaxKind: "block"
147
- },
148
- {
149
- tagName: "@default",
150
- syntaxKind: "block"
151
- },
152
- {
153
- tagName: "@extends",
154
- syntaxKind: "block"
155
- },
156
- {
157
- tagName: "@augments",
158
- syntaxKind: "block"
159
- },
160
- {
161
- tagName: "@return",
162
- syntaxKind: "block"
163
- },
164
- {
165
- tagName: "@yields",
166
- syntaxKind: "block"
167
- },
168
- {
169
- tagName: "@enum",
170
- syntaxKind: "modifier"
171
- },
172
- {
173
- tagName: "@event",
174
- syntaxKind: "modifier"
175
- },
176
- {
177
- tagName: "@expand",
178
- syntaxKind: "modifier"
179
- },
180
- {
181
- tagName: "@preventExpand",
182
- syntaxKind: "block"
183
- },
184
- {
185
- tagName: "@expandType",
186
- syntaxKind: "block"
187
- },
188
- {
189
- tagName: "@inline",
190
- syntaxKind: "modifier"
191
- },
192
- {
193
- tagName: "@preventInline",
194
- syntaxKind: "block"
195
- },
196
- {
197
- tagName: "@inlineType",
198
- syntaxKind: "block"
199
- },
200
- {
201
- tagName: "@primaryExport",
202
- syntaxKind: "modifier"
203
- },
204
- {
205
- tagName: "@template",
206
- syntaxKind: "block",
207
- allowMultiple: true
208
- },
209
- {
210
- tagName: "@linkcode",
211
- syntaxKind: "inline",
212
- allowMultiple: true
213
- },
214
- {
215
- tagName: "@linkplain",
216
- syntaxKind: "inline",
217
- allowMultiple: true
218
- },
219
- {
220
- tagName: "@include",
221
- syntaxKind: "inline",
222
- allowMultiple: true
223
- },
224
- {
225
- tagName: "@includeCode",
226
- syntaxKind: "inline",
227
- allowMultiple: true
228
- },
229
- {
230
- tagName: "@private",
231
- syntaxKind: "modifier"
232
- },
233
- {
234
- tagName: "@protected",
235
- syntaxKind: "modifier"
236
- },
237
- {
238
- tagName: "@satisfies",
239
- syntaxKind: "block"
240
- },
241
- {
242
- tagName: "@since",
243
- syntaxKind: "block"
244
- },
245
- {
246
- tagName: "@license",
247
- syntaxKind: "block"
248
- },
249
- {
250
- tagName: "@import",
251
- syntaxKind: "block"
252
- },
253
- {
254
- tagName: "@overload",
255
- syntaxKind: "modifier"
256
- },
257
- {
258
- tagName: "@namespace",
259
- syntaxKind: "modifier"
260
- },
261
- {
262
- tagName: "@interface",
263
- syntaxKind: "modifier"
264
- },
265
- {
266
- tagName: "@function",
267
- syntaxKind: "modifier"
268
- },
269
- {
270
- tagName: "@showCategories",
271
- syntaxKind: "modifier"
272
- },
273
- {
274
- tagName: "@hideCategories",
275
- syntaxKind: "modifier"
276
- },
277
- {
278
- tagName: "@showGroups",
279
- syntaxKind: "modifier"
280
- },
281
- {
282
- tagName: "@hideGroups",
283
- syntaxKind: "modifier"
284
- },
285
- {
286
- tagName: "@hideconstructor",
287
- syntaxKind: "modifier"
288
- },
289
- {
290
- tagName: "@jsx",
291
- syntaxKind: "block"
292
- },
293
- {
294
- tagName: "@summary",
295
- syntaxKind: "block"
296
- },
297
- {
298
- tagName: "@useDeclaredType",
299
- syntaxKind: "modifier"
300
- }
301
- ]
66
+ extends: ["./base.json", "./api-extractor.json", "./typedoc.json"]
302
67
  };
303
68
 
304
69
  // src/recommended.json
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-software/tsdoc",
3
- "version": "0.5.1",
3
+ "version": "0.5.3",
4
4
  "type": "module",
5
5
  "description": "This package contains shared TSDoc configurations used in Storm Software projects.",
6
6
  "repository": {
@@ -87,5 +87,5 @@
87
87
  },
88
88
  "publishConfig": { "access": "public" },
89
89
  "sideEffects": false,
90
- "gitHead": "446803d73ec4fd31944e933c4965955bc744c0db"
90
+ "gitHead": "457c32063cb35e831f63fef9e40e5f881c5ffc26"
91
91
  }