Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

docs(import-blacklist): add some options examples #4858

Merged
merged 2 commits into from
Oct 5, 2019
Merged

docs(import-blacklist): add some options examples #4858

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
168eb8b
add example for regex and fix doc
tanmoyopenroot Sep 17, 2019
55f215a
fix optional description
tanmoyopenroot Oct 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/rules/importBlacklistRule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export class Rule extends Lint.Rules.AbstractRule {
In other cases, you may simply want to ban an import because using
it is undesirable or unsafe.`,
optionsDescription:
"A list of blacklisted modules, named imports, or regular expression patterns.",
"A list of blacklisted modules, named imports, or an array of expression patterns.",
tanmoyopenroot marked this conversation as resolved.
Show resolved Hide resolved
options: {
type: "array",
items: {
Expand Down Expand Up @@ -74,6 +74,8 @@ export class Rule extends Lint.Rules.AbstractRule {
optionExamples: [
true,
[true, "rxjs", "lodash"],
[true, [".*\\.temp$", ".*\\.tmp$"]],
[true, { lodash: ["pull", "pullAll"] }],
[true, "lodash", { lodash: ["pull", "pullAll"] }],
[true, "rxjs", { lodash: ["pull", "pullAll"] }, [".*\\.temp$", ".*\\.tmp$"]],
],
Expand Down