Skip to content

Conversation

@tim-smart
Copy link
Collaborator

No description provided.

@github-actions
Copy link

github-actions bot commented Dec 19, 2025

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 6.24 KB 6.23 KB +0.01 KB (+0.10%)
bundle/batching.ts 8.49 KB 8.49 KB +0.00 KB (+0.05%)
bundle/brand.ts 6.29 KB 6.30 KB -0.01 KB (-0.14%)
bundle/cache.ts 9.56 KB 9.55 KB +0.01 KB (+0.08%)
bundle/config.ts 16.08 KB 16.07 KB +0.01 KB (+0.03%)
bundle/differ.ts 14.28 KB 14.29 KB -0.01 KB (-0.03%)
bundle/http-client.ts 18.73 KB 18.71 KB +0.01 KB (+0.08%)
bundle/logger.ts 8.61 KB 8.61 KB +0.01 KB (+0.08%)
bundle/metric.ts 8.72 KB 8.72 KB +0.00 KB (+0.03%)
bundle/optic.ts 7.55 KB 7.55 KB -0.01 KB (-0.08%)
bundle/pubsub.ts 13.08 KB 13.06 KB +0.02 KB (+0.12%)
bundle/queue.ts 10.94 KB 10.93 KB +0.01 KB (+0.10%)
bundle/schedule.ts 9.66 KB 9.66 KB +0.00 KB (+0.04%)
bundle/schema-string-async.ts 11.30 KB 11.29 KB +0.01 KB (+0.11%)
bundle/schema-string-check.ts 10.03 KB 10.03 KB +0.00 KB (+0.03%)
bundle/schema-string.ts 9.62 KB 9.62 KB +0.00 KB (+0.03%)
bundle/schema-template-literal.ts 12.20 KB 12.19 KB +0.01 KB (+0.09%)
bundle/schema-toArbitraryLazy.ts 16.28 KB 16.27 KB +0.01 KB (+0.06%)
bundle/schema-toCodecStringTree.ts 15.48 KB 15.47 KB +0.01 KB (+0.06%)
bundle/schema-toEquivalence.ts 15.41 KB 15.40 KB +0.01 KB (+0.10%)
bundle/schema-toFormatter.ts 15.27 KB 15.26 KB +0.01 KB (+0.07%)
bundle/schema-toJsonSchema.ts 16.57 KB 16.56 KB +0.00 KB (+0.02%)
bundle/schema.ts 14.90 KB 14.89 KB +0.01 KB (+0.08%)
bundle/standard-roundtrip.ts 23.01 KB 23.01 KB -0.00 KB (-0.00%)
bundle/stm.ts 11.73 KB 11.72 KB +0.01 KB (+0.08%)
bundle/stream.ts 8.43 KB 8.42 KB +0.01 KB (+0.07%)

@github-actions
Copy link

github-actions bot commented Dec 19, 2025

📊 JSDoc Documentation Analysis

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

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

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 123
Total exported members: 3964
Missing @example: 1597 (40.3%)
Missing @category: 506 (12.8%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. Schema.ts
   📝 457 missing examples, 🏷️  266 missing categories
   📦 457 total exports
2. SchemaStandard.ts
   📝 76 missing examples, 🏷️  75 missing categories
   📦 76 total exports
3. Stream.ts
   📝 134 missing examples, 🏷️  0 missing categories
   📦 223 total exports
4. SchemaAST.ts
   📝 77 missing examples, 🏷️  18 missing categories
   📦 77 total exports
5. Channel.ts
   📝 71 missing examples, 🏷️  0 missing categories
   📦 140 total exports
6. Sink.ts
   📝 64 missing examples, 🏷️  2 missing categories
   📦 81 total exports
7. SchemaGetter.ts
   📝 49 missing examples, 🏷️  0 missing categories
   📦 49 total exports
8. SchemaTransformation.ts
   📝 29 missing examples, 🏷️  18 missing categories
   📦 29 total exports
9. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
10. Effect.ts
   📝 29 missing examples, 🏷️  1 missing categories
   📦 232 total exports
11. Cause.ts
   📝 27 missing examples, 🏷️  2 missing categories
   📦 67 total exports
12. Filter.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 35 total exports
13. JsonSchema.ts
   📝 12 missing examples, 🏷️  12 missing categories
   📦 12 total exports
14. SchemaFromJson.ts
   📝 12 missing examples, 🏷️  12 missing categories
   📦 12 total exports
15. SchemaIssue.ts
   📝 22 missing examples, 🏷️  2 missing categories
   📦 22 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Chunk.ts (87 exports)
   Clock.ts (5 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   HKT.ts (4 exports)
   HashMap.ts (44 exports)
   HashSet.ts (21 exports)
   Match.ts (57 exports)
   MutableHashSet.ts (9 exports)
   MutableRef.ts (17 exports)
   NonEmptyIterable.ts (3 exports)
   Random.ts (7 exports)
   Redacted.ts (9 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Symbol.ts (1 exports)
   Trie.ts (29 exports)
   TxChunk.ts (22 exports)
   TxHashMap.ts (41 exports)
   TxHashSet.ts (24 exports)
   TxRef.ts (7 exports)
   TxSemaphore.ts (14 exports)
   Unify.ts (8 exports)
   index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM Schema.ts
-----------------------------------
   Optionality (type, line 54): missing example, category
   Mutability (type, line 61): missing example, category
   ConstructorDefault (type, line 68): missing example, category
   MakeOptions (interface, line 76): missing example, category
   Bottom (interface, line 100): missing example, category
   declareConstructor (interface, line 180): missing example, category
   declareConstructor (function, line 204): missing example
   declare (interface, line 228): missing example
   declare (function, line 237): missing example, category
   revealBottom (function, line 257): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 777 missing examples, 148 missing categories
function: 299 missing examples, 103 missing categories
type: 166 missing examples, 84 missing categories
interface: 265 missing examples, 150 missing categories
class: 56 missing examples, 1 missing categories
namespace: 34 missing examples, 20 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 2367/3964 (59.7% complete)
Categories: 3458/3964 (87.2% complete)

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

@tim-smart tim-smart marked this pull request as ready for review January 12, 2026 00:08
@tim-smart tim-smart merged commit 00a9ef2 into main Jan 12, 2026
11 of 12 checks passed
@tim-smart tim-smart deleted the atom branch January 12, 2026 00:11
Copy link

@nikelborm nikelborm Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something's wrong here. Changes to the copy-pasted README of @effect/sql-clickhouse were forgotten

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tim-smart, not sure if this notification came through on GitHub, so pinging 😊 🫶

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