@d-zero/linters

複数のリンターと共有設定ファイルを含んだ統合リンターパッケージ

このパッケージ自体は空です。依存関係に以下のリンターと設定をリンクしています。

• @d-zero/cspell-config
• @d-zero/eslint-config
• @d-zero/lint-staged-config
• @d-zero/markuplint-config
• @d-zero/prettier-config
• @d-zero/pug-lint-config
• @d-zero/stylelint-config
• @d-zero/textlint-config

このパッケージは各依存パッケージのバージョン管理を簡潔にすることを目的としています。

⚠️ プロジェクトによっては各パッケージをバラバラにインストールする方がよいかもしれません。

インストール

yarn add -D @d-zero/linters

使い方

プロジェクトで利用するには設定ファイルを用意する必要があります。このパッケージに含まれる設定ファイルを利用するには、それぞれの設定ファイルのExtends機能などを利用します。

PrettierがESM形式を要求するため、プロジェクトのモジュールタイプもESM形式にする必要があります。

// package.json
{
	"type": "module"
}

CSpell

cspell.json

{
	"import": ["@d-zero/cspell-config"]
}

詳細: @d-zero/cspell-config

ESLint

.eslintrc

{
	"extends": ["@d-zero/eslint-config"]
}

JavaScriptのみ

⚠️ TypeScriptを利用しない場合は、@d-zero/eslint-configの代わりに@d-zero/eslint-config/baseを利用します。

{
	"extends": ["@d-zero/eslint-config/base"]
}

詳細: @d-zero/eslint-config

lint-staged

lint-staged.config.mjs

import lintStagedConfigGenerator from '@d-zero/lint-staged-config';
export default lintStagedConfigGenerator();

詳細: @d-zero/lint-staged-config

Markuplint

.markuplintrc

{
	"extends": ["@d-zero/markuplint-config"]
}

詳細: @d-zero/markuplint-config

Prettier

.prettierrc.mjs

import config from '@d-zero/prettier-config';

export default config;

⚠️ CommonJS、JSON、package.jsonからは利用できません。

詳細: @d-zero/prettier-config

pug-lint

.pug-lintrc

{
	"extends": "@d-zero/pug-lint-config"
}

詳細: @d-zero/pug-lint-config

Stylelint

.stylelintrc

{
	"extends": ["@d-zero/stylelint-config"]
}

詳細: @d-zero/stylelint-config

textlint

.textlintrc.js

module.exports = {
	...require('@d-zero/textlint-config'),
};

⚠️ 拡張子が.jsでもCommonJS形式で書きます。ESMには対応していません。

詳細: @d-zero/textlint-config

サンプルファイル

./scaffoldに各設定ファイルのサンプルを用意しています。