Skip to content

Conversation

@mikearnaldi
Copy link
Member

@mikearnaldi mikearnaldi commented Sep 7, 2025

Following the rule of "what feels natural" vs grouping things by what they are, the current structure is still too nested to be nice to use

@mikearnaldi mikearnaldi changed the title Organization/flatten-more-directories Reduce forced nesting of modules Sep 7, 2025
@github-actions
Copy link

github-actions bot commented Sep 7, 2025

📊 JSDoc Documentation Analysis

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

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

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 52
Total exported members: 1491
Missing @example: 786 (52.7%)
Missing @category: 293 (19.7%)

🎯 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. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
6. schema/ToJsonSchema.ts
   📝 18 missing examples, 🏷️  18 missing categories
   📦 18 total exports
7. schema/Transformation.ts
   📝 24 missing examples, 🏷️  12 missing categories
   📦 24 total exports
8. schema/ToArbitrary.ts
   📝 15 missing examples, 🏷️  15 missing categories
   📦 15 total exports
9. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
10. schema/ToParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
11. Effect.ts
   📝 22 missing examples, 🏷️  1 missing categories
   📦 225 total exports
12. ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports
13. ScopedCache.ts
   📝 18 missing examples, 🏷️  0 missing categories
   📦 18 total exports
14. schema/Issue.ts
   📝 15 missing examples, 🏷️  2 missing categories
   📦 15 total exports
15. Queue.ts
   📝 13 missing examples, 🏷️  0 missing categories
   📦 44 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Clock.ts (5 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)
   Runtime.ts (3 exports)
   Schedule.ts (49 exports)
   index.ts (0 exports)
   schema/index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM schema/Schema.ts
-----------------------------------
   MakeOptions (interface, line 56): missing example, category
   Bottom (interface, line 82): missing example, category
   revealBottom (function, line 139): missing example, category
   annotate (function, line 168): missing example
   annotateKey (function, line 182): missing example
   Top (interface, line 273): missing example, category
   Schema (namespace, line 295): missing example, category
   Type (type, line 299): missing example, category
   Schema (interface, line 305): missing example, category
   Codec (namespace, line 313): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
interface: 140 missing examples, 95 missing categories
const: 269 missing examples, 64 missing categories
type: 99 missing examples, 64 missing categories
function: 209 missing examples, 55 missing categories
class: 46 missing examples, 1 missing categories
namespace: 23 missing examples, 14 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 705/1491 (47.3% complete)
Categories: 1198/1491 (80.3% complete)

============================================================
Analysis complete! 1079 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 Sep 7, 2025

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 5.28 KB 5.28 KB 0.00 KB (0.00%)
bundle/batching.ts 7.54 KB 7.54 KB -0.01 KB (-0.08%)
bundle/brand.ts 5.65 KB 5.65 KB 0.00 KB (0.00%)
bundle/cache.ts 8.78 KB 8.79 KB -0.01 KB (-0.10%)
bundle/config.ts 14.93 KB 14.94 KB -0.01 KB (-0.05%)
bundle/http-client.ts 17.77 KB 17.78 KB -0.01 KB (-0.07%)
bundle/logger.ts 7.81 KB 7.80 KB +0.00 KB (+0.05%)
bundle/metric.ts 7.96 KB 7.96 KB 0.00 KB (0.00%)
bundle/pubsub.ts 12.28 KB 12.27 KB +0.01 KB (+0.07%)
bundle/queue.ts 10.18 KB 10.18 KB +0.01 KB (+0.05%)
bundle/schedule.ts 8.62 KB 8.62 KB -0.01 KB (-0.09%)
bundle/schema-arbitrary.ts 15.03 KB 15.02 KB +0.01 KB (+0.05%)
bundle/schema-equivalence.ts 14.05 KB 14.04 KB +0.01 KB (+0.04%)
bundle/schema-format.ts 14.13 KB 14.13 KB +0.00 KB (+0.01%)
bundle/schema-json-schema.ts 15.36 KB 15.36 KB +0.00 KB (+0.01%)
bundle/schema-record-literals-key.ts 12.43 KB 12.43 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 10.62 KB 10.64 KB -0.02 KB (-0.20%)
bundle/schema-string-check.ts 9.46 KB 9.46 KB 0.00 KB (0.00%)
bundle/schema-string.ts 9.03 KB 9.03 KB 0.00 KB (0.00%)
bundle/schema-stringLeafJson.ts 13.80 KB 13.80 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 11.42 KB 11.42 KB 0.00 KB (0.00%)
bundle/schema.ts 13.51 KB 13.51 KB 0.00 KB (0.00%)
bundle/stm.ts 11.01 KB 10.99 KB +0.02 KB (+0.15%)
bundle/stream.ts 7.49 KB 7.49 KB 0.00 KB (0.00%)

@mikearnaldi mikearnaldi force-pushed the organization/flatten-more-directories branch 2 times, most recently from f321920 to b4f7650 Compare September 10, 2025 17:37
@mikearnaldi mikearnaldi force-pushed the organization/flatten-more-directories branch from 2c26dc6 to c7b0422 Compare September 11, 2025 16:14
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