Skip to content

Conversation

@fubhy
Copy link
Member

@fubhy fubhy commented Aug 31, 2025

Just experimenting atm. Not sure yet where this will go or whether it's a good idea. Could be handy for testing and for browser use-cases.

@github-actions
Copy link

github-actions bot commented Aug 31, 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: 1461
Missing @example: 825 (56.5%)
Missing @category: 320 (21.9%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. schema/Schema.ts
   📝 263 missing examples, 🏷️  198 missing categories
   📦 263 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. PubSub.ts
   📝 30 missing examples, 🏷️  17 missing categories
   📦 41 total exports
5. schema/Getter.ts
   📝 43 missing examples, 🏷️  3 missing categories
   📦 43 total exports
6. config/Config.ts
   📝 35 missing examples, 🏷️  5 missing categories
   📦 35 total exports
7. schema/ToJsonSchema.ts
   📝 18 missing examples, 🏷️  18 missing categories
   📦 18 total exports
8. Effect.ts
   📝 27 missing examples, 🏷️  8 missing categories
   📦 225 total exports
9. schema/Transformation.ts
   📝 22 missing examples, 🏷️  10 missing categories
   📦 22 total exports
10. schema/ToArbitrary.ts
   📝 15 missing examples, 🏷️  15 missing categories
   📦 15 total exports
11. SynchronizedRef.ts
   📝 26 missing examples, 🏷️  0 missing categories
   📦 26 total exports
12. schema/ToParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
13. Cause.ts
   📝 23 missing examples, 🏷️  0 missing categories
   📦 76 total exports
14. config/ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports
15. Queue.ts
   📝 19 missing examples, 🏷️  2 missing categories
   📦 48 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   FiberHandle.ts (17 exports)
   FiberMap.ts (21 exports)
   FiberSet.ts (16 exports)
   Function.ts (24 exports)
   MutableRef.ts (18 exports)
   RcRef.ts (7 exports)
   Runtime.ts (3 exports)
   Schedule.ts (51 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
   TypeId (const, line 74): missing example, category
   TypeId (type, line 82): missing example
   Bottom (interface, line 97): missing example, category
   revealBottom (function, line 154): missing example, category
   annotate (function, line 183): missing example
   annotateKey (function, line 197): missing example
   Top (interface, line 288): missing example, category
   Schema (namespace, line 310): missing example, category
   Type (type, line 314): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 299 missing examples, 89 missing categories
type: 113 missing examples, 64 missing categories
class: 52 missing examples, 3 missing categories
namespace: 21 missing examples, 14 missing categories
interface: 135 missing examples, 97 missing categories
function: 205 missing examples, 53 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 636/1461 (43.5% complete)
Categories: 1141/1461 (78.1% complete)

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

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 4.73 KB 4.73 KB 0.00 KB (0.00%)
bundle/batching.ts 7.01 KB 7.01 KB 0.00 KB (0.00%)
bundle/brand.ts 5.58 KB 5.58 KB 0.00 KB (0.00%)
bundle/cache.ts 8.26 KB 8.26 KB 0.00 KB (0.00%)
bundle/config.ts 14.89 KB 14.89 KB 0.00 KB (0.00%)
bundle/http-client.ts 17.20 KB 17.20 KB 0.00 KB (0.00%)
bundle/logger.ts 8.08 KB 8.08 KB 0.00 KB (0.00%)
bundle/metric.ts 7.50 KB 7.50 KB 0.00 KB (0.00%)
bundle/pubsub.ts 11.86 KB 11.86 KB 0.00 KB (0.00%)
bundle/queue.ts 9.78 KB 9.78 KB 0.00 KB (0.00%)
bundle/schedule.ts 8.04 KB 8.04 KB 0.00 KB (0.00%)
bundle/schema-arbitrary.ts 14.95 KB 14.95 KB 0.00 KB (0.00%)
bundle/schema-equivalence.ts 13.95 KB 13.95 KB 0.00 KB (0.00%)
bundle/schema-json-schema.ts 15.28 KB 15.28 KB 0.00 KB (0.00%)
bundle/schema-pretty.ts 14.05 KB 14.05 KB 0.00 KB (0.00%)
bundle/schema-record-literals-key.ts 12.37 KB 12.37 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 10.95 KB 10.95 KB 0.00 KB (0.00%)
bundle/schema-string-check.ts 9.43 KB 9.43 KB 0.00 KB (0.00%)
bundle/schema-string.ts 8.99 KB 8.99 KB 0.00 KB (0.00%)
bundle/schema-stringLeafJson.ts 13.74 KB 13.74 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 11.34 KB 11.34 KB 0.00 KB (0.00%)
bundle/schema.ts 13.44 KB 13.44 KB 0.00 KB (0.00%)
bundle/stm.ts 10.47 KB 10.47 KB 0.00 KB (0.00%)
bundle/stream.ts 7.02 KB 7.02 KB 0.00 KB (0.00%)

@fubhy fubhy marked this pull request as draft August 31, 2025 15:11
@nikelborm
Copy link

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.

3 participants