https://github.com/kubosho/configs
My Web frontend tool configs.
https://github.com/kubosho/configs
configuration eslint markuplint prettier renovate semantic-release textlint typescript
Last synced: 2 months ago
JSON representation
My Web frontend tool configs.
- Host: GitHub
- URL: https://github.com/kubosho/configs
- Owner: kubosho
- License: mit
- Created: 2023-04-02T03:27:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-17T14:06:48.000Z (3 months ago)
- Last Synced: 2025-08-17T16:09:19.631Z (3 months ago)
- Topics: configuration, eslint, markuplint, prettier, renovate, semantic-release, textlint, typescript
- Language: JavaScript
- Homepage:
- Size: 3.12 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @kubosho/configs
My Web frontend tool configs. Inspired by [@3846masa/configs](https://github.com/3846masa/configs).
[](https://www.npmjs.com/package/@kubosho/configs)
## Install
```shell
npm add -D @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:
```shell
npm add -D 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`:
```javascript
import config from '@kubosho/configs/eslint';
export default {
...config,
};
```
### Markdownlint
Install the required dependencies:
```shell
# For markdownlint-cli2 (recommended if you want to use extends)
npm add -D markdownlint-cli2
# OR for markdownlint-cli
npm add -D markdownlint-cli
```
In use `.markdownlint.json`:
```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:
```shell
npm add -D markuplint
```
In use `markuplint.config.mjs`:
```javascript
import config from '@kubosho/configs/markuplint';
export default {
...config,
};
```
### Prettier
Install the required dependencies:
```shell
npm add -D prettier
```
```javascript
module.exports = {
...require('@kubosho/configs/prettier'),
};
```
### Renovate
No npm packages required (GitHub App configuration only).
```json
{
"extends": ["github>kubosho/configs//renovate/default"]
}
```
### Semantic Release
Install the required dependencies:
```shell
npm add -D @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`:
```javascript
import config from '@kubosho/configs/semantic_release';
export default {
...config,
};
```
### Stylelint
Install the required dependencies:
```shell
npm add -D stylelint stylelint-config-recommended
```
In use `stylelint.config.mjs`:
```javascript
import config from '@kubosho/configs/stylelint';
export default {
...config,
};
```
### Textlint
Install the required dependencies:
```shell
npm add -D textlint 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`:
```javascript
const config = require('@kubosho/configs/textlint');
module.exports = {
...config,
};
```
### TypeScript
Install the required dependencies:
```shell
npm add -D typescript
```
In use `tsconfig.json`:
```json
{
"extends": "@kubosho/configs/typescript/tsconfig.json"
}
```