@d-zero/markuplint-config 5.0.0-dev.93 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +55 -2
- package/base.js +110 -0
- package/index.js +53 -0
- package/name.js +83 -0
- package/package.json +16 -8
- package/pug.js +18 -0
- package/.markuplintrc.json +0 -51
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,4 +1,57 @@
|
|
|
1
1
|
# `@d-zero/markuplint-config`
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
## 個別インストール
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm install -D @d-zero/markuplint-config
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## 使い方
|
|
10
|
+
|
|
11
|
+
`.markuplintrc`を作成し、[`extends`](https://markuplint.dev/ja/docs/configuration/properties#extends)機能を使って読み込みます。
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"extends": ["@d-zero/markuplint-config"]
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### 拡張
|
|
20
|
+
|
|
21
|
+
プロジェクトに合わせて設定を追加します。
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"extends": ["@d-zero/markuplint-config"],
|
|
26
|
+
"rules": {
|
|
27
|
+
// 例: クラス名の命名規則を変更する
|
|
28
|
+
"class-naming": {
|
|
29
|
+
"value": "/^c-(?<ComponentName>[a-z][a-z0-9]*(?:-[a-z0-9]+)*)$/"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`class-naming`の設定を変更する場合、上書きがやや冗長になるので、専用の関数を使って許可するクラスを追加します。
|
|
36
|
+
|
|
37
|
+
```js
|
|
38
|
+
import { extendsConfig } from '@d-zero/markuplint-config';
|
|
39
|
+
|
|
40
|
+
export default extendsConfig({
|
|
41
|
+
// 通常のクラス命名規則に加えて、Splideのクラス名も許可する
|
|
42
|
+
classNaming: ['/^splide(?:__[a-z]+)?$/'],
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
// または、以下のように書くこともできます
|
|
46
|
+
|
|
47
|
+
export default {
|
|
48
|
+
...extendsConfig({
|
|
49
|
+
// 通常のクラス命名規則に加えて、Splideのクラス名も許可する
|
|
50
|
+
classNaming: ['/^splide(?:__[a-z]+)?$/'],
|
|
51
|
+
}),
|
|
52
|
+
// 他の設定
|
|
53
|
+
rules: {
|
|
54
|
+
'character-reference': false,
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
```
|
package/base.js
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @type {import('@markuplint/ml-config').Config}
|
|
3
|
+
*/
|
|
4
|
+
export default {
|
|
5
|
+
extends: ['markuplint:recommended-static-html'],
|
|
6
|
+
rules: {
|
|
7
|
+
'disallowed-element': {
|
|
8
|
+
value: ['br'],
|
|
9
|
+
reason:
|
|
10
|
+
'br要素は原則使用しません。代わりにCSSでスタイルを調整してください。使用する場合は理由が必要です。（D-ZERO独自ルール）',
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
nodeRules: [
|
|
14
|
+
{
|
|
15
|
+
selector: "script[src^='https://'], script[src^='https://']",
|
|
16
|
+
rules: {
|
|
17
|
+
'required-attr': false,
|
|
18
|
+
},
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
selector: 'html',
|
|
22
|
+
rules: {
|
|
23
|
+
// <html prefix="og: http://ogp.me/ns#">
|
|
24
|
+
'invalid-attr': {
|
|
25
|
+
options: {
|
|
26
|
+
allowAttrs: [
|
|
27
|
+
{
|
|
28
|
+
name: 'prefix',
|
|
29
|
+
value: 'Any',
|
|
30
|
+
},
|
|
31
|
+
],
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
selector: 'img',
|
|
38
|
+
rules: {
|
|
39
|
+
// https://github.com/markuplint/markuplint/blob/c35e0beb5e14093a41cee7634221dbe7f7d577f9/packages/%40markuplint/config-presets/src/preset.performance.json#L25-L35 の設定を上書き
|
|
40
|
+
// width, height の指定は上書きされるため、省略可能になるが、ビルド時に自動的に付与されるため問題なしとする
|
|
41
|
+
'required-attr': {
|
|
42
|
+
value: 'alt',
|
|
43
|
+
reason:
|
|
44
|
+
'省略可能なケースがほとんど想定されないため、原則禁止としています。省略する場合は明確な理由が必要です。（D-ZERO独自ルール）',
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
selector:
|
|
50
|
+
'img:not([src^="data:"], [src^="blob:"], [src^="https://"], [src^="http://"], [src^="//"])',
|
|
51
|
+
rules: {
|
|
52
|
+
'invalid-attr': {
|
|
53
|
+
options: {
|
|
54
|
+
disallowAttrs: [
|
|
55
|
+
{
|
|
56
|
+
name: 'src',
|
|
57
|
+
value: { pattern: '/[A-Z\\s_]/' },
|
|
58
|
+
},
|
|
59
|
+
],
|
|
60
|
+
},
|
|
61
|
+
reason:
|
|
62
|
+
'画像ファイル名は小文字のケバブケース（ハイフン区切り）で命名してください。大文字、スペース、アンダースコアは使用できません。（D-ZERO独自ルール）',
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
selector: 'video, audio, source',
|
|
68
|
+
rules: {
|
|
69
|
+
'invalid-attr': {
|
|
70
|
+
options: {
|
|
71
|
+
disallowAttrs: [
|
|
72
|
+
{
|
|
73
|
+
name: 'src',
|
|
74
|
+
value: { pattern: '/[A-Z\\s_]/' },
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
name: 'poster',
|
|
78
|
+
value: { pattern: '/[A-Z\\s_]/' },
|
|
79
|
+
},
|
|
80
|
+
],
|
|
81
|
+
},
|
|
82
|
+
reason:
|
|
83
|
+
'メディアファイル名は小文字のケバブケース（ハイフン区切り）で命名してください。大文字、スペース、アンダースコアは使用できません。（D-ZERO独自ルール）',
|
|
84
|
+
},
|
|
85
|
+
},
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
selector: 'a',
|
|
89
|
+
rules: {
|
|
90
|
+
'required-attr': {
|
|
91
|
+
value: 'href',
|
|
92
|
+
reason:
|
|
93
|
+
'省略可能なケースがほとんど想定されないため、原則禁止としています。省略する場合は明確な理由が必要です。（D-ZERO独自ルール）',
|
|
94
|
+
},
|
|
95
|
+
'invalid-attr': {
|
|
96
|
+
options: {
|
|
97
|
+
disallowAttrs: [
|
|
98
|
+
{
|
|
99
|
+
name: 'href',
|
|
100
|
+
value: { pattern: '/^javascript:/i' },
|
|
101
|
+
},
|
|
102
|
+
],
|
|
103
|
+
},
|
|
104
|
+
reason:
|
|
105
|
+
'JavaScriptのリンクは使用しないでください。代わりに`button`要素を使用してください。',
|
|
106
|
+
},
|
|
107
|
+
},
|
|
108
|
+
},
|
|
109
|
+
],
|
|
110
|
+
};
|
package/index.js
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import base from './base.js';
|
|
2
|
+
import nameConfig, { nameWith } from './name.js';
|
|
3
|
+
import pug from './pug.js';
|
|
4
|
+
|
|
5
|
+
const createConfig = (name = nameConfig) => {
|
|
6
|
+
return {
|
|
7
|
+
...base,
|
|
8
|
+
...pug,
|
|
9
|
+
...name,
|
|
10
|
+
parser: {
|
|
11
|
+
...base.parser,
|
|
12
|
+
...pug.parser,
|
|
13
|
+
...name.parser,
|
|
14
|
+
},
|
|
15
|
+
rules: {
|
|
16
|
+
...base.rules,
|
|
17
|
+
...pug.rules,
|
|
18
|
+
...name.rules,
|
|
19
|
+
},
|
|
20
|
+
nodeRules: [
|
|
21
|
+
//
|
|
22
|
+
...(base.nodeRules ?? []),
|
|
23
|
+
...(pug.nodeRules ?? []),
|
|
24
|
+
...(name.nodeRules ?? []),
|
|
25
|
+
],
|
|
26
|
+
childNodeRules: [
|
|
27
|
+
//
|
|
28
|
+
...(base.childNodeRules ?? []),
|
|
29
|
+
...(pug.childNodeRules ?? []),
|
|
30
|
+
...(name.childNodeRules ?? []),
|
|
31
|
+
],
|
|
32
|
+
overrideMode: 'merge',
|
|
33
|
+
overrides: {
|
|
34
|
+
...pug.overrides,
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* @type {import('@markuplint/ml-config').Config}
|
|
41
|
+
*/
|
|
42
|
+
export default createConfig();
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @param {object} options
|
|
47
|
+
* @param {string[]?} options.classNaming
|
|
48
|
+
* @returns
|
|
49
|
+
*/
|
|
50
|
+
export const extendsConfig = (options) => {
|
|
51
|
+
const name = options?.classNaming ? nameWith(options.classNaming) : nameConfig;
|
|
52
|
+
return createConfig(name);
|
|
53
|
+
};
|
package/name.js
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @type {import('@markuplint/ml-config').Config}
|
|
3
|
+
*/
|
|
4
|
+
const nameBase = {
|
|
5
|
+
rules: {
|
|
6
|
+
'class-naming': {
|
|
7
|
+
severity: 'error',
|
|
8
|
+
value: '/^c-(?<ComponentName>[a-z][a-z0-9]*(?:-[a-z0-9]+)*)$/',
|
|
9
|
+
reason:
|
|
10
|
+
'クラス名の形式はディーゼロのコーディングガイドラインに則って命名する必要があります。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%F0%9F%92%8E-%E3%82%B3%E3%83%B3%E3%83%9B%E3%82%9A%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88',
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
childNodeRules: [
|
|
14
|
+
{
|
|
15
|
+
regexSelector: {
|
|
16
|
+
attrName: 'class',
|
|
17
|
+
attrValue: '/^c-(?<ComponentName>[a-z][a-z0-9]*(?:-[a-z0-9]+)*)$/',
|
|
18
|
+
},
|
|
19
|
+
inheritance: true,
|
|
20
|
+
rules: {
|
|
21
|
+
'class-naming': {
|
|
22
|
+
severity: 'error',
|
|
23
|
+
value: [
|
|
24
|
+
'/^c-{{ ComponentName }}__[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/',
|
|
25
|
+
'/^c-(?!{{ ComponentName }})[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/',
|
|
26
|
+
'/^c-{{ ComponentName }}[a-z0-9]*(?:-[a-z0-9]+)*$/',
|
|
27
|
+
],
|
|
28
|
+
reason:
|
|
29
|
+
'ディーゼロのコーディングガイドラインではコンポーネントの中はそのコンポーネントのエレメントか、他のコンポーネントである必要があります。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%E3%82%B3%E3%83%B3%E3%83%9B%E3%82%9A%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88%E3%81%AE%E6%A7%8B%E6%88%90%E3%81%A8%E3%82%AF%E3%83%A9%E3%82%B9%E5%91%BD%E5%90%8D%E8%A6%8F%E5%89%87',
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
selector: "[class='c-content-main']",
|
|
35
|
+
inheritance: true,
|
|
36
|
+
rules: {
|
|
37
|
+
'class-naming': {
|
|
38
|
+
severity: 'error',
|
|
39
|
+
value: '/^(?!c-).+$|^$/',
|
|
40
|
+
reason:
|
|
41
|
+
'ディーゼロのコーディングガイドラインでは「c-content-main」の中は「c-」で始めないルールとなっています。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%E3%82%A8%E3%83%AC%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%AE%E4%BE%8B%E5%A4%96%E3%81%A8%E3%82%AF%E3%83%A9%E3%82%B9%E8%BF%BD%E5%8A%A0%E3%81%AE%E3%83%AB%E3%83%BC%E3%83%AB',
|
|
42
|
+
},
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* @type {import('@markuplint/ml-config').Config}
|
|
50
|
+
*/
|
|
51
|
+
export default nameBase;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* @type {(addNamingRule: string[]) => import('@markuplint/ml-config').Config}
|
|
55
|
+
*/
|
|
56
|
+
export const nameWith = (addNamingRules) => {
|
|
57
|
+
return {
|
|
58
|
+
...nameBase,
|
|
59
|
+
rules: {
|
|
60
|
+
...nameBase.rules,
|
|
61
|
+
'class-naming': {
|
|
62
|
+
...nameBase.rules['class-naming'],
|
|
63
|
+
value: [nameBase.rules['class-naming'].value, ...addNamingRules],
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
childNodeRules: [
|
|
67
|
+
{
|
|
68
|
+
...nameBase.childNodeRules[0],
|
|
69
|
+
rules: {
|
|
70
|
+
...nameBase.childNodeRules[0].rules,
|
|
71
|
+
'class-naming': {
|
|
72
|
+
...nameBase.childNodeRules[0].rules['class-naming'],
|
|
73
|
+
value: [
|
|
74
|
+
...nameBase.childNodeRules[0].rules['class-naming'].value,
|
|
75
|
+
...addNamingRules,
|
|
76
|
+
],
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
},
|
|
80
|
+
nameBase.childNodeRules[1],
|
|
81
|
+
],
|
|
82
|
+
};
|
|
83
|
+
};
|
package/package.json
CHANGED
|
@@ -1,21 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@d-zero/markuplint-config",
|
|
3
|
-
"version": "5.0.0
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "Configurations of Markuplint",
|
|
5
|
-
"repository": "https://github.com/d-zero-dev/
|
|
5
|
+
"repository": "https://github.com/d-zero-dev/linters.git",
|
|
6
6
|
"author": "D-ZERO Co., Ltd.",
|
|
7
7
|
"license": "MIT",
|
|
8
|
-
"private": false,
|
|
9
8
|
"publishConfig": {
|
|
10
9
|
"access": "public"
|
|
11
10
|
},
|
|
11
|
+
"engines": {
|
|
12
|
+
"node": ">=22.0.0"
|
|
13
|
+
},
|
|
14
|
+
"type": "module",
|
|
15
|
+
"exports": {
|
|
16
|
+
".": "./index.js",
|
|
17
|
+
"./base": "./base.js",
|
|
18
|
+
"./name": "./name.js",
|
|
19
|
+
"./pug": "./pug.js"
|
|
20
|
+
},
|
|
12
21
|
"files": [
|
|
13
|
-
"
|
|
22
|
+
"*.js"
|
|
14
23
|
],
|
|
15
|
-
"main": ".markuplintrc.json",
|
|
16
24
|
"dependencies": {
|
|
17
|
-
"@markuplint/pug-parser": "4.
|
|
18
|
-
"markuplint": "4.
|
|
25
|
+
"@markuplint/pug-parser": "4.6.22",
|
|
26
|
+
"markuplint": "4.14.0"
|
|
19
27
|
},
|
|
20
|
-
"gitHead": "
|
|
28
|
+
"gitHead": "7f635ad8bbb1455d0d362fe00478a2f7bd216924"
|
|
21
29
|
}
|
package/pug.js
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @type {import('@markuplint/ml-config').Config}
|
|
5
|
+
*/
|
|
6
|
+
export default {
|
|
7
|
+
parser: {
|
|
8
|
+
'.pug$': '@markuplint/pug-parser',
|
|
9
|
+
},
|
|
10
|
+
overrideMode: 'merge',
|
|
11
|
+
overrides: {
|
|
12
|
+
[path.resolve(process.cwd(), '**', '*.pug')]: {
|
|
13
|
+
rules: {
|
|
14
|
+
'character-reference': false,
|
|
15
|
+
},
|
|
16
|
+
},
|
|
17
|
+
},
|
|
18
|
+
};
|
package/.markuplintrc.json
DELETED
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": ["markuplint:recommended"],
|
|
3
|
-
"parser": {
|
|
4
|
-
".pug$": "@markuplint/pug-parser"
|
|
5
|
-
},
|
|
6
|
-
"rules": {
|
|
7
|
-
"class-naming": {
|
|
8
|
-
"severity": "error",
|
|
9
|
-
"value": "/^c-(?<ComponentName>[a-z][a-z0-9]*(?:-[a-z0-9]+)*)$/",
|
|
10
|
-
"reason": "クラス名の形式はディーゼロのコーディングガイドラインに則って命名する必要があります。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%F0%9F%92%8E-%E3%82%B3%E3%83%B3%E3%83%9B%E3%82%9A%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88"
|
|
11
|
-
}
|
|
12
|
-
},
|
|
13
|
-
"nodeRules": [
|
|
14
|
-
{
|
|
15
|
-
"selector": "script[src^='https://']",
|
|
16
|
-
"rules": {
|
|
17
|
-
"required-attr": false
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
],
|
|
21
|
-
"childNodeRules": [
|
|
22
|
-
{
|
|
23
|
-
"regexSelector": {
|
|
24
|
-
"attrName": "class",
|
|
25
|
-
"attrValue": "/^c-(?<ComponentName>[a-z][a-z0-9]*(?:-[a-z0-9]+)*)$/"
|
|
26
|
-
},
|
|
27
|
-
"inheritance": true,
|
|
28
|
-
"rules": {
|
|
29
|
-
"class-naming": {
|
|
30
|
-
"severity": "error",
|
|
31
|
-
"value": [
|
|
32
|
-
"/^c-{{ ComponentName }}__[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/",
|
|
33
|
-
"/^c-(?!{{ ComponentName }})[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/"
|
|
34
|
-
],
|
|
35
|
-
"reason": "ディーゼロのコーディングガイドラインではコンポーネントの中はそのコンポーネントのエレメントか、他のコンポーネントである必要があります。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%E3%82%B3%E3%83%B3%E3%83%9B%E3%82%9A%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88%E3%81%AE%E6%A7%8B%E6%88%90%E3%81%A8%E3%82%AF%E3%83%A9%E3%82%B9%E5%91%BD%E5%90%8D%E8%A6%8F%E5%89%87"
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"selector": "[class='c-content-main']",
|
|
41
|
-
"inheritance": true,
|
|
42
|
-
"rules": {
|
|
43
|
-
"class-naming": {
|
|
44
|
-
"severity": "error",
|
|
45
|
-
"value": "/^(?!c-).+$|^$/",
|
|
46
|
-
"reason": "ディーゼロのコーディングガイドラインでは「c-content-main」の中は「c-」で始めないルールとなっています。 http://tmpl.d-zero.com/__guideline/coding-guideline/html.html#%E3%82%A8%E3%83%AC%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%AE%E4%BE%8B%E5%A4%96%E3%81%A8%E3%82%AF%E3%83%A9%E3%82%B9%E8%BF%BD%E5%8A%A0%E3%81%AE%E3%83%AB%E3%83%BC%E3%83%AB"
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
]
|
|
51
|
-
}
|