clean up project files - Githubissues

replikativ / datahike

A fast, immutable, distributed & compositional Datalog engine for everyone.

https://datahike.io

Eclipse Public License 1.0

1.63k stars 97 forks source link

clean up project files #548

Open kordano opened 2 years ago

kordano commented 2 years ago

The namespaces are too complected and need some refactoring. Unused and deprecated functions need to be removed. Additionally, the folder structure needs to be reviewed and a better package structure recommended. Also have a look at the test folder and its strange structure.

jsmassa commented 2 years ago

The db namespace will be refactored with #555

Concerning the test folder, I can see, that

the second test subfolder can be removed, i.e. test->datahike->test->api_test.cljc would become test->datahike->api_test.cljc
test.cljc can be removed
backward_compatibility_test is something different than the rest of the tests and should be moved out of the test folder
the js folder probably can be removed as well (there is a js test runner that can be pulled on demand)

What do you think?

jsmassa commented 2 years ago

I think, we should talk about some of the unused functions. I remember that for some of them I do not know, why they are never used.

jsmassa commented 2 years ago

Here is another list of refactoring ideas I found:

error handling
refactoring of README
- sections into files
- contribute md -> more, also as developer guide for work with repo
  - i.e. conventional commits, formatting
core namespace refactoring -> which functions can be moved?
transactor.clj: refactoring for easier understanding