Skip to content
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.

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

Improvements to package.json #2

Closed
njkleiner opened this issue May 11, 2020 · 1 comment · Fixed by #4
Closed

Improvements to package.json #2

njkleiner opened this issue May 11, 2020 · 1 comment · Fixed by #4
Assignees

Comments

@njkleiner
Copy link
Contributor

First of all, thank you so much for making this. I've desperately been looking for a NodeJS microformats parser to the point where I considered writing my own since the only other one is quite broken. I really appreciate you taking the time to make this, especially since the demand is somewhat low.

When taking a quick look at the project, I noticed some problems with your package.json.

issue: The author field is malformed.

The current value of Aimee Gamble-Milner <https://github.com/aimee-gm> does not parse correctly, because angle brackets are supposed to be used for the author's email address. (The author's website is enclosed in parentheses).

See also: https://docs.npmjs.com/files/package.json#people-fields-author-contributors

suggestion: Explicitly declare the supported versions of Node using the engines property.

The CONTRIBUTING file mentions:

We support all versions that are currently supported on the node LTS schedule.

Therefore I suggest adding the following to the package.json file (v10 is currently the oldest LTS version):

{
    "engines": {
        "node": ">=10"
    }
}

See also: https://docs.npmjs.com/files/package.json#engines

suggestion: Use the files property instead of a .npmignore file.

See also:

aimee-gm added a commit that referenced this issue May 11, 2020
also adds engines and files properties; removes .npmignore. Fixes #2
@aimee-gm
Copy link
Member

Thank you for these suggestions - I've just finished writing this package this morning so had not got round to these! 🙂

I agree with both of your suggestions too, and I have included them in the PR #4 to resolve all of them.

I'm glad I could help - I too was motivated by the other available package being quite broken.

If you find any other problems while trying it out, please let me know and I will do my best to fix it!

@aimee-gm aimee-gm self-assigned this May 11, 2020
aimee-gm added a commit that referenced this issue May 11, 2020
also adds engines and files properties; removes .npmignore. Fixes #2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants