Skip to content

Commit 3ea1050

Browse files
committed
Move URL generation to a function
Move the common string of the URL to a function that is called. Note that `imports-first` still has a fully defined URL in the rule file as the documentation for that rule requires a specific blob id since it has been deleted on `master`.
1 parent a56c1c0 commit 3ea1050

35 files changed

Lines changed: 81 additions & 92 deletions

src/docsUrl.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
2+
3+
export default function docsUrl(ruleName) {
4+
return `${ruleDocsUrl}/${ruleName}.md`
5+
}

src/rules/default.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import Exports from '../ExportMap'
2-
3-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
2+
import docsUrl from '../docsUrl'
43

54
module.exports = {
65
meta: {
76
docs: {
8-
url: `${ruleDocsUrl}/default.md`,
7+
url: docsUrl('default'),
98
},
109
},
1110

src/rules/export.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import ExportMap, { recursivePatternCapture } from '../ExportMap'
2-
3-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
2+
import docsUrl from '../docsUrl'
43

54
module.exports = {
65
meta: {
76
docs: {
8-
url: `${ruleDocsUrl}/export.md`,
7+
url: docsUrl('export'),
98
},
109
},
1110

src/rules/exports-last.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1+
import docsUrl from '../docsUrl'
2+
13
function isNonExportStatement({ type }) {
24
return type !== 'ExportDefaultDeclaration' &&
35
type !== 'ExportNamedDeclaration' &&
46
type !== 'ExportAllDeclaration'
57
}
68

7-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
8-
99
module.exports = {
1010
meta: {
1111
docs: {
12-
url: `${ruleDocsUrl}/exports-last.md`,
12+
url: docsUrl('exports-last'),
1313
},
1414
},
1515

src/rules/extensions.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import path from 'path'
22

33
import resolve from 'eslint-module-utils/resolve'
44
import { isBuiltIn, isExternalModuleMain, isScopedMain } from '../core/importType'
5+
import docsUrl from '../docsUrl'
56

67
const enumValues = { enum: [ 'always', 'ignorePackages', 'never' ] }
78
const patternProperties = {
@@ -15,7 +16,6 @@ const properties = {
1516
'ignorePackages': { type: 'boolean' },
1617
},
1718
}
18-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
1919

2020
function buildProperties(context) {
2121

@@ -56,7 +56,7 @@ function buildProperties(context) {
5656
module.exports = {
5757
meta: {
5858
docs: {
59-
url: `${ruleDocsUrl}/extensions.md`,
59+
url: docsUrl('extensions'),
6060
},
6161

6262
schema: {

src/rules/first.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
1+
import docsUrl from '../docsUrl'
22

33
module.exports = {
44
meta: {
55
docs: {
6-
url: `${ruleDocsUrl}/first.md`,
6+
url: docsUrl('first'),
77
},
88
},
99

src/rules/group-exports.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
1+
import docsUrl from '../docsUrl'
2+
23
const meta = {
34
docs: {
4-
url: `${ruleDocsUrl}/group-exports.md`,
5+
url: docsUrl('group-exports'),
56
},
67
}
78
/* eslint-disable max-len */

src/rules/max-dependencies.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import isStaticRequire from '../core/staticRequire'
2+
import docsUrl from '../docsUrl'
23

34
const DEFAULT_MAX = 10
45

@@ -12,12 +13,11 @@ const countDependencies = (dependencies, lastNode, context) => {
1213
)
1314
}
1415
}
15-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
1616

1717
module.exports = {
1818
meta: {
1919
docs: {
20-
url: `${ruleDocsUrl}/max-dependencies.md`,
20+
url: docsUrl('max-dependencies'),
2121
},
2222

2323
schema: [

src/rules/named.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
import * as path from 'path'
22
import Exports from '../ExportMap'
3-
4-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
3+
import docsUrl from '../docsUrl'
54

65
module.exports = {
76
meta: {
87
docs: {
9-
url: `${ruleDocsUrl}/named.md`,
8+
url: docsUrl('named'),
109
},
1110
},
1211

src/rules/namespace.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1+
import declaredScope from 'eslint-module-utils/declaredScope'
12
import Exports from '../ExportMap'
23
import importDeclaration from '../importDeclaration'
3-
import declaredScope from 'eslint-module-utils/declaredScope'
4-
5-
const ruleDocsUrl = 'https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules'
4+
import docsUrl from '../docsUrl'
65

76
module.exports = {
87
meta: {
98
docs: {
10-
url: `${ruleDocsUrl}/namespace.md`,
9+
url: docsUrl('namespace'),
1110
},
1211

1312
schema: [

0 commit comments

Comments
 (0)