Add autofix to font-weight-notation

stylelint · Sep 15, 2022 · efe5283 · efe5283
1 parent b598c18
commit efe5283
Show file tree

Hide file tree

Showing 10 changed files with 189 additions and 110 deletions.
diff --git a/.changeset/cool-zebras-sparkle.md b/.changeset/cool-zebras-sparkle.md
@@ -0,0 +1,5 @@
+---
+"stylelint": minor
+---
+
+Added: `font-weight-notation` autofix
diff --git a/docs/user-guide/rules/list.md b/docs/user-guide/rules/list.md
@@ -123,7 +123,7 @@ Within each cateogory, the rules are grouped by the [_thing_](http://apps.workfl
 
 ### Font weight
 
-- [`font-weight-notation`](../../../lib/rules/font-weight-notation/README.md): Require numeric or named (where possible) `font-weight` values. Also, when named values are expected, require only valid names.
+- [`font-weight-notation`](../../../lib/rules/font-weight-notation/README.md): Require numeric or named (where possible) `font-weight` values. Also, when named values are expected, require only valid names (Autofixable).
 
 ### Function
 

diff --git a/lib/reference/keywords.js b/lib/reference/keywords.js
@@ -311,6 +311,7 @@ module.exports = {
 	fontFamilyKeywords,
 	fontShorthandKeywords,
 	fontSizeKeywords,
+	fontWeightAbsoluteKeywords,
 	fontWeightKeywords,
 	fontWeightRelativeKeywords,
 	gridAreaKeywords,

diff --git a/lib/rules/font-weight-notation/README.md b/lib/rules/font-weight-notation/README.md
@@ -21,6 +21,8 @@ Valid font-weight names are `normal`, `bold`, `bolder`, and `lighter`.
 
 This rule ignores `$sass`, `@less`, and `var(--custom-property)` variable syntaxes.
 
+The [`fix` option](../../../docs/user-guide/usage/options.md#fix) can automatically fix all of the problems reported by this rule.
+
 ## Options
 
 `string`: `"numeric"|"named-where-possible"`

diff --git a/lib/rules/font-weight-notation/__tests__/index.js b/lib/rules/font-weight-notation/__tests__/index.js
@@ -5,6 +5,7 @@ const { messages, ruleName } = require('..');
 testRule({
 	ruleName,
 	config: ['numeric'],
+	fix: true,
 
 	accept: [
 		{
@@ -83,6 +84,10 @@ testRule({
 			code: 'a { font-weight: INITIAL; }',
 			description: 'ignore initial value',
 		},
+		{
+			code: 'a { font-weight: /* bold */ 400; }',
+			description: 'ignore comment',
+		},
 		{
 			code: '@font-face { font-weight: 400; }',
 		},
@@ -115,6 +120,7 @@ testRule({
 	reject: [
 		{
 			code: 'a { font-weight: normal; }',
+			fixed: 'a { font-weight: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
@@ -123,6 +129,7 @@ testRule({
 		},
 		{
 			code: 'a { fOnT-wEiGhT: normal; }',
+			fixed: 'a { fOnT-wEiGhT: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
@@ -131,6 +138,7 @@ testRule({
 		},
 		{
 			code: 'a { FONT-WEIGHT: normal; }',
+			fixed: 'a { FONT-WEIGHT: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
@@ -139,6 +147,7 @@ testRule({
 		},
 		{
 			code: 'a { font-weight: nOrMaL; }',
+			fixed: 'a { font-weight: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
@@ -147,14 +156,25 @@ testRule({
 		},
 		{
 			code: 'a { font-weight: NORMAL; }',
+			fixed: 'a { font-weight: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
 			endLine: 1,
 			endColumn: 24,
 		},
+		{
+			code: 'a { font-weight: /* bold */ normal; }',
+			fixed: 'a { font-weight: /* bold */ 400; }',
+			message: messages.expected('numeric'),
+			line: 1,
+			column: 29,
+			endLine: 1,
+			endColumn: 35,
+		},
 		{
 			code: 'a { font: italic small-caps bolder 16px/3 cursive; }',
+			unfixable: true,
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 29,
@@ -163,6 +183,7 @@ testRule({
 		},
 		{
 			code: 'a { font: normal 16px/3 cursive; }',
+			fixed: 'a { font: 400 16px/3 cursive; }',
 			description: 'one normal and no numbered weight',
 			message: messages.expected('numeric'),
 			line: 1,
@@ -172,6 +193,7 @@ testRule({
 		},
 		{
 			code: 'a { font: normal normal 16px/3 cursive; }',
+			fixed: 'a { font: 400 normal 16px/3 cursive; }',
 			description: 'two normals and no numbered weight',
 			message: messages.expected('numeric'),
 			line: 1,
@@ -181,6 +203,7 @@ testRule({
 		},
 		{
 			code: 'a { font: normal normal normal 16px/3 cursive; }',
+			fixed: 'a { font: 400 normal normal 16px/3 cursive; }',
 			description: 'three normals and no numbered weight',
 			message: messages.expected('numeric'),
 			line: 1,
@@ -190,14 +213,27 @@ testRule({
 		},
 		{
 			code: '@font-face { font-weight: normal bold; }',
-			message: messages.expected('numeric'),
-			line: 1,
-			column: 27,
-			endLine: 1,
-			endColumn: 33,
+			fixed: '@font-face { font-weight: 400 700; }',
+			warnings: [
+				{
+					message: messages.expected('numeric'),
+					line: 1,
+					column: 27,
+					endLine: 1,
+					endColumn: 33,
+				},
+				{
+					message: messages.expected('numeric'),
+					line: 1,
+					column: 34,
+					endLine: 1,
+					endColumn: 38,
+				},
+			],
 		},
 		{
 			code: '@font-face { font-weight: 400 bold; }',
+			fixed: '@font-face { font-weight: 400 700; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 31,
@@ -206,6 +242,7 @@ testRule({
 		},
 		{
 			code: '@font-face { font-weight: normal 700; }',
+			fixed: '@font-face { font-weight: 400 700; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 27,
@@ -214,6 +251,7 @@ testRule({
 		},
 		{
 			code: '@font-face { font-weight: /* 400 */ normal 700; }',
+			fixed: '@font-face { font-weight: /* 400 */ 400 700; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 37,
@@ -222,6 +260,7 @@ testRule({
 		},
 		{
 			code: '@font-face { font-weight: normal /* 400 */700; }',
+			fixed: '@font-face { font-weight: 400 /* 400 */700; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 27,
@@ -230,6 +269,7 @@ testRule({
 		},
 		{
 			code: '@font-face { font-weight: normal/* 400 */ 700; }',
+			fixed: '@font-face { font-weight: 400/* 400 */ 700; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 27,
@@ -242,6 +282,7 @@ testRule({
 testRule({
 	ruleName,
 	config: ['numeric', { ignore: ['relative'] }],
+	fix: true,
 
 	accept: [
 		{
@@ -267,6 +308,7 @@ testRule({
 	reject: [
 		{
 			code: 'a { font-weight: normal; }',
+			fixed: 'a { font-weight: 400; }',
 			message: messages.expected('numeric'),
 			line: 1,
 			column: 18,
@@ -279,6 +321,7 @@ testRule({
 testRule({
 	ruleName,
 	config: ['named-where-possible'],
+	fix: true,
 
 	accept: [
 		{
@@ -357,6 +400,7 @@ testRule({
 	reject: [
 		{
 			code: 'a { font-weight: 400; }',
+			fixed: 'a { font-weight: normal; }',
 			message: messages.expected('named'),
 			line: 1,
 			column: 18,
@@ -365,6 +409,7 @@ testRule({
 		},
 		{
 			code: 'a { font-weight: boldd; }',
+			unfixable: true,
 			description: 'invalid font-weight value',
 			message: messages.invalidNamed('boldd'),
 			line: 1,
@@ -374,6 +419,7 @@ testRule({
 		},
 		{
 			code: 'a { font: italic small-caps 700 16px/3 cursive; }',
+			fixed: 'a { font: italic small-caps bold 16px/3 cursive; }',
 			message: messages.expected('named'),
 			line: 1,
 			column: 29,
@@ -382,6 +428,7 @@ testRule({
 		},
 		{
 			code: 'a { font: normal 400 normal 16px serif; }',
+			fixed: 'a { font: normal normal normal 16px serif; }',
 			description: 'two normals and a numbered weight',
 			message: messages.expected('named'),
 			line: 1,
@@ -391,6 +438,7 @@ testRule({
 		},
 		{
 			code: 'a { font: 400 normal 16px serif; }',
+			fixed: 'a { font: normal normal 16px serif; }',
 			description: 'one normal and a numbered weight',
 			message: messages.expected('named'),
 			line: 1,
@@ -400,6 +448,7 @@ testRule({
 		},
 		{
 			code: 'a { font: 400 16px serif; }',
+			fixed: 'a { font: normal 16px serif; }',
 			description: 'no normals and a numbered weight',
 			message: messages.expected('named'),
 			line: 1,