Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[all] splitting up / restructuring of large(r) packages #486

Open
36 tasks done
postspectacular opened this issue Jul 20, 2024 · 1 comment
Open
36 tasks done

[all] splitting up / restructuring of large(r) packages #486

postspectacular opened this issue Jul 20, 2024 · 1 comment

Comments

@postspectacular
Copy link
Member

postspectacular commented Jul 20, 2024 •
edited
Loading

Context

Over the years there has been (infrequent, but repeated) criticism about some of the package sizes and implicitly about the number of dependencies of such packages. Only a very small number of the packages in this repo (currently 2, I think) have 3rd party dependencies, all others are thi.ng internal. Thanks to treeshaking, in most cases these internal deps are not really an issue and simply encourage better re-use, code density and also provide a huge benefit in terms of maintenance of all these packages. However, with the prevailing mindset of JS devs and also increased concern about "supply chain" issues, a newcomer user, will judge the presence of any dependencies as a negative factor and as such the current structure/organization of these larger packages is actually partially hurting uptake/interest, regardless of value and/or features provided. C'est la vie... 🤷

Proposed solution

Being pragmatic about this situation, I'm currently experimenting with splitting up some of these larger packages, introducing a number of smaller ones and migrating functionality to those. The idea is to still group related features, but with a more "atomic" (aka a more fine grained focus) and with the aim of minimizing deps per package.

For existing users, this will mean some breaking changes, but only in terms of having to update imports. I'm not going to conflate any other refactoring and/or API changes with this restructuring work!

Progress

I will keep updating this issue with ongoing progress of the restructing. All of this work is happening on the feature/large-pkg-splitting branch.

thi.ng/associative

New additional packages:

Please do get in touch if you have opinions/views about other candidates which would benefit from a similar splitting!
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(trie): import as new package (#486)
a2007af 
- extract `MultiTrie` & `TrieMap` from thi.ng/associative
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(bidir-index): import as new package (#486)
a047796 
- extract `BidirIndex` from thi.ng/associative
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(object-utils): import as new package (#486)
9587f66 
- extract `BidirIndex` from thi.ng/associative
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(associative): restructure & split-up package (#486)
8e59a63 
BREAKING CHANGE: restructure & split-up package, update readme

- remove obsolete source files
- update pkg exports
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(webgl): update deps & imports (#486)
3902356
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(viz): update deps & imports (#486)
12c8bf7
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(rdom-components): update deps & imports (#486)
903392b
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(rdom-canvas): update deps & imports (#486)
e244a8d
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(proctext): update deps & imports (#486)
78271bc
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(imago): update deps & imports (#486)
5131a85
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(geom-webgl): update deps & imports (#486)
665f7e9
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(geom-fuzz): update deps & imports (#486)
be0ba70
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(geom): update deps & imports (#486)
90148b2
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(egf): update deps & imports (#486)
d0b54ab
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
build(examples): update deps & imports (#486)
e6b40c0
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(sorted-map): import as new pkg (#486)
02602e8
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(associative): migrate/remove SortedMap/Set, sortedObject() (#…
9f4143a 
…486)

BREAKING CHANGE: migrate/remove SortedMap/Set, sortedObject()

- migrate `SortedMap`/`SortedSet` to thi.ng/sorted-map pkg
- migrate `sortedObject()` to thi.ng/object-utils
- remove obsolete source files
- remove obsolete deps
- update readme
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(sparse-set): import as new pkg (#486)
49f7e2d 
- extract sparseset-related fns/classes from thi.ng/associative
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(associative): migrate/remove sparse set features (#486)
db2957c 
BREAKING CHANGE: migrate sparse set features to thi.ng/sparse-set pkg

- remove obsolete files
- update pkg
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(sparse-set): import as new pkg (#486)
ebcef75 
- extract `DisjointSet` from thi.ng/adjacency
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(adjacency): migrate/remove DisjointSet (#486)
c4a9798 
BREAKING CHANGE: migrate DisjointSet to thi.ng/disjoint-set pkg

- remove obsolete files
- update pkg
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(pixel-dominant-colors): import as new pkg (#486)
a4174f5 
- migrate `dominantColors()` from thi.ng/pixel pkg
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(pixel): migrate/remove dominantColors() (#486)
8851726 
BREAKING CHANGE: migrate dominantColors() to thi.ng/pixel-dominant-colors pkg

- remove obsolete files
- update pkg
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
feat(uuid): import as new pkg (#486)
4ca1750 
- migrate UUID functions from thi.ng/random pkg
postspectacular added a commit that referenced this issue Jul 20, 2024
@postspectacular
refactor(random): migrate/remove UUID functions (#486)
2ec753e 
BREAKING CHANGE: migrate UUID functions to thi.ng/uuid pkg

- remove obsolete files
- update deps/pkg
- update readme
postspectacular added a commit that referenced this issue Jul 22, 2024
@postspectacular
feat(pixel-convolve): import as new pkg (#486)
5c3f4be 
- migrate convolve, normalMap and imagePyramid functions
  from thi.ng/pixel pkg
postspectacular added a commit that referenced this issue Jul 22, 2024
@postspectacular
refactor(random): migrate/remove convolve functions (#486)
bf61076 
BREAKING CHANGE: migrate convolve, normalMap & imagePyramid functionality to thi.ng/pixel-convolve pkg

- remove obsolete files
- update deps/pkg
- update readme
postspectacular added a commit that referenced this issue Jul 22, 2024
@postspectacular
Merge branch 'feature/large-pkg-splitting' into develop
18d2753 
* feature/large-pkg-splitting: (64 commits)
  docs(disjoint-set): update pkg meta & readme
  docs: regen readmes
  build(porter-duff): intern/update deps & readme
  docs: update node fs imports in snippets
  build(examples): update deps/imports (pixel-convolve)
  docs(pixel): update/regen readmes (code examples, tangle support)
  refactor(random): migrate/remove convolve functions (#486)
  feat(pixel-convolve): import as new pkg (#486)
  refactor(pixel): intern swapLane13 helper, remove dependency
  feat(tools): update check-imports & readme gen
  docs: regen/update readmes
  build(cache): remove transducers dependency
  build: update pkg exports
  build: update yarn.lock
  docs(strings): update doc link
  refactor(random): migrate/remove UUID functions (#486)
  feat(uuid): import as new pkg (#486)
  refactor(examples): update package-stats
  feat(tools): add/update stats scripts
  docs(pixel): minor update readme
  ...
@postspectacular
Copy link
Member Author

An update: The above listed packages have all been released now and the packages this functionality has been extracted from have received majaor version updates with notices both in readmes & changelogs...

Keeping this issue open for a while in case there might be future rounds of similar restructuring....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@postspectacular