search

MDSLKTR / pouch-vue

Pouchdb bindings for Vue.js
MIT License
90 stars 17 forks source link

Use type declaration file generated from ts #17

Closed assemblethis closed 5 years ago

assemblethis commented 5 years ago

The TypeScript version of this Vue.js plugin generates a better type declaration file and this is it.

I figure this can be the last PR and then a release 0.1.38 can be pushed to npm.

Following that, I will do a PR from the MDSLKTR/pouch-vue#typescript branch that can be release 0.2.0. This branch uses typings for pouchdb-live-find and generates its own type declaration file (.d.ts). The Vue.js plugin is now written in TypeScript and rollup transpiles it into a js module. I'm actually testing with release 0.2.0 now and it's working well, though I'm sure it could be improved further.

MDSLKTR commented 5 years ago

I think so too. We'll release this as a minor version and the .ts rewrite as 0.2. I also saw someone forking the repo doing cleanup in the docs, so that might come in handy as well.

assemblethis commented 5 years ago

I created a release 0.1.38 and then rereading the description it seemed silly to not make this a release 0.2.0.

Maybe the TypeScript rewrite should be release 0.3.0.

I've been experimenting with TypeDoc and rethinking the TypeScript code a bit. Here's how I generate markdown from TypeScript:

npm install --save-dev typedoc typedoc-plugin-markdown

"J:\GitHubProjects\TypeScript\pouch-vue\node_modules\.bin\typedoc" --out docs/ src/index.ts --theme markdown --mdEngine github

We might want to have a slimmer readme page and have hyperlinks to more specific pages like api.md.