chore: Add rule to guarantee node runtime compatibility #1205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
rix0rrr
approved these changes
Nov 19, 2018
srchase
added
feature-request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a rule to make sure the codebase is all configured to support
node runtimes complying with
>= 8.11.0, by ensuring that theconfigured
@types/nodeversion starts with^8..In order to allow applying this rule to the top-level
package.json, afeature was added to
pkglintthat allows users to confgureincludeand
excludefilters as part of theirpackage.json'spkglintsetup.Exclusions always have precedence over inclusions, and specifying
disable: truehas the same effect as specifyingexclude: '*'. Boththe
includeandexcludevalues can contain patterns that use*asa 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.
includedefaults to*.Fixes #1194