Skip to content

Commit fd69c06

Browse files
raphaajraphaaj
committed
chore(release): 1.0.0-alpha.1
1 parent 9a29c5b commit fd69c06

File tree

3 files changed

+108
-3
lines changed

3 files changed

+108
-3
lines changed

‎CHANGELOG.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,111 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
## [1.0.0-alpha.1](https://github.com/raphael-jorge/tablab/compare/v1.0.0-alpha.0...v1.0.0-alpha.1) (2021-08-09)
6+
7+
8+
### ⚠ BREAKING CHANGES
9+
10+
* - It is not possible anymore to set a custom spacing character to be
11+
used at the header and footer sections of a tablature element.
12+
- It is not possible anymore to set a custom instructions separator
13+
character to be used by a parser instance.
14+
* **instruction:** Changes in the InvalidInstructionReason enumerator:
15+
- Members renamed:
16+
- UnmappedReason > UnknownReason;
17+
- MethodInstructionWithoutIdentifier > UnidentifiedMethodInstruction;
18+
- MethodInstructionWithUnmappedIdentifier > UnknownMethodInstruction;
19+
- WriteNoteInstructionInvalid > BasicInstructionInvalid;
20+
- WriteNoteInstructionWithNonWritableNote > BasicInstructionWithNonWritableNote;
21+
- WriteHeaderInstructionWithoutArguments > HeaderInstructionWithoutArguments;
22+
- WriteHeaderInstructionWithUnmappedArguments > HeaderInstructionWithUnmappedArguments;
23+
- WriteHeaderInstructionWithInvalidHeader > HeaderInstructionWithInvalidHeader;
24+
- WriteFooterInstructionWithoutArguments > FooterInstructionWithoutArguments;
25+
- WriteFooterInstructionWithUnmappedArguments > FooterInstructionWithUnmappedArguments;
26+
- WriteFooterInstructionWithInvalidFooter > FooterInstructionWithInvalidFooter;
27+
- SetSpacingInstructionWithoutArguments > SpacingInstructionWithoutArguments;
28+
- SetSpacingInstructionWithUnmappedArguments > SpacingInstructionWithUnmappedArguments;
29+
- SetSpacingInstructionWithInvalidSpacingValueType > SpacingInstructionWithInvalidSpacingValueType;
30+
- SetSpacingInstructionWithInvalidSpacingValue > SpacingInstructionWithInvalidSpacingValue;
31+
- Member values updated.
32+
* **parser:** Changes in the parser class:
33+
- The field methodInstructionArgsOpeningEnclosure now becomes the
34+
methodInstructionArgsEnclosure field, which receives a value of the
35+
Enclosure enumerator.
36+
- The field methodInstructionTargetsOpeningEnclosure now becomes the
37+
methodInstructionTargetsEnclosure field, which receives a value of the
38+
Enclosure enumerator.
39+
- The static field DEFAULT_METHOD_INSTRUCTION_ARGS_OPENING_ENCLOSURE now
40+
becomes the DEFAULT_METHOD_INSTRUCTION_ARGS_ENCLOSURE static field, which
41+
has a value of the Enclosure enumerator.
42+
- The static field DEFAULT_METHOD_INSTRUCTION_TARGETS_OPENING_ENCLOSURE
43+
now becomes the DEFAULT_METHOD_INSTRUCTION_TARGETS_ENCLOSURE static field,
44+
which has a value of the Enclosure enumerator.
45+
* **tab:** Changes in the tablature element class:
46+
- Rename field `filler` to `spacingCharacter`
47+
- Rename filed `sectionFiller` to `sectionSpacingCharacter`
48+
- Rename field `sectionSymbol` to `sectionDivisionCharacter`
49+
- Rename static field `DEFAULT_FILLER` to `DEFAULT_SPACING_CHARACTER`
50+
- Rename static field `DEFAULT_SECTION_FILLER` to `DEFAULT_SECTION_SPACING_CHARACTER`
51+
- Rename static field `DEFAULT_SECTION_SYMBOL` to `DEFAULT_SECTION_DIVISION_CHARACTER`
52+
- Rename method `getSectionFiller` to `getSectionSpacing`
53+
- Rename method `getStringsFiller` to `getStringsSpacing`
54+
* **instructions:** Move all invalid instruction reasons to the InvalidInstructionReason enumerator.
55+
The InvalidInstructionBaseReason enumerator no longer exists.
56+
* **tab:** Rename method `isNoteInStringsRange` at tablature elements to `isNoteWritable`
57+
* **tab:** Rename fields at tablature elements:
58+
- Rename static field `DEFAULT_NUMBER_OF_ROWS` at tablature elements to `DEFAULT_NUMBER_OF_STRINGS`
59+
- Rename field `numberOfRows` at tablature elements to `numberOfStrings`
60+
- Rename `getRowsFiller` method at tablature elements to `getStringsFiller`
61+
- Rename `rows` field at tablature blocks to `strings`
62+
* Rename elements in the public API and remove some
63+
unecessary methods:
64+
65+
- Rename InstructionMethodData to MethodInstructionData
66+
- Rename InstructionBuilder to MethodInstructionBuilder
67+
- Rename instance property instructionMethodIdentifiersEnabled at
68+
InstructionFactoryBase to methodInstructionIdentifiersEnabled
69+
- Rename instance property instructionMethodIdentifier2InstructionBuilderMap
70+
at InstructionFactoryBase to methodInstructionIdentifier2InstructionBuilderMap
71+
- Rename InstructionMethodIdentifier to MethodInstructionIdentifier
72+
- Rename MethodResult to ParsedMethodInstructionData. It no longer have
73+
the instance method named asInstructionMethodData.
74+
- Rename ParserResult to ParsedInstructionData. It no longer have the instance
75+
method named asInstructionData.
76+
77+
### Features
78+
79+
* **parser:** allow parsed instructions to be written to tabs directly ([770999c](https://github.com/raphael-jorge/tablab/commit/770999c0c68df48f01e496f878d4de346df09629))
80+
* remove not implemented options ([2d33f2e](https://github.com/raphael-jorge/tablab/commit/2d33f2ebd931ad991babfbabc9f076fd363ad2f1))
81+
* **tab:** add a method to set a tab element spacing using the fluent API ([a894c9e](https://github.com/raphael-jorge/tablab/commit/a894c9e81315c86da1a9ebc7b296594b3a839382))
82+
83+
84+
### Bug Fixes
85+
86+
* **tab:** fix the creation of empty blocks on formatting ([206e284](https://github.com/raphael-jorge/tablab/commit/206e28417d8506d0e582c3bc3207307424bb80d2))
87+
88+
89+
### Code Refactoring
90+
91+
* **enclosures-helper:** update values of the Enclosure enum to reflect its keys ([cf9aacc](https://github.com/raphael-jorge/tablab/commit/cf9aacca64907ff58baf5252bdf8a751a1e0a606))
92+
* **helpers:** remove circular dependency from string helper and enclosures helper ([e98c6e6](https://github.com/raphael-jorge/tablab/commit/e98c6e6c1e1d750b7d87a12dc5370ff41f83ca93))
93+
* **instruction:** improve failure reasons identification and description ([ca1342c](https://github.com/raphael-jorge/tablab/commit/ca1342cf9eb0f347bd1d110b7c2ba30f69ff299d))
94+
* **instruction:** simplify project structure ([02b6724](https://github.com/raphael-jorge/tablab/commit/02b67246b5c03330d9a82d2ee754969876e193ab))
95+
* **instructions:** set the success property as a field at the InstructionWriteResult class ([1b3d59e](https://github.com/raphael-jorge/tablab/commit/1b3d59ea08c8b30f6a0d057f96b80eb47c536a5f))
96+
* **instructions:** unify enumerators for invalid instruction reasons ([32769bf](https://github.com/raphael-jorge/tablab/commit/32769bf18a5f23d5e9daf50f258db8c342415aaf))
97+
* **instructions:** update method instructions identifiers to reflect its default aliases ([ce382f0](https://github.com/raphael-jorge/tablab/commit/ce382f01290eb4438282b4aff65392c5e152bd6f))
98+
* **parser:** rename fields of the parser to improve usability ([37f011a](https://github.com/raphael-jorge/tablab/commit/37f011a6d786a513b11fe44d310c901207fcc6f3))
99+
* **tab:** rename fields and methods of the tablature element class to improve clarity ([0692ed1](https://github.com/raphael-jorge/tablab/commit/0692ed19195b82656832eaf978f31f04fe0c2a2e))
100+
* **tab:** rename the method that checks if a note is writable to a tablature element ([347255d](https://github.com/raphael-jorge/tablab/commit/347255dc9f3b381cadf8066c61b6719c95ab6cd2))
101+
* **tab:** use strings instead of rows to reference the strings section of tablature elements ([bd68c4a](https://github.com/raphael-jorge/tablab/commit/bd68c4aaf8e3d8f1140e9e4e38f5e8626e264fa0))
102+
* uniformize names of variables and references ([30ff47b](https://github.com/raphael-jorge/tablab/commit/30ff47b76170ac34ca3810985fbb4eedf2ebde85))
103+
104+
105+
### Build Operations
106+
107+
* add rollup bundler ([f555001](https://github.com/raphael-jorge/tablab/commit/f555001ad6ab0115a99b6459419a358765ede75a))
108+
* update dependencies ([9a29c5b](https://github.com/raphael-jorge/tablab/commit/9a29c5b1685317c6abb2602179932c15d45594ab))
109+
5110
## 1.0.0-alpha.0 (2021-03-14)
6111

7112

‎package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tablab",
3-
"version": "1.0.0-alpha.0",
3+
"version": "1.0.0-alpha.1",
44
"description": "A javascript library to write tablatures",
55
"keywords": [
66
"tabs",

0 commit comments

Comments
 (0)