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

Feature/add prefix option #15

Merged
merged 2 commits into from
Nov 21, 2022
Merged

Feature/add prefix option #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbd89f7
provided prefix option
bobbypiperagrovista Oct 8, 2022
10956fa
readme typo
bobbypiperagrovista Oct 8, 2022
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
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Add the plugin to the plugins section, and configure the rule options.
...
"no-relative-import-paths/no-relative-import-paths": [
"warn",
{ "allowSameFolder": true, "rootDir": "src" }
{ "allowSameFolder": true, "rootDir": "src", "prefix": "" }
]
...
```
Expand Down Expand Up @@ -85,3 +85,24 @@ import Something from "components/something";
// ^- no 'src/' prefix is added
```

### `prefix`

Useful when auto-fixing and a prefix should be included in the absolute path.

Examples of code for this rule:

```js
// when not configured:
import Something from "../../components/something";

// will result in
import Something from "src/components/something";
```

```js
// when configured as { "prefix": "@" }
import Something from "../../components/something";

// will result in
import Something from "@/components/something";
```
15 changes: 9 additions & 6 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ function isSameFolder(path) {
return path.startsWith("./");
}

function getAbsolutePath(relativePath, context, rootDir) {
return path
function getAbsolutePath(relativePath, context, rootDir, prefix) {
return [
prefix,
...path
.relative(
context.getCwd() + (rootDir !== '' ? path.sep + rootDir : ''),
path.join(path.dirname(context.getFilename()), relativePath)
)
.split(path.sep)
.join("/");
].join("/");
}

const message = "import statements should have an absolute path";
Expand All @@ -35,9 +37,10 @@ module.exports = {
fixable: "code",
},
create: function (context) {
const { allowSameFolder, rootDir } = {
const { allowSameFolder, rootDir, prefix } = {
allowSameFolder: context.options[0]?.allowSameFolder || false,
rootDir: context.options[0]?.rootDir || '',
prefix: context.options[0]?.prefix || '',
};

return {
Expand All @@ -50,7 +53,7 @@ module.exports = {
fix: function (fixer) {
return fixer.replaceTextRange(
[node.source.range[0] + 1, node.source.range[1] - 1],
getAbsolutePath(path, context, rootDir || '')
getAbsolutePath(path, context, rootDir || '', prefix)
);
},
});
Expand All @@ -63,7 +66,7 @@ module.exports = {
fix: function (fixer) {
return fixer.replaceTextRange(
[node.source.range[0] + 1, node.source.range[1] - 1],
getAbsolutePath(path, context, rootDir || '')
getAbsolutePath(path, context, rootDir || '', prefix)
);
},
});
Expand Down