Improvements, refactoring and German language

[benjackwhite]

I'm going to have another attempt at merging this in here as I think I've made some solid improvements to the core of the codebase and I have a vested interest in the project (I'm using my fork actively in my app https://mealyo.app).

Major changes

• Splitting out of languages to separate files and adding of German language
• Quality of life improvements like automate-actions, simplified linting tools
• Fixing of a lot of failing tests
• Typing improvements
• This also has a slightly nicer regex solution for units which solves Escape '.' on eng singular units. #3 without needing to comment out . characters

Other Suggestions

1. I removed the q.b. code. This is Italian specific but is in the shared code which isn't great.

• Suggestion - keep it removed. This is quite a specific logic and imo should be handled by the calling code and not by the library

2. Suggestion multiLineParse should be removed. This is again quite specific and depends on the caller (especially the hard coded emojis). This lib parses ingredients from a string, I think making it also have logic for splitting lines based on something that is clearly
3. Make me a maintainer 😀

• I think this repo has the potential to become the canonical ingredient-parsing repo for JS (there are a bunch of forks currently - almost one per language). With an extra maintainer I can help drive things forward (my languages are English and German) as well as be a sounding board for these more questionable additions (like the two I mentioned above).

[benjackwhite]

@suprmat95 if you enable Issues on the project I can happily create an issue to discuss adding me as a Maintainer separate to this PR.

If you are not interested in outside contributions that's totally fine, just let me know and I can publish my own package (not so ideal) to npm and go from there. @scolobey seems to have some interest in this repo as well so can weigh in with their thoughts

[suprmat95]

Hi, @benjackwhite and @scolobey your contributions are welcome :)

As @benjackwhite said, I use this parser for an Italian important project, so it's really important that all the Italian tests I already wrote continue to work. I will continue to work mainly on the Italian language because my project still supports only Italian.

About your suggestions:

1. I can't remove q.b. It's the most used quantity in Italian recipes xD. It's the same for t.t. in English
2. Many people have the recipes saved on the notes of their smartphone and they copy and paste ingredients on my application. I think that many other applications or projects have the same need and for this, I integrate this feature directly into this library. There are two separate functions to handle one or more strings.
3. Yes If you agree not to break what I have done for the Italian language!

I believe in open source and I want to accept your contributions. Together we can become the canonical ingredient-parsing repo for JS :)

[scolobey]

The goal as I see it is a workable base incorporating most of the @benjackwhite changes.

This is the @benjackwhite test for no unit/no quantity.

it("doesn't explode when no unit and no quantity provided", () => {
    expect(parse('zucchero a velo', 'ita')).to.deep.equal({
      unit: null,
      unitPlural: null,
      symbol: null,
      ingredient: 'zucchero a velo',
      quantity: 0,
      minQty: 0,
      maxQty: 0,
    });
  });

If I understand correctly @suprmat95 needs something more look like this...

it("doesn't explode when no unit and no quantity provided", () => {
    expect(parse('zucchero a velo', 'ita')).to.deep.equal({
      unit: 'q.b',
      unitPlural: 'q.b',
      symbol: null,
      ingredient: 'zucchero a velo',
      quantity: 0,
      minQty: 0,
      maxQty: 0,
    });
  });

Is that correct @suprmat95 ?

If so, I think we just need a quick solution for getting the amended test to pass without causing problems for eng or deu languages. Then we can explore improved solutions in future PR's?

Here is one possible solution where all tests should be passing, including the amended (no unit/no quantity) test as described. #5

[benjackwhite]

I believe in open source and I want to accept your contributions. Together we can become the canonical ingredient-parsing repo for JS :)

I think so too! But for it to be that we need to make sure no more Italian-only changes make it in to the repo like the q.b. change as then it only is useful for you 😅 (and other Italian speakers).

@scolobey's changes make sense to me 👍