Skip to content

[WIP] Towards 1.0.0 #3

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 211 commits into
base: master
Choose a base branch
from
Draft

[WIP] Towards 1.0.0 #3

wants to merge 211 commits into from

Conversation

matteodelabre
Copy link
Owner

This branch is for preparation of the 1.0.0 release.
Work should be done in the following fields.

Documentation:

  • Remove API docs from README.md
  • Move contributing guide to CONTRIBUTING.md
  • Add coverage badge
  • Create CHANGELOG.md
  • Fix link to v1.0.0 release in CHANGELOG
  • Rewrite examples
  • Write API docs in the wiki

Code:

  • Remove device classes
  • Move events classes out of the file submodule, so that they can be easily reused
  • Remove dependency on unstable buffercursor

API:

  • Avoid throwing with unknown events and keep unknown bytes
  • Make it easier to write MIDI files in the code
  • Improve compatibility between device-parsing and file-parsing
  • Abandon classical inheritance in favour of object composition
  • Make sending and receiving events from devices API-abstracted

Features:

  • Full compatibility between Node.JS and the browser
  • Support all controllers
  • Improve compatibility with system exclusive messages

Tests:

  • Rewrite tests with tape
  • > 90% test coverage

mattoufp added 23 commits July 25, 2015 12:58
🐛 Fix eslintrc
e436b61
💡 Abstract input/outputs devices
93a1923
📒 Remove old implementation
bc85fed
📖 Add INSTALL instructions
235c2eb
💡 Improve device/ API
9eaf611
💄 Requiring Buffer is not necessary
7445dcb
💡 Move events code in a separate folder
1c6c2b8
💡 Improve events
74e51c2
💡 Stop relying on unstable buffercursor
8223fca
💡 Move error to util/ and separate hex formatting
9251bff
💡 Use events classes for decoding
5bf8de8 
This improves interoperability between file
reading and device interaction
💡 Merge chunk decoders and encoders
70098b3
📖 Improve sysex docs
8988e92
📒 Remove old events stuff
22ff7cb
💡 Merge header/track encoders and parsers
09fd337
📖 Add TODO
168f965
💡 Add devices file
8c0506b
💡 Encode with running status
5176ef8
💡 Add track encoding
d2b0ec4
💡 Improve buffer utils
77b0722
💡 Add track decoding
05a33df
💡 Enable reading running status in events
0034feb
📒 Move file
53029f6
@matteodelabre matteodelabre self-assigned this Jul 31, 2015
@matteodelabre
📖 Add docs for Context
a8e6bf8
@matteodelabre
📖 Update CHANGELOG.md with Context
12bd8f0
@matteodelabre
📖 Update README.md with Context
e1aa34c
@matteodelabre
💄 Normalize package.json
8214700
@matteodelabre
💄 Update eslint rules
5217d25
@matteodelabre
📖 Fix typos in README
ddd1112
@matteodelabre
📖 Update contrib guide
940fb6e
@matteodelabre
📖 Improve change log
e4a298c
@matteodelabre
📖 Remove separators in change log
94c6b68
@matteodelabre
📖 Use small subtitles
fccf0a5
@matteodelabre
💡 convertNote is a no-op if the note is already a number
8a98047
@matteodelabre
💡 Rewrite File & Track API: they are no longer classes
0fb213d 
File & Track are now stamps. This allows for easier composition
and several other benefits. (see https://github.com/stampit-org/stampit)

Remove the tight coupling between File & Track.
Improve decoding error messages.
@matteodelabre
💡 Rewrite test suite after File API shift
335fbd9
@matteodelabre
💡 Add stampit dep
01b53cb
@matteodelabre
💡 Only support 4.2.6 and onwards
bae15bc
@matteodelabre
💡 Do not use custom errors anymore
461c91a
@matteodelabre
💄 Two spaces in travis.yml
100f006
@matteodelabre
📖 Fix badges
936a9d9
@matteodelabre
💄 Rewrite convert-note to ES6
ff9d255
@matteodelabre
💡 Add stampit & TextEncoding deps
625ac0a
@matteodelabre
💡 Replace MIDIBuffer with SeekerView and MIDIView
ed7392c 
Now using native typed arrays instead of Node's Buffers.
This allows for a better flexibility between web and server,
given the fact that Node's Buffers are now just wrappers for
Uint8Arrays.
@matteodelabre
💡 Rewrite file encoding & decoding with new MIDIView & SeekerView
fa81684
@matteodelabre
💡 Remove Buffer tests from util.js
ee0f6f6
@matteodelabre
💡 Add tests for MIDIView & SeekerView
00ef501
@matteodelabre
🐛 Fix wrong method call in MIDIView
ddd0273
@matteodelabre
🐛 Fix undefined reference in SeekerView
2531016
@matteodelabre
📒 convert-note.js -> convertnote.js
1b0cf60
@matteodelabre
💄 Fix typo in test name
1657f63
@matteodelabre matteodelabre mentioned this pull request Aug 9, 2017
Open
@matteodelabre matteodelabre marked this pull request as draft November 26, 2021 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@matteodelabre matteodelabre

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@matteodelabre @corentingurtner