Migrate to TypeScript - Githubissues

kikuomax commented 10 months ago

[ ] packages/buefy-next
- [x] tsconfig.json
- [x] rollup.config.mjs
- [x] Configure ~~jest~~ Vitest
- [x] Generate type declaration (*.d.ts) and rollup (buefy.d.ts)
- [x] Configure eslint
- [ ] #172
- [ ] #173
- [ ] #174
[ ] packages/docs
- [x] tsconfig.json
  - [x] ~~for development that directly includes packages/buefy-next/src~~ running vite does not seem to require tsconfig.json. Vite clearly states that it won't perform typechecking.
  - [x] for production. Perform typechecking while building
- [x] vite.config.js
- [ ] #175
- [ ] #176
[ ] Plan for releasing to the dev branch (Download the tier analysis results as JSON)
- [ ] Tier 1 - ground work (build scripts, TypeScript configuration, etc.)
- [ ] Tier 2 - utils
- [ ] Tier 3 - components without dependencies
- [ ] Tier 4 - components depending only on Tier 3
- [ ] Tier 5 - components depending only on Tier 3 and 4
- [ ] Tier TBD - components depending on lower tiers
[ ] Plan for releasing the documentation to the dev branch (Download the tier analysis results as JSON)

grantmcconnaughey commented 10 months ago

Would this mean that we would need to use Typescript to use Buefy with Vue.js 3?

kikuomax commented 10 months ago

Would this mean that we would need to use Typescript to use Buefy with Vue.js 3?

@grantmcconnaughey No, we will continue providing JS bundles but with comprehensive type declarations for TypeScript.

grantmcconnaughey commented 10 months ago

Awesome, thank you for clarifying!

wesdevpro commented 10 months ago

@kikuomax I assume the task packages/docs has yet to be populated with sub tasks. Is that correct?

kikuomax commented 10 months ago

@kikuomax I assume the task packages/docs has yet to be populated with sub tasks. Is that correct?

@wesdevpro Right. I have added items I can anticipate.

kikuomax commented 10 months ago

@wesdevpro Buefy for Vue2 has changes including important bug fixes not merged to Buefy-next yet. I anticipate massive changes will be introduced by rewriting code in TypeScript. So merging the latest changes on Buefy for Vue2 should happen before actually rewriting things in TypeScript.

kikuomax commented 9 months ago

I will continue working on this issue after finishing #159.

kikuomax commented 8 months ago

I am working on migration in migrate-to-typescript branch. Unfortunately, the process is incremental and will take ~~weeks~~ months. If someone could contribute to migration, it would be greatly appreciated.

Contribution guide

Please:

See the progress in the following issues:
- 172
- 173
- 174
- 175
- 176
Claim which component (group) you are going to work on in this thread to avoid overlap
Migrate the component to TypeScript
Make a PR to migrate-to-typescript branch
Include one component group per PR; e.g., components related to Table are grouped in packages/buefy-next/src/components/table
Include updates on relevant specs and docs in the PR
Focus on TypeScript migration. Do not try to fix bugs (some minor bug fixes may be unavoidable for migration)
Stick to Options API. I know Composition API is recommended, but it is too different and will make review impossible.

Except you substitute a missing <script> section in components under packages/docs, Options API is recommended because of its simplicity.
Add the name of the component group you worked on to the TS_COMPONENTS array in packages/buefy-next/rollup.config.mjs.
Run type-check both in packages/buefy-next and packages/docs before making a PR:
```
cd packages/buefy-next
npm run type-check
cd ../docs
npm run type-check
```
Run vitest before making a PR:
```
cd packages/buefy-next
npx vitest
```
The above command runs all the tests in TypeScript, you can also run a specific test. For instance:
```
npx vitest src/components/input/Input.spec.ts
```
Run lint both in packages/buefy-next and packages/docs before making a PR:
```
cd packages/buefy-next
npm run lint
cd ../docs
npm run lint
```
Ignore errors in files you did not touch.
Be prepare for massive rebase

I occasionally rebase migrate-to-typescript branch to reorganize sporadic changes on the same files, because it is difficult to anticipate all the type errors and may have to fix errors tens of commits later. If rebase happens, you have to cherry-pick your commits onto the new migrate-to-typescript.

Please review my commit history in migrate-to-typescript branch for more details about actual changes and how to comment your changes.

kikuomax commented 8 months ago

I am currently working on autocomplete.

kikuomax commented 8 months ago

I claim taginput.

kikuomax commented 8 months ago

I claim modal.

wesdevpro commented 8 months ago

I claim switch.

kikuomax commented 7 months ago

I claim dialog.

kikuomax commented 7 months ago

I claim toast.

kikuomax commented 7 months ago

I claim notification.

kikuomax commented 6 months ago

I claim snackbar.

kikuomax commented 6 months ago

I will rebase the migrate-to-typescript branch on top of the dev branch after we release 0.1.3.

kikuomax commented 6 months ago

I claim image.

kikuomax commented 4 months ago

@wesdevpro I have updated the contribution guide.

Add the name of the component group you worked on to the TS_COMPONENTS array in packages/buefy-next/rollup.config.mjs.

wesdevpro commented 3 months ago

I claim the Upload component

kikuomax commented 2 months ago

I started rebaseing the migrate-to-typescript branch on top of v0.1.4. Please expect massive changes in the commit history.

kikuomax commented 2 months ago

I started rebaseing the migrate-to-typescript branch on top of v0.1.4. Please expect massive changes in the commit history.

@wesdevpro I force-pushed the rebased migrate-to-typescript branch. When you make a PR to the migrate-to-typescript branch, please cherry-pick your latest commits onto the new migrate-to-typescript. I tagged the last commit of the migrate-to-typescript before rebaseing as migrate-to-typescript-pre-0.1.4. So you can list the commits to cherry-pick with:

git log migrate-to-typescript-pre-0.1.4..

kikuomax commented 2 months ago

I claim table.

kikuomax commented 2 months ago

I also claim select, because table depends on it.

kikuomax commented 2 months ago

I claim pagination which table also depends on.

kikuomax commented 2 months ago

I claim loading, because table depends on it.

AnthonyLoche commented 1 month ago

Hello how are you? I'm a student from Brazil, I'm studying computer science in high school, and I'm in the second year, and I need to move the styling from a project in vue 2, which uses scss, bulma and buefy, to a project in vue 3, but some variables are not declared, such as "$dropdown-item-hover-background-color", "$dropdown-item-hover-color", or even some mixins such as "include control-small, medium and large"; I would like to know if I need to use some specific version of bulma for this, or if the buefy package for vue 3 is still in development in the scss part, I would like to know, so I don't look for error where there is no solution. Something that I would really like, if necessary, is to be able to help in the development of the package or something I need, I believe that for my learning it would be very important, not for recognition, just knowledge. If possible, contact me, so we can talk, even by email if necessary. Thank you very much :); Sorry if there are some English mistakes, I'm still not 100% fluent;

wesdevpro commented 1 month ago

I claim Rate

wesdevpro commented 1 month ago

I claim RadioButton and Radio