search

l-lin / angular-datatables

DataTables with Angular
https://l-lin.github.io/angular-datatables/
MIT License
1.57k stars 481 forks source link

DT v2 + Project structure upgrades #1783

Closed shanmukhateja closed 2 months ago

shanmukhateja commented 3 months ago

Closes #1777 and #1780

Feel free to test this branch for issues. I have verified the functionality using npm test.

Also, I suggest cloning this branch in a separate directory due to differences in project structure and devDependencies.

shanmukhateja commented 3 months ago

@l-lin I may have broken GitHub CI flow with these changes. We simply need to update npm commands used in the workflow file and test it back-to-back.

If you can spare some time, please look into this. It might take me a while to check this due to some personal commitments. :-^)

EDIT: CI updates have been made. Tested with act locally and they pass. I could always use more testing. :-)

shanmukhateja commented 2 months ago

I still need to update documentation pages and DEVELOPER.md

shanmukhateja commented 2 months ago

Hey @l-lin

Glad to know you're back.

I have just closed the laptop for the night so let me check and update the PR tomorrow (IST timezone).

:)

shanmukhateja commented 2 months ago

@l-lin Please don't merge the PR just yet. I need to test ng add with Bootstrap + DT v2.

EDIT: Bootstrap integration still works!

Feel free to merge when you approve :)

shanmukhateja commented 2 months ago

chore: We need another change on the documentation where we need to specify that angular-datatables will only support datatables v2 starting from version X.

I was only expecting a small quote on the FAQ page. What you implemented is way better 👍

However, I think we need to invert the sources, i.e. md(HTML|TS) for source on DT v2 and have a md(HTML|TS)DTV1 for V1 instead.

Indeed, we will update and maintain the documentation for DT v2 and the ones for DT V1 will not be touched (or will be deleted in the future). In other words, we should use variable names with suffix/prefix for special cases and have the "standard" variable name for the documentation we need to keep up-to-date.

The benefit is double:

* it's implicit that "standard" variable name like "mdHTML" is the main one

* if we delete the documentation for legacy DT v1, it's easier to do it by searching the keyword "v1" (or legacy?)

What do you think?

In hindsight, I should've done it this way.

Fixed in e473f9d (#1783)