we need to determine JS/TS code policy

[tukib]

Problem

Both JavaScript and TypeScript exist and can be used in our project. We have no policy to inform contributors whether they can check in both files, or if we require JS-only or TS-only.

Context

For now, I propose we allow both. Our contributors have mixed preferences, so this is where we currently stand. No configuration changes need to be pushed for this.

• We have not yet encountered problems with either JS or TS, so picking one does not solve a current problem.
• For more about the differences between JS/TS see: we have no type safety for linting (TypeScript proposal) #59

this depends on

• Missing local contributing.md #39

[kbinreallife]

This issue seems to be in good shape and ready to close, thoughts?

[tukib]

@kbinreallife I think so. A short description in CONTRIBUTING.md would suffice. How about this (below)? Last point replaces the current section on tests. we can leave the whole esm/cjs thing for #71.

---

Editing remark/rehype plugins or react components may require making changes to code.

• Either JavaScript or TypeScript is permitted (any of .js .mjs .ts .jsx .tsx)
• When adding new files, try to conform to the existing structure.
  • e.g. it's reasonable to create the directory /src/plugins/remark/ for the first remark plugin, since we already have /src/plugins/rehype/ for rehype plugins.
• Every file should have a corresponding test file in the same directory that describes the intended behaviour, within reason.
  • e.g. foo.js and bar.ts should have tests foo.test.js and bar.test.ts