smhg / smhg/gettext-parser

Repository Refactoring (proposal)

Open
#82 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #86 by @erikyo — closed without merging
Dominant language
JavaScript
Stars
169
Forks
48
PR merge metrics
No merged PRs in 30d

Description

In order to avoid making a huge PR with generic changes, I'm going to write a tracking issue here that lists the changes I would like to propose, in that way we will have a sort of changes tracking to isolate changes by 'type'.

This issue supersedes #80, which involved a series of structural changes too delicate to be made all at once.

  • #81 - This pr is used to add typescript as a dependency, use it to generate types and add type references inside files
  • #85 - Move files from lib to src (including index.js)
  • #84 - Remove deprecations (slice, substr)
  • #90 - removes deprecations
  • #87 - Remove the safe-buffer library, it's a fallback for node <5.0, but since we are requiring node >16 it's pretty useless
  • #88 - Speed up parser replacing regex with string comparison when possible
  • #89 - Enhances the jsDocs
  • #96 - Coverage report
  • #97 #98 - Full tests coverage
  • #83 - Update changelog, version and readme (require should be replaced with import)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

This is a tracking issue for repository refactoring, with completed work covering lib, src, index.js, TypeScript references, deprecations, parser performance, and JsDocs. Start by reading the remaining linked issues #97, #98, and #83, since this issue does not define their implementation details. Done means those checklist items are resolved and the tracking list reflects their status.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
tooling
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.