@kubosho/configs

My Web frontend tool configs. Inspired by @3846masa/configs.

Install

npm add -DE @kubosho/configs

Attention: This package provides only config files. Please install required tools (e.g. ESLint, Prettier, etc.) in your project.

Usage

ESLint

Install the required dependencies:

npm add -DE @eslint/js eslint eslint-config-prettier eslint-import-resolver-typescript eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-simple-import-sort typescript-eslint

In use eslint.config.mjs:

import config from '@kubosho/configs/eslint';

export default {
  ...config,
};

Markdownlint

Install the required dependencies:

# For markdownlint-cli2 (recommended if you want to use extends)
npm add -DE markdownlint-cli2

# OR for markdownlint-cli
npm add -DE markdownlint-cli

In use .markdownlint.json:

{
  "extends": "@kubosho/configs/markdownlint"
}

Note: The extends property only works with markdownlint-cli2. If using markdownlint-cli, you'll need to manually merge the configuration.

Markuplint

Install the required dependencies:

npm add -DE markuplint

In use markuplint.config.mjs:

import config from '@kubosho/configs/markuplint';

export default {
  ...config,
};

Prettier

Install the required dependencies:

npm add -DE prettier

In use prettier.config.mjs:

import config from '@kubosho/configs/prettier';

export default {
  ...config,
};

Renovate

No npm packages required (GitHub App configuration only).

{
  "extends": ["github>kubosho/configs//renovate/default"]
}

Semantic Release

Install the required dependencies:

npm add -DE @semantic-release/changelog @semantic-release/commit-analyzer @semantic-release/git @semantic-release/github @semantic-release/npm @semantic-release/release-notes-generator conventional-changelog-conventionalcommits semantic-release

In use release.config.mjs:

import config from '@kubosho/configs/semantic_release';

export default {
  ...config,
};

Stylelint

Install the required dependencies:

npm add -DE stylelint stylelint-config-recommended

In use stylelint.config.mjs:

import config from '@kubosho/configs/stylelint';

export default {
  ...config,
};

Textlint

Install the required dependencies:

npm add -DE textlint textlint-rule-ja-no-weak-phrase textlint-filter-rule-comments textlint-rule-no-dead-link textlint-rule-no-doubled-joshi textlint-rule-preset-ai-writing textlint-rule-preset-jtf-style

In use .textlintrc.js:

const config = require('@kubosho/configs/textlint');

module.exports = {
  ...config,
};

TypeScript

Install the required dependencies:

npm add -DE typescript

In use tsconfig.json:

{
  "extends": "@kubosho/configs/typescript/tsconfig.json"
}