Separate dirs for users and internal ones #228

New issue

Open

opened 2025-12-28 18:07:30 +00:00 by sami · 3 comments

sami commented

2025-12-28 18:07:30 +00:00

Owner

Originally created by @carpawell on GitHub (Jul 5, 2024).

The structure of the repo looks a little bit overwhelming now. We have structs for real users (object, nemap, etc) and some non-SDK things (doc, api, scripts, stat). Have you considered moving "SDK" things to a separate folder? Naming can be hard here but still.

Originally posted by @carpawell in https://github.com/nspcc-dev/neofs-sdk-go/pull/591#pullrequestreview-2159245860

Originally created by @carpawell on GitHub (Jul 5, 2024). The structure of the repo looks a little bit overwhelming now. We have structs for real users (object, nemap, etc) and some non-SDK things (doc, api, scripts, stat). Have you considered moving "SDK" things to a separate folder? Naming can be hard here but still. _Originally posted by @carpawell in https://github.com/nspcc-dev/neofs-sdk-go/pull/591#pullrequestreview-2159245860_

sami added the

enhancement

labels

2025-12-28 18:07:30 +00:00

sami commented

2025-12-28 18:07:30 +00:00

Author

Owner

@carpawell commented on GitHub (Jul 5, 2024):

It was not a problem before but now we have api, docs, internal, scripts, stat dirs that are not expected to be used by a regular user (pool and waiter are also questionable to me but ok). We can place the all the "user" code to a separate dir or mark non-usable dirs somehow (e.g. start their name with _).

@carpawell commented on GitHub (Jul 5, 2024): It was not a problem before but now we have `api`, `docs`, `internal`, `scripts`, `stat` dirs that are not expected to be used by a regular user (`pool` and `waiter` are also questionable to me but ok). We can place the all the "user" code to a separate dir or mark non-usable dirs somehow (e.g. start their name with `_`).

sami commented

2025-12-28 18:07:30 +00:00

Author

Owner

@roman-khimov commented on GitHub (Jul 15, 2024):

stat is an SDK thing. doc is not an issue. scripts are tolerable. api can either be hidden (internal) or renamed to something more meaningful. But the last thing I'd want is to move any of the packages we have now.

@roman-khimov commented on GitHub (Jul 15, 2024): `stat` is an SDK thing. `doc` is not an issue. `scripts` are tolerable. `api` can either be hidden (`internal`) or renamed to something more meaningful. But the last thing I'd want is to move any of the packages we have now.

sami commented

2025-12-28 18:07:30 +00:00

Author

Owner

@carpawell commented on GitHub (Jul 15, 2024):

stat is an SDK thing

How can it be used? It has PoolStat and it allows to create PoolStat, used by the Pool only. Why is it at root level?

scripts are tolerable

Can not (should not) be used by a user that wants to work with neofs and goes to SDK.

But the last thing I'd want is to move any of the packages we have now.

We can move all the "internal" things to internal and leave all the "user" things as is.

@carpawell commented on GitHub (Jul 15, 2024): > stat is an SDK thing How can it be used? It has `PoolStat` and it allows to create `PoolStat`, used by the Pool only. Why is it at root level? > scripts are tolerable Can not (should not) be used by a user that wants to work with neofs and goes to SDK. > But the last thing I'd want is to move any of the packages we have now. We can move all the "internal" things to `internal` and leave all the "user" things as is.