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.

Sign up for GitHub

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

Jump to bottom

Docs: Mention workaround for escaping the slash character in selectors #14675

Merged
merged 2 commits into from Aug 5, 2021
Merged

Docs: Mention workaround for escaping the slash character in selectors #14675

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f57f965
Docs: Mention workaround for the regex escape character
AriaMinaei Jun 5, 2021
c858cb5
Update docs/developer-guide/selectors.md
nzakas Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/developer-guide/selectors.md
View file
Open in desktop
Expand Up @@ -31,7 +31,7 @@ The following selectors are supported:
* wildcard (matches all nodes): `*`
* attribute existence: `[attr]`
* attribute value: `[attr="foo"]` or `[attr=123]`
* attribute regex: `[attr=/foo.*/]`
* attribute regex: `[attr=/foo.*/]` <sub>(with some [known issues](#known-issues))</sub>
* attribute conditions: `[attr!="foo"]`, `[attr>2]`, `[attr<3]`, `[attr>=2]`, or `[attr<=3]`
* nested attribute: `[attr.level2="foo"]`
* field: `FunctionDeclaration > Identifier.id`
Expand Down Expand Up @@ -131,3 +131,7 @@ Or you can enforce that calls to `setTimeout` always have two arguments:
```

Using selectors in the `no-restricted-syntax` rule can give you a lot of control over problematic patterns in your codebase, without needing to write custom rules to detect each pattern.

### Known issues

Due to a [bug](https://github.com/estools/esquery/issues/68) in [esquery](https://github.com/estools/esquery), regular expressions that contain a forward-slash character `/` aren't porperly parsed, so `[value=/some\/path/]` will be a syntax error. As a [workaround](https://github.com/estools/esquery/issues/68), you can replace the `/` character with its unicode counterpart, like so: `[value=/some\\u002Fpath/]`.
nzakas marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\\ in [value=/some\\u002Fpath/] might be confusing. Selector itself should have only one \, while the other \ is required only if the selector is represented in a string literal?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest only \ here (like it is in [value=/some\/path/]), and an example that disallows import from foo/bar:

{
  "rules": {
    "no-restricted-syntax": ["error", "ImportDeclaration[source.value=/foo\\u002Fbar/]"]
  }
}