fix(web): make TypeDoc works again #1832
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because it fails after updating to TypeDoc 0.27.4 and it was introduced for a purpose that for now it is not currently being used. Thus, let's postpone its usage until really needed if it is updated to work with the lastest TypeDoc when such a moment arrive. See, * Agama commit in which it was added 5e09032 * Issue at upstream asgerjensen/typedoc-plugin-external-module-map#27
There were few core/Section leftover in storage namespace. Since core/Section is going to be removed, Page.Section has been used instead.
It was no longer needed and making TypeDoc to exit with an unexpected error.
imobachgs
approved these changes
Dec 13, 2024
Those that were causing TypeDoc crashes, as described in commit 791857a.
Note that some eslint-disable @typescript-eslint/no-explicit-any has been added. This should be temporary until the new storage part is finished and these any can be replaced with more sensible types.
This reverts commit d946480.
dgdavid
changed the title
imobachgs
approved these changes
Dec 16, 2024
Merged
imobachgs
added a commit
that referenced
this pull request
Jan 13, 2025
Update to release version 11. * #1495 * #1564 * #1617 * #1618 * #1625 * #1626 * #1627 * #1628 * #1630 * #1631 * #1632 * #1633 * #1634 * #1635 * #1636 * #1639 * #1640 * #1641 * #1642 * #1643 * #1644 * #1645 * #1646 * #1647 * #1648 * #1649 * #1650 * #1651 * #1652 * #1654 * #1655 * #1656 * #1657 * #1660 * #1663 * #1666 * #1667 * #1668 * #1670 * #1671 * #1673 * #1674 * #1675 * #1676 * #1677 * #1681 * #1682 * #1683 * #1684 * #1687 * #1688 * #1689 * #1690 * #1691 * #1692 * #1693 * #1694 * #1695 * #1696 * #1698 * #1699 * #1702 * #1703 * #1704 * #1705 * #1707 * #1708 * #1709 * #1710 * #1711 * #1712 * #1713 * #1714 * #1715 * #1716 * #1717 * #1718 * #1720 * #1721 * #1722 * #1723 * #1727 * #1728 * #1729 * #1731 * #1732 * #1733 * #1734 * #1735 * #1736 * #1737 * #1740 * #1741 * #1743 * #1744 * #1745 * #1746 * #1751 * #1753 * #1754 * #1755 * #1757 * #1762 * #1763 * #1764 * #1765 * #1766 * #1767 * #1769 * #1771 * #1772 * #1773 * #1774 * #1777 * #1778 * #1785 * #1786 * #1787 * #1788 * #1789 * #1790 * #1791 * #1792 * #1793 * #1794 * #1795 * #1796 * #1797 * #1798 * #1799 * #1800 * #1802 * #1803 * #1804 * #1805 * #1807 * #1808 * #1809 * #1810 * #1811 * #1812 * #1814 * #1815 * #1821 * #1822 * #1823 * #1824 * #1825 * #1826 * #1827 * #1828 * #1830 * #1831 * #1832 * #1833 * #1834 * #1835 * #1836 * #1837 * #1838 * #1839 * #1840 * #1841 * #1842 * #1843 * #1844 * #1845 * #1847 * #1848 * #1849 * #1850 * #1851 * #1854 * #1855 * #1856 * #1857 * #1860 * #1861 * #1863 * #1864 * #1865 * #1866 * #1867 * #1871 * #1872 * #1873 * #1875 * #1876 * #1877 * #1878 * #1880 * #1881 * #1882 * #1883 * #1884 * #1885 * #1886 * #1888 * #1889 * #1890
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
After updating to TypeDoc 0.27, the
npm run typedoctask stop working because problems when loadingtypedoc-plugin-external-module-map. See https://github.com/agama-project/agama/actions/runs/12302232612/job/34334622800Solution
Open an issue in upstream and stop using the conflicting plugin, fix all TypeDoc issues (see next section), and revert commit d946480 added at #1225
Additional work
Even without the mentioned plugin, TypeDoc tasks still failing because other crash already mentioned in the commit message of 791857a
Migrating some components to TypeScript solved the issue. This was done at commit 34bc000, which also includes adjustments needed after these migrations.
Future work
Now all TypeDoc tasks are working again. They helped somehow to identify and fix some problems. Even to delete a no longer needed component. It still, however, work pending to do
Fix TypeDoc warnings
There are plenty of TypeDoc warning, about unknown block tags, signatures with unused params, reference props not included in documentation, etc.
Most likely, the entire TypeDoc documentation strategy needs to be reconsidered.
Finish the TypeScript migration
Would be nice to finish the migration to TypeScript too, but in a separated PR in which some components should be removed instead.
Click to show/hide a list of JSX components
Stop using
anytype.This PR has included a couple of
anytypes in components closely related to the storage part, which is being rewritten. Theseanyshould be replaced by the right types once the storage work is finished.