Added isFreightContainerID validator

[songyuew]

Added isContainerID validator

Check whether a string is an ISO6346 shipping container identification.

https://en.wikipedia.org/wiki/ISO_6346

Please review my PR, thanks!

Checklist

• PR contains only changes related; no stray files, etc.
• README updated (where applicable)
• Tests written (where applicable)

[codecov]

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (147f15a) compared to base (54d330c).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #2144   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          105       106    +1     
  Lines         2324      2348   +24     
  Branches       586       593    +7     
=========================================
+ Hits          2324      2348   +24     

Impacted Files	Coverage Δ
src/index.js	100.00% <100.00%> (ø)
src/lib/isISO6346.js	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[pano9000]

I feel like this could be rewritten to ^[0-9]$, since you are checking against each string character using its index, and that will always be just one character

Also maybe just a matter of taste in general, but this project seems to be generally prefering the use of regular expression literals. as opposed to a constructor function, like you used here.
So for the sake of style consistency, I would probably also suggest the following change:

new RegExp('^[0-9]{1}')-> const isDigit = /^[0-9]$/
(same applies to the isContainerIdReg regexp in line 4)

[songyuew]

Hi Panagiotis,

Thank you very much for pointing it out! I have updated the corresponding lines.

[pano9000]

I have the same concerns about this, as I have mentioned in your other PR:
#2143

what do you think?

[profnandaa]

You are right @pano9000 -- I don't think we should be doing cleaning behind the validators, let the users do their own cleaning. @songyuew pls update.

[pano9000]

I think the name might be a bit too unspecific, as "container ID" feels a bit too generic, e.g. just google it, brought up several hits, like e.g. "docker container ID", "Windows Drivers Container ID", etc.

So I would probably say it makes sense to rename this?

Options could be maybe:

• isShippingContainerID
• isISO6346ContainerID (that one does look ugly to be honest :-D)
• ?

What do you think?

[WikiRik]

We already have some ISO standards so a simple isISO6346 could also suffice

[songyuew]

I have changed it to isISO6346, for consistency with other validators.

[pano9000]

thank you for the PR :-)
Interesting to see what kind of numbers there are out there in the world :-D

[songyuew]

thank you for the PR :-) Interesting to see what kind of numbers there are out there in the world :-D

Haha thank you Panagiotis for reviewing my PR once again.

[profnandaa]

This was also interesting to me, learned something new! Thanks for the PR!

[profnandaa]

LGTM, thanks! 🎉

[profnandaa]

QQ, do you want to add isFreightContainerID too as an alias to isISO6346? I recommend adding Freight to it for clarity. @songyuew

[songyuew]

Hi Nandaa,

Do you mean adding a new file with the name of isFreightContainerID, or simply just creating a new entry in the readme?

[pano9000]

hi guys,

one tiny thing I'd like to still see adressed is my comment above regarding the use of str.trim()
#2144 (comment)

[profnandaa]

Hi Nandaa,

Do you mean adding a new file with the name of isFreightContainerID, or simply just creating a new entry in the readme?

@songyuew -- not really a new file, just within the same file, exporting the isFreightContainerID = isISO6346; and exporting both.

[songyuew]

Hi Nandaa,
Do you mean adding a new file with the name of isFreightContainerID, or simply just creating a new entry in the readme?

@songyuew -- not really a new file, just within the same file, exporting the isFreightContainerID = isISO6346; and exporting both.

@profnandaa @pano9000 Alias added and sanitization removed, plz kindly review, thanks!

[profnandaa]

My bad, I don't know how we missed this one, should have gone into the previous release. I'll queue it up for the next one.

[profnandaa]

LGTM. If you can fix the m/c, I'll merge it straight away.