@navikt/aksel-stylelint 3.0.0-beta.8 → 3.4.0

package/README.md

@@ -29,24 +29,60 @@ It should be sufficient for most cases to extend the recommended defaults.
   }
 ```
 
-## aksel-design-token-exists
+## aksel/design-token-exists
 
-This rule checks that if you use one of the reserved token prefixes `--a-` or `--ac-` then the token itself _must_ be provided by design system.
-
-In addition it checks that you:
-
-- don't **_reference_** a component level token. As they are only supposed to be overridden.
-- don't **_override_** a global level token. As they are only supposed to be referenced.
+Makes sure all referenced CSS-variables with prefix `--a-` or `--ac-` exists in Aksels token-collection. As a side-effect Aksel reserves these prefixes for its design-tokens.
 
 ❌ Incorrect:
 
 ```css
-html h1 {
+html {
     --a-my-own-color-bg-hover: #f2f2f2;
     ^^^^^^^^^^^^^^^^^^^^^^^^^
-    background-color: var(--a-my-own-color-bg-hover, #ffffff);
+    background-color: var(--a-my-own-color-bg-hover);
                           ^^^^^^^^^^^^^^^^^^^^^^^^^
-    stroke: var(--ac-button-loader-stroke));
+}
+```
+
+✅ Correct:
+
+```css
+html {
+  background-color: var(--custom-tag-surface-default);
+}
+```
+
+## aksel/design-token-no-global-override
+
+Makes sure you don't override global level tokens with `--a-`-prefix. Global/Semantic tokens are supposed to be used as is, and not overridden. That is unless you are theming your solution to match a different sub-brands or brands. In those cases we encourage to make all the changes in a single 'config'-file, then disable the rule for that file only.
+
+❌ Incorrect:
+
+```css
+div {
+    --a-surface-default: #f2f2f2;
+    ^^^^^^^^^^^^^^^^^^^
+}
+```
+
+✅ Correct:
+
+```css
+div {
+  background-color: var(--a-surface-default);
+}
+```
+
+## aksel/design-token-no-component-reference
+
+Makes sure you don't reference component level tokens with `--ac-`-prefix. Component level tokens are only supposed to be overridden, not referenced.
+This is since they are by default not defined, leading to unknown side-effects when referenced incorrectly.
+
+❌ Incorrect:
+
+```css
+html {
+    stroke: var(--ac-button-loader-stroke);
                 ^^^^^^^^^^^^^^^^^^^^^^^^^
 }
 ```
@@ -54,15 +90,14 @@ html h1 {
 ✅ Correct:
 
 ```css
-html h1 {
-  background-color: var(--a-surface-default, #ffffff);
+html {
   --ac-button-loader-stroke: lawngreen;
 }
 ```
 
-## aksel-no-internal-tokens
+## aksel/no-internal-tokens
 
-Disallows use or override of internal Aksel design tokens. Internal tokens are not supposed to be used outside the design system, and they may be changed or removed without warning. Be aware that the rule simply checks the prefix of the token, and not if it actually exists in the design system. Even if it doesn't exist, using design system prefixes should be avoided.
+Disallows use or override of internal Aksel design tokens. Internal tokens are not supposed to be used outside the design system, and may be changed or removed without warning. Be aware that the rule simply checks the prefix of the token, and not if it actually exists in the design system. Even if it doesn't exist, using design system prefixes should be avoided.
 
 ❌ Incorrect:
 
@@ -92,7 +127,7 @@ a {
 }
 ```
 
-## aksel-no-class-override
+## aksel/no-class-override
 
 Warns when trying to override design system styling by using class selectors that starts with "navds-" or "navdsi-". Overriding styles in the design system is discouraged. We want to have consistent look and feel across applications. Even if it seems to work fine now, it might break on subsequent updates in the design system.
 
@@ -116,7 +151,7 @@ Warns when trying to override design system styling by using class selectors tha
 }
 ```
 
-## aksel-no-deprecated-classes
+## aksel/no-deprecated-classes
 
 Warns when you try to use deprecated class names.
 

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@navikt/aksel-stylelint",
-  "version": "3.0.0-beta.8",
+  "version": "3.4.0",
   "author": "Aksel | NAV",
-  "homepage": "https://aksel.nav.no/lint",
+  "homepage": "https://aksel.nav.no/grunnleggende/kode/stylelint",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/navikt/aksel.git",
-    "directory": "@navikt/aksel-icons"
+    "directory": "@navikt/aksel-stylelint"
   },
   "keywords": [
     "aksel",
-    "stylelint"
+    "stylelint",
+    "config",
+    "linting"
   ],
   "publishConfig": {
     "access": "public"
@@ -34,6 +36,8 @@
     "dev": "yarn watch:lint"
   },
   "devDependencies": {
+    "@navikt/ds-css": "^3.4.0",
+    "@navikt/ds-tokens": "^3.4.0",
     "@types/jest": "^29.0.0",
     "concurrently": "7.2.1",
     "copyfiles": "2.4.1",

package/dist/deprecations.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deprecations = void 0;
-exports.deprecations = [
-    {
-        classes: ["navdsi-deprecated-example", "navdsi-other-deprecated-example"],
-        message: "Removed in vX.X.X, see documentation [link] for more information",
-    },
-];