rxliuli / joplin-utils

Joplin-based community tool
https://joplin-utils.rxliuli.com/
MIT License
235 stars 36 forks source link

[Question]: My first fork and my first vscode extension. I want to contribute to the project. #61

Closed serranomorante closed 2 years ago

serranomorante commented 2 years ago

Confirmation

The tool/kit related to this post

joplin-vscode-plugin

Describe the question

Sorry if this is not the place to talk about this.

I already checked this page: Contribute, but the information is rather scarce for a "beginner" in terms of vscode extension development + pnpm monorepos... so I don't know where to start in this particular project.

I know a lot about typescript, react and vscode, though. The joplin data api doesn't seem difficult to grasp and your source code is understandable by just skimming at it.

I need to know:

Any other suggestion would be appreciate.

I intend to expand the TODO functionality from the joplin-vscode-plugin with these simple features:

I don't know why this feature isn't in the roadmap, if there's a reason for which I should avoid continuing with this fork just let me know. Also let me know if you need help with something else.

Btw, I love this project. Thank you so much!

rxliuli commented 2 years ago

How do you start the Extension Development Host window just for the joplin-vscode-plugin in the monorepo. Maybe I just need to change the .vscode/_launch.json to .vscode/launch.json? and also some of the properties inside it?

  1. fork repo
  2. git clone https://github.com//joplin-utils.git && cd joplin-utils/
  3. pnpm i && pnpm setup-all
  4. code apps/joplin-vscode-plugin
  5. run joplin dev mode, ref: https://joplinapp.org/api/references/development_mode/ image
  6. enable clipper service image
  7. cp .vscode/_launch.json .vscode/launch.json
  8. modify .vscode/launch.json, set _env.JOPLINTOKEN, example: image
  9. pnpm dev
  10. F5 run debug

I don't know why this feature isn't in the roadmap, if there's a reason for which I should avoid continuing with this fork just let me know. Also let me know if you need help with something else.

Simply put, I don't use the joplin todo feature and I don't think it's a really usable todo app.

serranomorante commented 2 years ago

I'm getting this error inside the Extension Development Host window after activating the extension using View: Show Joplin:

View Joplin

I did all the steps that you mentioned.

I'm using Ubuntu. I installed vscode using snap.

This is the stdout of running pnpm i && pnpm setup-all

Scope: all 11 workspace projects
Lockfile is up to date, resolution step is skipped
Already up to date
. postinstall$ npx simple-git-hooks
│ [INFO] Successfully set the pre-commit with command: pnpm lint-staged
│ [INFO] Successfully set the commit-msg with command: pnpm commitlint --edit $1
│ [INFO] Successfully set all git hooks
└─ Done in 1s
Done in 5.9s

> joplin-utils@ setup-all /home/<username>/contributions/joplin-utils
> pnpm -r run setup

Scope: 10 of 11 workspace projects
libs/joplin-api setup$ pnpm build
│ > joplin-api@0.5.0 build /home/<username>/contributions/joplin-utils/libs/joplin-api
│ > rimraf dist && tsup src/index.ts src/node-polyfill.ts --format esm,cjs --dts
│ CLI Building entry: src/index.ts
[1 lines collapsed]
│ CLI tsup v6.2.3
│2CLI Target: node14
│ CLI Building entry: src/index.ts
│ CLI Using tsconfig: tsconfig.json
│3CLI tsup v6.2.3
│ CLI Using tsconfig: tsconfig.json
│ CLI tsup v6.2.3
│4CLI Target: node1413.30 KB
│ CLI tsup v6.2.3
│ CLI Target: node14ss in 163ms
│5ESM Build start
│ CLI Target: node14ss in 163ms
│ ESM Build start
│ CJS Build startccess in 163ms
│ CJS dist/index.cjs 15.20 KB
│ CJS ⚡️ Build success in 163ms
│ ESM dist/index.js 13.30 KB
│ ESM ⚡️ Build success in 197mss
│ DTS Build start
│ DTS ⚡️ Build success in 4476ms
└─ Done in 6.9sx.d.ts 17.29 KB
apps/joplin-blog setup$ pnpm run gen-i18n && pnpm run build
│ > joplin-blog@0.9.4 gen-i18n /home/<username>/contributions/joplin-utils/apps/joplin-blog
│ > i18next-dts-gen --dirs src/i18n
│ Ends generating type definition [79ms]: src/i18n/index.d.ts
│ > joplin-blog@0.9.4 build /home/<username>/contributions/joplin-utils/apps/joplin-blog
│ > tsup src/index.ts --format esm,cjs --dts --shims && tsup src/bin.ts --format esm --target esnext
│ CLI Building entry: src/index.ts
[1 lines collapsed]
│ CLI tsup v6.2.3
│ CLI Target: node14
│ ESM Build start
└─ Running...
a2ps/joplin-vscode-plugin setup$ i18next-dts-gen -i src/i18n/
│ Ends generating type definition [79ms]: src/i18n/index.d.ts
│ > joplin-blog@0.9.4 build /home/<username>/contributions/joplin-utils/apps/joplin-blog
│3> tsup src/index.ts --format esm,cjs --dts --shims && tsup src/bin.ts --format esm --target esnext
│ > joplin-blog@0.9.4 build /home/<username>/contributions/joplin-utils/apps/joplin-blog
│ > tsup src/index.ts --format esm,cjs --dts --shims && tsup src/bin.ts --format esm --target esnext
│4CLI Building entry: src/index.ts
│ > tsup src/index.ts --format esm,cjs --dts --shims && tsup src/bin.ts --format esm --target esnext
│ CLI Building entry: src/index.ts
│5CLI Using tsconfig: tsconfig.json
│ CLI Building entry: src/index.ts
│ CLI Using tsconfig: tsconfig.json
│6CLI tsup v6.2.3
│ CLI Using tsconfig: tsconfig.json
│ CLI tsup v6.2.3
│7CLI Target: node14ss in 166ms
│ CLI tsup v6.2.3
│ CLI Target: node14ss in 166ms
│8ESM Build start
│ CLI Target: node14ss in 166ms
│ ESM Build start
│9CJS Build startccess in 166ms
│ ESM Build start
│ CJS Build startccess in 166ms
[10 lines collapsed]16.76 KBB
│ CJS Build startccess in 166mss
│ ESM dist/index.js 16.76 KBB
│ 1SM ⚡️ Build success in 166mss
│ ESM dist/index.js 16.76 KBB
│ ESM ⚡️ Build success in 166mss
│ 2JS dist/index.cjs 19.72 KB
│ ESM ⚡️ Build success in 166mss
│ CJS dist/index.cjs 19.72 KB
│ 3JS ⚡️ Build success in 130mss
│ CJS dist/index.cjs 19.72 KB
│ CJS ⚡️ Build success in 130mss
│ 4TS Build start
│ CJS ⚡️ Build success in 130mss
│ DTS Build start
│ 5TS ⚡️ Build success in 9043ms
│ DTS Build start
│ DTS ⚡️ Build success in 9043ms
│ DTS dist/index.d.ts 5.70 KB
│ CLI Building entry: src/bin.ts
│ CLI Using tsconfig: tsconfig.json
│ CLI tsup v6.2.3
└─ Done in 14.4snext.95 KB
│ ESM Build start
│ ESM dist/bin.js 31.95 KB
│ ESM ⚡️ Build success in 136ms
rxliuli commented 2 years ago

Sorry, looks like I missed a step, need to run pnpm dev before F5 run debug

serranomorante commented 2 years ago

Sorry, looks like I missed a step, need to run pnpm dev before F5 run debug

Thank you!