Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance #82

Open
6 tasks
tommy-mitchell opened this issue Aug 16, 2023 · 4 comments
Open
6 tasks

Maintenance #82

tommy-mitchell opened this issue Aug 16, 2023 · 4 comments

Comments

@tommy-mitchell
Copy link

tommy-mitchell commented Aug 16, 2023

The following is a list of internal refactors:

  • Rewrite in TypeScript
  • Move to ESM (Move to ESM #83)
  • Replace the current continuation pattern with generator functions
  • Use newer JS features/syntax, e.g:
  • Remove old code (e.g. function name properties)
  • Add documentation for contributing

Original description

@novemberborn in avajs/ava#1861 (comment), you mention that Concordance is in need of some love. While the issues here are good for tracking enhancements, I think it would be good to track refactor/maintenance items in a single issue.

What are some things you think need improved? Listing them would make it easier for people to pick one and help out.

Some thoughts of my own:

  • Rewrite in ESM, use newer JS features/syntax
  • Add documentation about internals for new contributors
@novemberborn
Copy link
Member

TypeScript would be good, too. There's some very old stuff that is no longer relevant (function name properties if I recall). And there's a continuation pattern that should be replaced by generator functions.

@tommy-mitchell
Copy link
Author

Do you mean adding type definitions, or rewriting in TypeScript?

@novemberborn
Copy link
Member

Rewrite. There’s a lot of complex logic that would benefit from typesafety.

@tommy-mitchell
Copy link
Author

tommy-mitchell commented Aug 16, 2023

I've updated the issue description with a list, feel free to edit and add items.

Are you wanting to update the code style as well, e.g. with xo, a .editorconfig, etc.?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants