Skip to content

Commit 9a5288f

Browse files
committed
Attempting to link to the rules section, like a cool guy. Not sure if it will work... need to see it on GitHub.
1 parent 0d96f4c commit 9a5288f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ This plugin intends to support linting of ES6 import syntax, and prevent issues
55

66
Current support:
77

8-
* Ensures relative imports point to a file that exists. (rule: `valid-relative-path`)
8+
* Ensures relative imports point to a file that exists. ([`valid-relative-path`][#valid-relative-path])
99

1010
Planned:
1111

1212
* Validate that named imports match named exports.
1313
* Validate that `*` imports exist as named exports in remote file, where dereferenced.
1414
* Validate that a default export exists, when imported.
15+
16+
17+
## Rules
18+
19+
### `valid-relative-path`
20+
21+
Ensures an imported file with a relative path exists at that path. Default search extensions are `[".js", ".coffee", ".es6"]`. Provide an alternative array if you want more or fewer. Also, note that you'll need to provide `""` as an extension if you reference your imports with the full extension inline (i.e. `import foo from './bar.js'`).

0 commit comments

Comments
 (0)