willo0ow / vue-simple-docs Goto Github PK

requires #4
In the main page we display a list of documented components.
Let's display it as a tree-like map to mirror the source directory structure.
The source data will be stored in docs/src/generated/index.ts

Make extract methods more universal, so generating a documentation of any file is possible.
Add more tags to document not component files.

related #5
For now, each item in the list is a link to ComponentDetails page.
But some of the items are subdirectory names, they should be links to a page where the subdirectory files are displayed.

Add search in the nav bar to find files.
in App.vue
const searchItems = files.children.reduce((links, child) => {}, [{ name, routeObject }]);

requires #9
Now the vue app is set to display documentation of vue components.
Adjust it to display docs of any file

Instead using tsc every time you made changes to node scripts, set up something like 'hot-reload'
Some ideas in the link below:
https://blog.logrocket.com/configuring-nodemon-with-typescript/

Fix prettier options, and make them the same all over the project.
Add husky and in pre-commit hook run linter/formatter.

For now, the script assumes that sourceDir in docs.config is just one directory.
Allow to provide several directories in array.
Adjust function that generates data objects to work when several directories are provided.

requires #7
Expand search functionality and allow searching not only by file name but also their properties, e.g. name of method.

This option should be known for TS 5.0.4 but is not being recognised.

For now the documentation is generated within the vue simple docs repo. Try to install the build in a sample Vue project, add fixes.

E.g.
source dir is 'components' folder, inside there is another folder 'web' and Component2. Inside web folder there is Component1.
We create in docs/generated/index.ts a list of documented files.
Let's create a list that will mirror the source directory files structure.
Now in index.ts:
const components = [{name: 'Component1'}, {name: 'Component2'}]
Expected:
const components = [{name: 'web', type: 'folder', children: [{name: 'Component1', type: 'file'}]}, {name: 'Component2', type: 'file'}]

There is a script that creates esm and cjs builds.
The esm is not working properly.
I'm not sure how it should be done that when a developer installs the package, the right build (esm/cjs) will be used.

Method's parameters are not extracted correctly, square brackets should not be extracted.