Skip to content

Conversation

@mrazauskas
Copy link
Contributor

Type

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Similar to Effect-TS/effect#5498.

Only config file had to be updated here. Simple (;

@github-actions
Copy link

github-actions bot commented Sep 12, 2025

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 5.93 KB 5.93 KB 0.00 KB (0.00%)
bundle/batching.ts 8.12 KB 8.12 KB 0.00 KB (0.00%)
bundle/brand.ts 6.16 KB 6.16 KB 0.00 KB (0.00%)
bundle/cache.ts 9.29 KB 9.29 KB 0.00 KB (0.00%)
bundle/config.ts 15.42 KB 15.42 KB 0.00 KB (0.00%)
bundle/http-client.ts 18.23 KB 18.23 KB 0.00 KB (0.00%)
bundle/logger.ts 8.40 KB 8.40 KB 0.00 KB (0.00%)
bundle/metric.ts 8.46 KB 8.46 KB 0.00 KB (0.00%)
bundle/pubsub.ts 12.77 KB 12.77 KB 0.00 KB (0.00%)
bundle/queue.ts 10.67 KB 10.67 KB 0.00 KB (0.00%)
bundle/schedule.ts 9.11 KB 9.11 KB 0.00 KB (0.00%)
bundle/schema-arbitrary.ts 15.54 KB 15.54 KB 0.00 KB (0.00%)
bundle/schema-equivalence.ts 14.56 KB 14.56 KB 0.00 KB (0.00%)
bundle/schema-format.ts 14.63 KB 14.63 KB 0.00 KB (0.00%)
bundle/schema-json-schema.ts 15.87 KB 15.87 KB 0.00 KB (0.00%)
bundle/schema-record-literals-key.ts 12.93 KB 12.93 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 11.12 KB 11.12 KB 0.00 KB (0.00%)
bundle/schema-string-check.ts 9.96 KB 9.96 KB 0.00 KB (0.00%)
bundle/schema-string.ts 9.53 KB 9.53 KB 0.00 KB (0.00%)
bundle/schema-stringLeafJson.ts 14.32 KB 14.32 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 11.91 KB 11.91 KB 0.00 KB (0.00%)
bundle/schema.ts 14.02 KB 14.02 KB 0.00 KB (0.00%)
bundle/stm.ts 11.49 KB 11.49 KB 0.00 KB (0.00%)
bundle/stream.ts 8.09 KB 8.09 KB 0.00 KB (0.00%)

@github-actions
Copy link

github-actions bot commented Sep 12, 2025

📊 JSDoc Documentation Analysis

📈 Current Analysis Results
Analyzing 48 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

============================================================
         EFFECT JSDOC ANALYSIS REPORT
============================================================

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 48
Total exported members: 1397
Missing @example: 790 (56.5%)
Missing @category: 308 (22.0%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. schema/Schema.ts
   📝 265 missing examples, 🏷️  199 missing categories
   📦 265 total exports
2. schema/AST.ts
   📝 69 missing examples, 🏷️  15 missing categories
   📦 69 total exports
3. schema/Check.ts
   📝 62 missing examples, 🏷️  4 missing categories
   📦 62 total exports
4. schema/Getter.ts
   📝 43 missing examples, 🏷️  3 missing categories
   📦 43 total exports
5. PubSub.ts
   📝 25 missing examples, 🏷️  16 missing categories
   📦 37 total exports
6. config/Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
7. schema/ToJsonSchema.ts
   📝 18 missing examples, 🏷️  18 missing categories
   📦 18 total exports
8. schema/Transformation.ts
   📝 24 missing examples, 🏷️  12 missing categories
   📦 24 total exports
9. schema/ToArbitrary.ts
   📝 15 missing examples, 🏷️  15 missing categories
   📦 15 total exports
10. Effect.ts
   📝 24 missing examples, 🏷️  1 missing categories
   📦 227 total exports
11. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
12. schema/ToParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
13. config/ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports
14. Cause.ts
   📝 21 missing examples, 🏷️  0 missing categories
   📦 62 total exports
15. schema/Issue.ts
   📝 15 missing examples, 🏷️  2 missing categories
   📦 15 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   Function.ts (24 exports)
   MutableRef.ts (17 exports)
   RcRef.ts (5 exports)
   Runtime.ts (3 exports)
   Schedule.ts (49 exports)
   index.ts (0 exports)
   schema/index.ts (0 exports)
   config/index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM schema/Schema.ts
-----------------------------------
   MakeOptions (interface, line 58): missing example, category
   Bottom (interface, line 84): missing example, category
   revealBottom (function, line 141): missing example, category
   annotate (function, line 170): missing example
   annotateKey (function, line 184): missing example
   Top (interface, line 275): missing example, category
   Schema (namespace, line 297): missing example, category
   Type (type, line 301): missing example, category
   Schema (interface, line 307): missing example, category
   Codec (namespace, line 315): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 275 missing examples, 75 missing categories
class: 52 missing examples, 3 missing categories
namespace: 23 missing examples, 14 missing categories
interface: 135 missing examples, 97 missing categories
type: 96 missing examples, 64 missing categories
function: 209 missing examples, 55 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 607/1397 (43.5% complete)
Categories: 1089/1397 (78.0% complete)

============================================================
Analysis complete! 1098 items need attention.
============================================================

📄 Detailed results saved to: jsdoc-analysis-results.json

This comment is automatically updated on each push. View the analysis script for details.

@gcanti gcanti merged commit 9bc1920 into Effect-TS:main Sep 15, 2025
13 checks passed
@gcanti
Copy link
Contributor

gcanti commented Sep 15, 2025

Thanks @mrazauskas !

@mrazauskas mrazauskas deleted the update-tstyche branch September 15, 2025 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants