https://github.com/natterstefan/stylelint-config-ns

Stylelint config with CSS (`.(s)css`), Tailwind, PostCSS and Prettier support.
https://github.com/natterstefan/stylelint-config-ns

postcss prettier prettier-stylelint tailwind tailwind-stylelint

Last synced: 8 days ago
JSON representation

Stylelint config with CSS (`.(s)css`), Tailwind, PostCSS and Prettier support.

• Host: GitHub
• URL: https://github.com/natterstefan/stylelint-config-ns
• Owner: natterstefan
• License: mit
• Created: 2018-08-25T19:42:13.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-09-15T09:43:08.000Z (about 1 year ago)
• Last Synced: 2024-10-25T04:22:47.250Z (13 days ago)
• Topics: postcss, prettier, prettier-stylelint, tailwind, tailwind-stylelint
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/stylelint-config-ns
• Size: 186 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-config-ns

[![npm version](https://badge.fury.io/js/stylelint-config-ns.svg)](https://badge.fury.io/js/stylelint-config-ns)

[![GitHub license](https://img.shields.io/github/license/natterstefan/stylelint-config-ns.svg)](https://github.com/natterstefan/stylelint-config-ns/blob/main/LICENCE)

[![Node CI](https://github.com/natterstefan/stylelint-config-ns/actions/workflows/ci.yml/badge.svg)](https://github.com/natterstefan/stylelint-config-ns/actions/workflows/ci.yml)

> Stylelint config with pre-configured Sass (`.scss`), Tailwind, CSS-in-JS

> (`.ts` and `.tsx`), PostCSS and Prettier support.

## Installation

Install the package with

```sh

npm install stylelint-config-ns --save-dev

# or

yarn add stylelint-config-ns -D

```

## Usage

Add the following to your `styelint.config.js` config:

```js

/**

 * @type {import('stylelint').Config}

 */

module.exports = {

  extends: 'stylelint-config-ns',

}

```

## Extended Configs

The following configurations are used and preconfigured:

- [stylelint/stylelint-config-recommended: The recommended shareable config for Stylelint](https://github.com/stylelint/stylelint-config-recommended)

- [prettier/stylelint-config-prettier: Turns off all rules that are unnecessary or might conflict with prettier.](https://github.com/prettier/stylelint-config-prettier)

## Development

### How to publish

```sh

# prepare the CHANGELOG (new release headline)

git add CHANGELOG && git commit -m "chore: prepare release"

# push changes

git push

# publish the release

yarn publish

```

## License

[MIT](./LICENSE)