Update project info

Author: thibaudcolas

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,23 @@
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '06 2 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: github/codeql-action/init@v2
+        with:
+          languages: javascript
+      - uses: github/codeql-action/analyze@v2

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## Unreleased
 
+## [1.1.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v1.0.0...v1.1.0) (2022-06-24)
+
+## Features
+
+- Add new at-rule-no-unknown rules for tailwind ([#21](https://github.com/torchbox/stylelint-config-torchbox/pull/21))
+
 ## [1.0.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v0.5.0...v1.0.0) (2020-11-10)
 
 ### Features
@@ -20,6 +26,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 The configuration now mandates stylelint v13, and additionally enforces [`value-keyword-case`](https://stylelint.io/user-guide/rules/value-keyword-case/).
 
+#### Upgrading to v1.0.0
+
+Here are recommended steps:
+
+```bash
+# 1. Install the new versions.
+npm install --save-dev stylelint@13 stylelint-config-torchbox@^1.0.0
+# 2. Attempt to auto-fix any new issue picked up by Stylelint.
+npm run lint:css -- --fix
+npm run format
+# 3. Check if there are remaining issues
+npm run lint:css
+```
+
+If there are remaining issues, consider a gradual approach: whether you want to update the code, or disable the corresponding rules. This can be done either in the Stylelint configuration, or via [`stylelint-disable` configuration comments](https://stylelint.io/user-guide/ignore-code/). Get the rules reporting issues with: `npm run lint:js -- --formatter tap | grep ruleId | cut -d ':' -f 2 | cut -c 2- | sort | uniq`. For projects strapped for time, disabling all new rules listed above may be a reasonable tradeoff.
+
 ## [0.5.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v0.4.0...v0.5.0) (2019-10-10)
 
 ### Features
@@ -30,6 +52,10 @@ The configuration now mandates stylelint v13, and additionally enforces [`value-
 
 - Fix `scale-unlimited/declaration-strict-value` being applied twice to `background-color` declarations.
 
+### Upgrading to v0.5.0
+
+Projects considering this release should [skip straight to v1.0.0](#upgrading-to-v100).
+
 ## [0.4.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v0.3.0...v0.4.0) (2019-10-08)
 
 ### Features
@@ -43,6 +69,10 @@ The configuration now mandates stylelint v13, and additionally enforces [`value-
 
 - Most if not all of the rules changes in this release are breaking changes. Expect breakage on every minor release until the config reaches v1.0.0.
 
+### Upgrading to v0.4.0
+
+Projects considering this release should [skip straight to v1.0.0](#upgrading-to-v100).
+
 ## [0.3.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v0.2.0...v0.3.0) (2019-09-23)
 
 ### Features
@@ -53,6 +83,10 @@ The configuration now mandates stylelint v13, and additionally enforces [`value-
 
 - Most if not all of the rules changes in this release are breaking changes. Expect breakage on every minor release until the config reaches v1.0.0.
 
+### Upgrading to v0.3.0
+
+Projects considering this release should [skip straight to v1.0.0](#upgrading-to-v100).
+
 ## [0.2.0](https://github.com/torchbox/stylelint-config-torchbox/compare/v0.1.0...v0.2.0) (2019-09-23)
 
 ### Features
@@ -66,6 +100,10 @@ The configuration now mandates stylelint v13, and additionally enforces [`value-
 
 - Most if not all of the rules changes in this release are breaking changes. Expect breakage on every minor release until the config reaches v1.0.0.
 
+### Upgrading to v0.2.0
+
+Projects considering this release should [skip straight to v1.0.0](#upgrading-to-v100).
+
 ## [0.1.0](https://github.com/torchbox/stylelint-config-torchbox/releases/tag/v0.1.0) (2019-08-30)
 
 First release

README.md

@@ -9,8 +9,7 @@
 Install stylelint, and the config:
 
 ```sh
-npm install --save-dev stylelint@13 stylelint-config-torchbox
-
+npm install --save-dev stylelint@13 [email protected]
 ```
 
 Then [configure stylelint to use this config](https://stylelint.io/user-guide/configuration/#extends). As a `stylelint.config.js` in the root of your project:
@@ -24,11 +23,72 @@ module.exports = {
 
 ### Tips
 
-- Use Stylelint’s [`--report-needless-disables`](https://stylelint.io/user-guide/node-api/#reportneedlessdisables) flag to ensure you do not use more `stylelint-disable` comments than needed.
+#### Linting setup for ongoing projects
+
+Review our [CHANGELOG](https://github.com/torchbox/stylelint-config-torchbox/blob/main/CHANGELOG.md) for guidance on how to upgrade a project’s linting to a specific version.
+
+More generally, when retrofitting stricter linting onto an existing project, consider [a gradual approach to linting strictness](https://thib.me/upgrading-to-stricter-eslint-config), so you can start using linting without having to change significant portions of the project’s code. Here is an example, disabling commonly hard-to-retrofit rules:
+
+```js
+// Rules which we ideally would want to enforce but are reporting too many issues currently.
+const legacyRules = {
+  'max-nesting-depth': null,
+  'selector-max-specificity': null,
+};
+
+module.exports = {
+  // See https://github.com/torchbox/stylelint-config-torchbox for rules.
+  extends: 'stylelint-config-torchbox',
+  rules: {
+    ...legacyRules,
+  },
+};
+```
+
+#### Common CLI flags
+
+We recommend the following `run` script to add to your `package.json`:
+
+```json
+"lint:css": "stylelint --report-needless-disables 'src/sass' 'src/vue'"
+```
+
+- Use [`--report-needless-disables`](https://stylelint.io/user-guide/node-api/#reportneedlessdisables) flag to ensure you do not use more `stylelint-disable` comments than needed.
+- Target specific folders so Stylelint doesn’t attempt to lint e.g. JS or HTML files.
+
+#### `.stylelintignore`
+
+Stylelint supports ignore patterns in a `.stylelintignore` file, however we tend not to use this since we lint all files within a given folder.
+
+### Prettier
+
+This config is [Prettier](https://prettier.io/)-compatible, there isn’t anything extra needed.
+
+### Tailwind
+
+This config should work with [Tailwind](https://tailwindcss.com/) with no adjustments needed. Please submit an issue if that’s not the case.
+
+### pre-commit
+
+Here is a sample setup with our recommended configuration for the [pre-commit](https://pre-commit.com/) pre-commit hook framework:
+
+```yaml
+default_language_version:
+  node: system
+repos:
+  - repo: https://github.com/thibaudcolas/pre-commit-stylelint
+    rev: v13.13.1
+    hooks:
+      - id: stylelint
+        files: \.(scss|vue)$
+        additional_dependencies:
+          - [email protected]
+          - [email protected]
+```
 
 ### Vue
 
-stylelint supports Vue, and our configuration is usable in `.vue` single-file components with no changes. Do make sure linting is configured to check `.vue` files:
+Stylelint supports Vue, and our configuration is usable in `.vue` single-file components with no changes. Do make sure linting is configured to check `.vue` files:
 
 - Wherever `stylelint` is manually invoked, make sure to point it both at stylesheets, and Vue components: `stylelint --report-needless-disables './src/sass' './src/vue_components'`.
 - With [`stylelint-webpack-plugin`](https://webpack.js.org/plugins/stylelint-webpack-plugin/), use `extensions: ['scss', 'vue'],`.