Skip to content

Conversation

@mikearnaldi
Copy link
Member

No description provided.

@github-actions
Copy link

github-actions bot commented Oct 7, 2025

📊 JSDoc Documentation Analysis

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

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

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 69
Total exported members: 2074
Missing @example: 953 (45.9%)
Missing @category: 351 (16.9%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. schema/Schema.ts
   📝 293 missing examples, 🏷️  210 missing categories
   📦 293 total exports
2. schema/AST.ts
   📝 70 missing examples, 🏷️  16 missing categories
   📦 70 total exports
3. schema/Check.ts
   📝 67 missing examples, 🏷️  9 missing categories
   📦 67 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.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. Cause.ts
   📝 28 missing examples, 🏷️  2 missing categories
   📦 69 total exports
10. schema/ToArbitrary.ts
   📝 14 missing examples, 🏷️  14 missing categories
   📦 14 total exports
11. Effect.ts
   📝 24 missing examples, 🏷️  1 missing categories
   📦 227 total exports
12. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
13. schema/Issue.ts
   📝 22 missing examples, 🏷️  2 missing categories
   📦 22 total exports
14. schema/ToParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
15. ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Clock.ts (5 exports)
   Console.ts (21 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   Match.ts (57 exports)
   MutableRef.ts (17 exports)
   RcRef.ts (5 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Schedule.ts (49 exports)
   Symbol.ts (1 exports)
   index.ts (0 exports)
   schema/index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM schema/Schema.ts
-----------------------------------
   Optionality (type, line 43): missing example, category
   Mutability (type, line 50): missing example, category
   ConstructorDefault (type, line 57): missing example, category
   MakeOptions (interface, line 65): missing example, category
   Bottom (interface, line 89): missing example, category
   revealBottom (function, line 172): missing example, category
   annotate (function, line 202): missing example
   annotateKey (function, line 216): missing example
   Top (interface, line 225): missing example, category
   Schema (namespace, line 248): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
type: 121 missing examples, 69 missing categories
const: 363 missing examples, 95 missing categories
interface: 161 missing examples, 100 missing categories
class: 54 missing examples, 3 missing categories
function: 228 missing examples, 70 missing categories
namespace: 26 missing examples, 14 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 1121/2074 (54.1% complete)
Categories: 1723/2074 (83.1% complete)

============================================================
Analysis complete! 1304 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.

@github-actions
Copy link

github-actions bot commented Oct 7, 2025

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 6.05 KB 6.05 KB 0.00 KB (0.00%)
bundle/batching.ts 8.28 KB 8.28 KB 0.00 KB (0.00%)
bundle/brand.ts 6.35 KB 6.35 KB 0.00 KB (0.00%)
bundle/cache.ts 9.41 KB 9.41 KB 0.00 KB (0.00%)
bundle/config.ts 15.93 KB 15.93 KB 0.00 KB (0.00%)
bundle/differ.ts 13.76 KB 13.76 KB 0.00 KB (0.00%)
bundle/http-client.ts 18.34 KB 18.34 KB 0.00 KB (0.00%)
bundle/logger.ts 8.56 KB 8.56 KB 0.00 KB (0.00%)
bundle/metric.ts 8.58 KB 8.58 KB 0.00 KB (0.00%)
bundle/optic.ts 7.24 KB 7.24 KB 0.00 KB (0.00%)
bundle/pubsub.ts 12.90 KB 12.90 KB 0.00 KB (0.00%)
bundle/queue.ts 10.81 KB 10.81 KB 0.00 KB (0.00%)
bundle/schedule.ts 9.26 KB 9.26 KB 0.00 KB (0.00%)
bundle/schema-arbitrary.ts 15.76 KB 15.76 KB 0.00 KB (0.00%)
bundle/schema-equivalence.ts 14.86 KB 14.86 KB 0.00 KB (0.00%)
bundle/schema-format.ts 14.94 KB 14.94 KB 0.00 KB (0.00%)
bundle/schema-json-schema.ts 16.23 KB 16.23 KB 0.00 KB (0.00%)
bundle/schema-record-literals-key.ts 13.19 KB 13.19 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 11.21 KB 11.21 KB 0.00 KB (0.00%)
bundle/schema-string-check.ts 9.99 KB 9.99 KB 0.00 KB (0.00%)
bundle/schema-string.ts 9.56 KB 9.56 KB 0.00 KB (0.00%)
bundle/schema-stringPojo.ts 14.75 KB 14.75 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 12.05 KB 12.05 KB 0.00 KB (0.00%)
bundle/schema.ts 14.37 KB 14.37 KB 0.00 KB (0.00%)
bundle/stm.ts 11.66 KB 11.66 KB 0.00 KB (0.00%)
bundle/stream.ts 8.23 KB 8.23 KB 0.00 KB (0.00%)

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