Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LINT-22(DOC): Customization usage #48

Merged
merged 2 commits into from
Dec 20, 2021

Conversation

Krakazybik
Copy link
Member

@Krakazybik Krakazybik commented Dec 20, 2021

Description

Добавлена документация по частичному использованию конфига.
Описаны возможные правила с сылками на примеры.

Reference

#22

Checks

  • Description added
  • Self-reviewed
  • CI pass

@Krakazybik Krakazybik self-assigned this Dec 20, 2021
@Krakazybik Krakazybik added the documentation Improvements or additions to documentation label Dec 20, 2021
@Krakazybik Krakazybik requested a review from azinit December 20, 2021 09:28
@azinit azinit linked an issue Dec 20, 2021 that may be closed by this pull request
6 tasks
Copy link
Member

@azinit azinit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Балдежно вышло! 🔥🔥🔥🔥

Можем вливать)

Comment on lines +124 to +144
## Customization
You can partially use the rules

#### Note:
Don't use main config (`@feature-sliced`) in customization to avoid rules conflicts.

#### Example:
```json
{
"extends": [
"@feature-sliced/eslint-config/rules/import-order",
"@feature-sliced/eslint-config/rules/public-api-boundaries",
"@feature-sliced/eslint-config/rules/layers-slices-boundaries"
]
}
```

#### Available rules
- [import-order](./rules/import-order/index.md)
- [public-api-boundaries](./rules/public-api-boundaries/index.md)
- [layers-slices-boundaries](./rules/layers-slices-boundaries/index.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: Прям даже лучше чем хотелось вышло 👍

Comment on lines 1 to +6
# @feature-sliced/import-order

Reference: [Layers](https://feature-sliced.design/docs/reference/layers)
#### Reference: [Layers](https://feature-sliced.design/docs/reference/layers)

#### Usage:
Add `"@feature-sliced/eslint-config/rules/import-order"` to you `extends` section in ESLint config.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: Йеее, и про это не забыл 🚀

@Krakazybik Krakazybik merged commit 24d1611 into master Dec 20, 2021
@Krakazybik Krakazybik deleted the chore/LINT-22-check-customization branch December 20, 2021 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LINT(GET-STARTED): Check customization of config
2 participants