Skip to content

Commit

Permalink
refactor: sort rules
Browse files Browse the repository at this point in the history
  • Loading branch information
nikkeyl committed Feb 5, 2024
1 parent 6822375 commit 7f88599
Show file tree
Hide file tree
Showing 8 changed files with 376 additions and 304 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Get Help in GitHub Discussions
url: https://github.com/Archoleat/stylelint-config-archoleat-scss/discussions
url: https://github.com/Archoleat/stylelint-config-extended-scss/discussions
about: Have a question? Not sure if your issue affects everyone reproducibly?
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please, go through these steps before you submit a **Pull Request**.
the Issue that your **Pull Request** fixes (if such).

IMPORTANT: Please see our
[**Contribution Guidelines**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/CONTRIBUTING.md)
[**Contribution Guidelines**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/CONTRIBUTING.md)
for details.

**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ newIssueWelcomeComment: >
newPRWelcomeComment: >
Thanks for opening this Pull Request!
Please check out our [Contributing Guidelines](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/CONTRIBUTING.md).
Please check out our [Contributing Guidelines](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/CONTRIBUTING.md).
firstPRMergeComment: >
Congrats on merging your first Pull Request!
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ for all involved. The community looks forward to your contributions.
## Code of Conduct

This project and everyone participating in it is governed by the
[**Stylelint Config Archoleat SCSS Code of Conduct**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/CODE_OF_CONDUCT.md).
[**Stylelint Config Archoleat SCSS Code of Conduct**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.

## I Have a Question

> If you want to ask a question, we assume that you have read
> the available [**Documentation**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/README.md).
> the available [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md).
Before you ask a question, it is best to search for existing
[**Issues**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues)
[**Issues**](https://github.com/Archoleat/stylelint-config-extended-scss/issues)
that might help you. In case you have found a suitable **Issue** and still need
clarification, you can write your question in this **Issue**.
It is also advisable to search the internet for answers first.
Expand All @@ -48,7 +48,7 @@ If you then still feel the need to ask a question and need clarification,
we recommend the following:

- Open an
[**Issue**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues/new/choose).
[**Issue**](https://github.com/Archoleat/stylelint-config-extended-scss/issues/new/choose).

- Provide as much context as you can about what you're running into.

Expand Down Expand Up @@ -79,14 +79,14 @@ potential bug as fast as possible.

- Determine if your bug is really a bug and not an error on your side e.g.
using incompatible environment components/versions
(Make sure that you have read the [**Documentation**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/README.md).
(Make sure that you have read the [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md).
If you are looking for support, you might want to check
[**this section**](#i-have-a-question)).

- To see if other users have experienced (and potentially already solved)
the same **Issue** you are having, check if there is not already
a bug report existing for your bug or error in the
[**bug tracker**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues?q=label%3Abug).
[**bug tracker**](https://github.com/Archoleat/stylelint-config-extended-scss/issues?q=label%3Abug).

- Also make sure to search the internet (including **Stack Overflow**)
to see if users outside of the **GitHub community** have discussed
Expand Down Expand Up @@ -118,7 +118,7 @@ We use GitHub **Issues** to track bugs and errors.
If you run into an **Issue** with the project:

- Open an
[**Issue**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues/new/choose).
[**Issue**](https://github.com/Archoleat/stylelint-config-extended-scss/issues/new/choose).
(Since we can't be sure at this point whether it is a bug or not,
we ask you not to talk about a bug yet and not to label the **Issue**.)

Expand Down Expand Up @@ -159,12 +159,12 @@ to understand your suggestion and find related suggestions.

- Make sure that you are using the latest version.

- Read the [**Documentation**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/README.md)
- Read the [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md)
carefully and find out if the functionality is already covered,
maybe by an individual configuration.

- Perform a
[**search**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues)
[**search**](https://github.com/Archoleat/stylelint-config-extended-scss/issues)
to see if the enhancement has already been suggested.
If it has, add a comment to the existing **Issue** instead
of opening a new one.
Expand All @@ -178,7 +178,7 @@ to understand your suggestion and find related suggestions.

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues/new/choose).
Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/stylelint-config-extended-scss/issues/new/choose).

- Use a **clear and descriptive title** for the **Issue** to identify
the suggestion.
Expand Down Expand Up @@ -216,7 +216,7 @@ build their projects.

#### How to Submit Documentation Enhancements

Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues/new/choose).
Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Archoleat/stylelint-config-extended-scss/issues/new/choose).

- Use a **clear and descriptive title** for the **Issue** to identify
the suggestion.
Expand Down
107 changes: 63 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,24 @@

![ESM Only](https://img.shields.io/badge/ESM-only-gray?labelColor=fe0)
![Commitlint](https://img.shields.io/github/actions/workflow/status/Archoleat/core/commitlint.yml?label=Commitlint)
![CodeQL](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/codeql.yml?label=CodeQL)
![Test](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/mocha.yml?label=Test)
![Editorconfig](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/editorconfig.yml?label=Editorconfig)
![Prettier](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/prettier.yml?label=Prettier)
![Markdown](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/markdown.yml?label=Markdown)
![ESLint](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-archoleat-scss/eslint.yml?label=ESLint)
![CodeQL](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/codeql.yml?label=CodeQL)
![Test](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/mocha.yml?label=Test)
![Editorconfig](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/editorconfig.yml?label=Editorconfig)
![Prettier](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/prettier.yml?label=Prettier)
![Markdown](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/markdown.yml?label=Markdown)
![ESLint](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/eslint.yml?label=ESLint)

## Table of Contents

- [Table of Contents](#table-of-contents)

- [Getting Started](#getting-started)

- [Features](#features)

- [Scripts](#scripts)
- [Extends](#extends)
- [Plugins](#plugins)
- [Pseudo Elements and Classes](#pseudo-elements-and-classes)
- [Rules](#rules)
- [Naming Pattern](#naming-pattern)
- [Key Points](#key-points)

- [Additions](#additions)
- [Husky](#husky)
Expand All @@ -39,54 +41,71 @@
This project is built on [**Archoleat Repo Template**](https://github.com/Archoleat/archoleat-repo-template).

> \[!TIP]
> Nice addition for [**Archoleat**](https://github.com/Archoleat/archoleat)
> or [**Archoleat Repo Template**](https://github.com/Archoleat/archoleat-repo-template)!
## Getting Started
> Nice addition for [**Archoleat**](https://github.com/Archoleat/archoleat)!
## Features

## Scripts
### Extends

- **`stylelint-config-standard-scss`**: Provides a baseline for common CSS
best practices and SCSS consistency.

### Plugins

- **`stylelint-high-performance-animation`**: Optimizes animation performance
by identifying potential issues and suggesting best practices.

- **`stylelint-order`**: Enforces consistent property ordering within
declarations, sorting over 480+ rules to enhance readability
and maintainability.

- **`init`**: Installs dependencies, **Husky** and update submodules.
- **`stylelint-plugin-defensive-css`**: Promotes robust CSS by identifying
potential vulnerabilities and cross-browser inconsistencies.

- **`format`**: Runs **Prettier** with the **`--write`** flag
for all files.
- **`stylelint-plugin-logical-css`**: Encourages the use of logical
properties for improved accessibility and flexibility in
direction-aware layouts.

- **`lint:formatting`**: Runs **Prettier** with the **`--check`** flag
for all files.
> future version all old properties will be remove
> In the [**`prettier.yml`**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/.github/workflows/prettier.yml)
>
> Also run with a **`pre-commit`** hook.
- **`stylelint-prettier`**: Integrates **Prettier** for
consistent code formatting.

- **`lint:editorconfig`**: Runs **Editorconfig Checker** and
checks all files in the project.
### Pseudo Elements and Classes

> Also runs with the [**`editorconfig.yml`**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/.github/workflows/editorconfig.yml)
> workflow.
- Supports **20+** pseudo elements and **65+** pseudo classes
for diverse styling needs.

> \[!TIP]
> Experimental and non-standard pseudo classes and
> elements are used in the config.
### Rules

- **Over 480 properties**, covering various aspects of CSS coding
style, consistency, and best practices.

> \[!TIP]
> Experimental and non-standard properties are used in the config.
- **`lint:md`**: Runs **Remark** with the **`--quiet`** flag and
checks all **Markdown** files.
### Naming Pattern

> Also runs with the [**`markdown.yml`**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/.github/workflows/markdown.yml)
> workflow.
**BEM** naming convention likely enforced, encouraging modularity,
maintainability, and clarity in class naming.

- **`lint:ts`**: Runs **ESLint** with the flag **`--fix`**
for all **TypeScript** files.
### Key Points

> Runs with the [**`eslint.yml`**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/.github/workflows/eslint.yml)
> workflow.
>
> Also run with a **`pre-commit`** hook.
- Comprehensive configuration addressing performance, maintainability,
accessibility, and best practices.

- **`test`**: Runs **Mocha** and the tests in the **specs/** folder.
- Leverages a solid foundation from **`stylelint-config-standard-scss`**
with valuable plugins.

> Also runs using the [**`mocha.yml`**](https://github.com/Archoleat/stylelint-config-archoleat-scss/blob/main/.github/workflows/mocha.yml)
> workflow.
- Enforces consistent code style and naming conventions for better
readability and collaboration.

- **`commit`**: Runs **Commitlint** to create commits according to
**Conventional Commits** standards.
- Sorts **over 480 properties** using the **`stylelint-order`** plugin for
enhanced clarity and maintainability.

## Additions

Expand All @@ -102,7 +121,7 @@ See also the list of [**Authors**](AUTHORS.md).
## Contributors

If you want to improve something, you can write about it
[**here**](https://github.com/Archoleat/stylelint-config-archoleat-scss/issues/new/choose).
[**here**](https://github.com/Archoleat/stylelint-config-extended-scss/issues/new/choose).

You can also view a list of [**Contributors**](CONTRIBUTORS.md).

Expand All @@ -116,7 +135,7 @@ and the process for submitting **Pull Request** to us.

We use [**SemVer**](https://semver.org) for versioning.
You can see the available versions
[**here**](https://github.com/Archoleat/stylelint-config-archoleat-scss/tags).
[**here**](https://github.com/Archoleat/stylelint-config-extended-scss/tags).

## License

Expand Down
Loading

0 comments on commit 7f88599

Please sign in to comment.