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

pkglint should guarantee node runtime compatibility #1194

Closed
RomainMuller opened this issue Nov 16, 2018 · 0 comments · Fixed by #1205
Closed

pkglint should guarantee node runtime compatibility #1194

RomainMuller opened this issue Nov 16, 2018 · 0 comments · Fixed by #1205
Assignees
Labels
feature-request A feature should be added or improved.

Comments

@RomainMuller
Copy link
Contributor

We need to introduce a pkglint rule that prevents inadvertently breaking the node runtime compatibility (currently >= 8.11.0), and make sure this can validate the top-level package.json (since it currently is ignored).

This would prevent re-occurrence of the issue introduced in #692 and corrected in #1193.

@RomainMuller RomainMuller self-assigned this Nov 16, 2018
RomainMuller added a commit that referenced this issue Nov 19, 2018
This adds a rule to make sure the codebase is all configured to support
node runtimes complying with `>= 8.11.0`, by ensuring that the
configured `@types/node` version starts with `^8.`.

In order to allow applying this rule to the top-level `package.json`, a
feature was added to `pkglint` that allows users to confgure `include`
and `exclude` filters as part of their `package.json`'s `pkglint` setup.
Exclusions always have precedence over inclusions, and specifying
`disable: true` has the same effect as specifying `exclude: '*'`. Both
the `include` and `exclude` values can contain patterns that use `*` as
a wild-card that maches any number of characters (including no
character at all), and can be either a single pattern, or an array of
patterns. `include` defaults to `*`.

Fixes #1194
RomainMuller added a commit that referenced this issue Nov 19, 2018
This adds a rule to make sure the codebase is all configured to support
node runtimes complying with `>= 8.11.0`, by ensuring that the
configured `@types/node` version starts with `^8.`.

In order to allow applying this rule to the top-level `package.json`, a
feature was added to `pkglint` that allows users to confgure `include`
and `exclude` filters as part of their `package.json`'s `pkglint` setup.
Exclusions always have precedence over inclusions, and specifying
`disable: true` has the same effect as specifying `exclude: '*'`. Both
the `include` and `exclude` values can contain patterns that use `*` as
a wild-card that maches any number of characters (including no
character at all), and can be either a single pattern, or an array of
patterns. `include` defaults to `*`.

Fixes #1194
@srchase srchase added feature-request A feature should be added or improved. and removed enhancement labels Jan 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants