crowdin / crowdin/crowdin-api-client-js

Crowdin JavaScript client v2

Open
#432 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
139
Forks
67
Avg merge
3h 52m
Merged PRs (30d)
13

Description

It's been a while since the v1 release, and in that time a lot of deprecations and legacy code have accumulated. There have also been some big changes in the ecosystem that could be addressed in the new major release.

**Things to be done:**

- [ ] Remove all the deprecations from the codebase.
- [ ] Check the Crowdin API docs for other deprecations that aren't reflected in the client.
- [ ] Update Node version requirement.
- [ ] Update CI/CD Workflows (https://github.com/crowdin/crowdin-api-client-js/blob/master/.github/workflows/publish.yml#L25)
- [ ] Use Typescript 6 (#450)
- [ ] Bump all dependencies to the latest versions.
- [ ] Align method names with the API naming convention. For example, the names "List Tasks" and "List Project Tasks" were changed in the API.
- [ ] Dedicated, strictly typed interfaces for PATCH requests instead of the generic `PatchRequest[]`
- [ ] Use native Node fetch instead of Axios.
- [ ] ESM-only
- [ ] FIx User Interfaces (#586)
- [ ] ...

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Crowdin API documentation for deprecations and the publish workflow in .github/workflows/publish.yml, then inspect the related issues #450 and #586. The work is complete when the listed v2 changes are implemented, dependencies and Node requirements are updated, and the client is ready for the new major release.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, typescript
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.