Update lint rules

kgryte · kgryte · commit 24e714462a3c · 2017-08-24T14:14:47.000-07:00
diff --git a/etc/remark/plugins/lint/index.js b/etc/remark/plugins/lint/index.js
@@ -33,12 +33,12 @@ plugins.push([
 * @example
 * <!-- Bad -->
 *
-* * [X] checked
+* *   [X] checked
 *
 * @example
 * <!-- Good -->
 *
-* * [x] checked
+* *   [x] checked
 */
 plugins.push([
 	require( 'remark-lint-checkbox-character-style' ),
@@ -59,12 +59,12 @@ plugins.push([
 * @example
 * <!-- Bad -->
 *
-* * [x]    checked
+* *   [x]    checked
 *
 * @example
 * <!-- Good -->
 *
-* * [x] checked
+* *   [x] checked
 */
 plugins.push([
 	require( 'remark-lint-checkbox-content-indent' ),
@@ -335,14 +335,14 @@ plugins.push([
 * @example
 * <!-- Bad -->
 *
-*     * Beep
-*     * Boop
+*     *   Beep
+*     *   Boop
 *
 * @example
 * <!-- Good -->
 *
-* * Beep
-* * Boop
+* *   Beep
+* *   Boop
 *
 */
 plugins.push([
@@ -358,14 +358,14 @@ plugins.push([
 * @example
 * <!-- Bad -->
 *
-* * Beep
-*     - Boop
+* *   Beep
+*   -   Boop
 *
 * @example
 * <!-- Good -->
 *
-* * Beep
-*   - Boop
+* *   Beep
+*     -   Boop
 *
 */
 plugins.push([
@@ -381,17 +381,17 @@ plugins.push([
 * @example
 * <!-- Good -->
 *
-* * Hello
-* * World
+* *   Hello
+* *   World
 *
 * @example
 * <!-- Good -->
 *
-* * Beep
-*   boop
+* *   Beep
+*     boop
 *
-* * Bop
-*   bip
+* *   Bop
+*     bip
 *
 */
 plugins.push([
@@ -407,26 +407,26 @@ plugins.push([
 * @example
 * <!-- Bad -->
 *
-* * Beep
-* * Boop
+* *   Beep
+* *   Boop
 *
-* * Bop
+* *   Bop
 *
 * @example
 * <!-- Good -->
 *
-* * Beep
-* * Boop
-* * Bop
+* *   Beep
+* *   Boop
+* *   Bop
 *
 * @example
 * <!-- Okay -->
 *
-* * Beep
+* *   Beep
 *
-* * Boop
+* *   Boop
 *
-* * Bop
+* *   Bop
 *
 */
 plugins.push([
@@ -998,7 +998,7 @@ plugins.push([
 ]);
 
 /**
-* Never allow table indentation.
+* Never allow table indentation. Note that the exception is when a table correspond to a list item.
 *
 * @see [no-table-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-table-indentation}
 *
@@ -1027,7 +1027,7 @@ plugins.push([
 ]);
 
 /**
-* Never allow the use of spaces.
+* Never allow the use of tabs.
 *
 * @see [no-tabs]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-tabs}
 */
@@ -1133,45 +1133,45 @@ plugins.push([
 ]);
 
 /**
-* Require that the horizontal rule style be three consecutive dashes `---`.
+* Require that the horizontal rule style be three consecutive asterisks `---`.
 *
 * @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}
 *
 * @example
 * <!-- Bad -->
 *
-* * * *
+* ---
 *
 * @example
 * <!-- Good -->
 *
-* ---
+* * * *
 *
 */
 plugins.push([
 	require( 'remark-lint-rule-style' ),
-	[ 'error', '---' ]
+	[ 'error', '* * *' ]
 ]);
 
 /**
-* Set the strong marker to underscores.
+* Set the strong marker to asterisks.
 *
 * @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}
 *
 * @example
 * <!-- Bad -->
 *
-* **Beep**.
+* __Beep__.
 *
 * @example
 * <!-- Good -->
 *
-* __Beep__.
+* **Beep**.
 *
 */
 plugins.push([
 	require( 'remark-lint-strong-marker' ),
-	[ 'error', '_' ]
+	[ 'error', '*' ]
 ]);
 
 /**
@@ -1250,30 +1250,30 @@ plugins.push([
 ]);
 
 /**
-* Prefer that the unordered list marker be an asterisk `*`, but allow discretion to maximize clarity and readability.
+* Require that the unordered list marker be a dash `-`.
 *
 * @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}
 *
 * @example
-* <!-- Okay -->
+* <!-- Bad -->
 *
-* * Beep
-* * Boop
+* *   Beep
+* *   Boop
 *
 * @example
 * <!-- Okay -->
 *
-* * Beep
+* -   Beep
 *
-*   - Foo
-*   - Bar
+*     -   Foo
+*     -   Bar
 *
-* * Boop
+* -   Boop
 *
 */
 plugins.push([
 	require( 'remark-lint-unordered-list-marker-style' ),
-	[ 'off', '*' ]
+	[ 'error', '-' ]
 ]);
 
 

Original file line number	Diff line number	Diff line change
`@@ -33,12 +33,12 @@ plugins.push([`
`33`	`33`	`* @example`
`34`	`34`	`* <!-- Bad -->`
`35`	`35`	`*`
`36`		`-* * [X] checked`
	`36`	`+* * [X] checked`
`37`	`37`	`*`
`38`	`38`	`* @example`
`39`	`39`	`* <!-- Good -->`
`40`	`40`	`*`
`41`		`-* * [x] checked`
	`41`	`+* * [x] checked`
`42`	`42`	`*/`
`43`	`43`	`plugins.push([`
`44`	`44`	`require( 'remark-lint-checkbox-character-style' ),`
`@@ -59,12 +59,12 @@ plugins.push([`
`59`	`59`	`* @example`
`60`	`60`	`* <!-- Bad -->`
`61`	`61`	`*`
`62`		`-* * [x] checked`
	`62`	`+* * [x] checked`
`63`	`63`	`*`
`64`	`64`	`* @example`
`65`	`65`	`* <!-- Good -->`
`66`	`66`	`*`
`67`		`-* * [x] checked`
	`67`	`+* * [x] checked`
`68`	`68`	`*/`
`69`	`69`	`plugins.push([`
`70`	`70`	`require( 'remark-lint-checkbox-content-indent' ),`
`@@ -335,14 +335,14 @@ plugins.push([`
`335`	`335`	`* @example`
`336`	`336`	`* <!-- Bad -->`
`337`	`337`	`*`
`338`		`-* * Beep`
`339`		`-* * Boop`
	`338`	`+* * Beep`
	`339`	`+* * Boop`
`340`	`340`	`*`
`341`	`341`	`* @example`
`342`	`342`	`* <!-- Good -->`
`343`	`343`	`*`
`344`		`-* * Beep`
`345`		`-* * Boop`
	`344`	`+* * Beep`
	`345`	`+* * Boop`
`346`	`346`	`*`
`347`	`347`	`*/`
`348`	`348`	`plugins.push([`
`@@ -358,14 +358,14 @@ plugins.push([`
`358`	`358`	`* @example`
`359`	`359`	`* <!-- Bad -->`
`360`	`360`	`*`
`361`		`-* * Beep`
`362`		`-* - Boop`
	`361`	`+* * Beep`
	`362`	`+* - Boop`
`363`	`363`	`*`
`364`	`364`	`* @example`
`365`	`365`	`* <!-- Good -->`
`366`	`366`	`*`
`367`		`-* * Beep`
`368`		`-* - Boop`
	`367`	`+* * Beep`
	`368`	`+* - Boop`
`369`	`369`	`*`
`370`	`370`	`*/`
`371`	`371`	`plugins.push([`
`@@ -381,17 +381,17 @@ plugins.push([`
`381`	`381`	`* @example`
`382`	`382`	`* <!-- Good -->`
`383`	`383`	`*`
`384`		`-* * Hello`
`385`		`-* * World`
	`384`	`+* * Hello`
	`385`	`+* * World`
`386`	`386`	`*`
`387`	`387`	`* @example`
`388`	`388`	`* <!-- Good -->`
`389`	`389`	`*`
`390`		`-* * Beep`
`391`		`-* boop`
	`390`	`+* * Beep`
	`391`	`+* boop`
`392`	`392`	`*`
`393`		`-* * Bop`
`394`		`-* bip`
	`393`	`+* * Bop`
	`394`	`+* bip`
`395`	`395`	`*`
`396`	`396`	`*/`
`397`	`397`	`plugins.push([`
`@@ -407,26 +407,26 @@ plugins.push([`
`407`	`407`	`* @example`
`408`	`408`	`* <!-- Bad -->`
`409`	`409`	`*`
`410`		`-* * Beep`
`411`		`-* * Boop`
	`410`	`+* * Beep`
	`411`	`+* * Boop`
`412`	`412`	`*`
`413`		`-* * Bop`
	`413`	`+* * Bop`
`414`	`414`	`*`
`415`	`415`	`* @example`
`416`	`416`	`* <!-- Good -->`
`417`	`417`	`*`
`418`		`-* * Beep`
`419`		`-* * Boop`
`420`		`-* * Bop`
	`418`	`+* * Beep`
	`419`	`+* * Boop`
	`420`	`+* * Bop`
`421`	`421`	`*`
`422`	`422`	`* @example`
`423`	`423`	`* <!-- Okay -->`
`424`	`424`	`*`
`425`		`-* * Beep`
	`425`	`+* * Beep`
`426`	`426`	`*`
`427`		`-* * Boop`
	`427`	`+* * Boop`
`428`	`428`	`*`
`429`		`-* * Bop`
	`429`	`+* * Bop`
`430`	`430`	`*`
`431`	`431`	`*/`
`432`	`432`	`plugins.push([`
`@@ -998,7 +998,7 @@ plugins.push([`
`998`	`998`	`]);`
`999`	`999`
`1000`	`1000`	`/**`
`1001`		`-* Never allow table indentation.`
	`1001`	`+* Never allow table indentation. Note that the exception is when a table correspond to a list item.`
`1002`	`1002`	`*`
`1003`	`1003`	`* @see [no-table-indentation]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-table-indentation}`
`1004`	`1004`	`*`
`@@ -1027,7 +1027,7 @@ plugins.push([`
`1027`	`1027`	`]);`
`1028`	`1028`
`1029`	`1029`	`/**`
`1030`		`-* Never allow the use of spaces.`
	`1030`	`+* Never allow the use of tabs.`
`1031`	`1031`	`*`
`1032`	`1032`	`* @see [no-tabs]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-no-tabs}`
`1033`	`1033`	`*/`
`@@ -1133,45 +1133,45 @@ plugins.push([`
`1133`	`1133`	`]);`
`1134`	`1134`
`1135`	`1135`	`/**`
`1136`		-* Require that the horizontal rule style be three consecutive dashes `---`.
	`1136`	+* Require that the horizontal rule style be three consecutive asterisks `---`.
`1137`	`1137`	`*`
`1138`	`1138`	`* @see [rule-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style}`
`1139`	`1139`	`*`
`1140`	`1140`	`* @example`
`1141`	`1141`	`* <!-- Bad -->`
`1142`	`1142`	`*`
`1143`		`-* * * *`
	`1143`	`+* ---`
`1144`	`1144`	`*`
`1145`	`1145`	`* @example`
`1146`	`1146`	`* <!-- Good -->`
`1147`	`1147`	`*`
`1148`		`-* ---`
	`1148`	`+* * * *`
`1149`	`1149`	`*`
`1150`	`1150`	`*/`
`1151`	`1151`	`plugins.push([`
`1152`	`1152`	`require( 'remark-lint-rule-style' ),`
`1153`		`- [ 'error', '---' ]`
	`1153`	`+ [ 'error', '* * *' ]`
`1154`	`1154`	`]);`
`1155`	`1155`
`1156`	`1156`	`/**`
`1157`		`-* Set the strong marker to underscores.`
	`1157`	`+* Set the strong marker to asterisks.`
`1158`	`1158`	`*`
`1159`	`1159`	`* @see [strong-marker]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker}`
`1160`	`1160`	`*`
`1161`	`1161`	`* @example`
`1162`	`1162`	`* <!-- Bad -->`
`1163`	`1163`	`*`
`1164`		`-* Beep.`
	`1164`	`+* __Beep__.`
`1165`	`1165`	`*`
`1166`	`1166`	`* @example`
`1167`	`1167`	`* <!-- Good -->`
`1168`	`1168`	`*`
`1169`		`-* __Beep__.`
	`1169`	`+* Beep.`
`1170`	`1170`	`*`
`1171`	`1171`	`*/`
`1172`	`1172`	`plugins.push([`
`1173`	`1173`	`require( 'remark-lint-strong-marker' ),`
`1174`		`- [ 'error', '_' ]`
	`1174`	`+ [ 'error', '*' ]`
`1175`	`1175`	`]);`
`1176`	`1176`
`1177`	`1177`	`/**`
`@@ -1250,30 +1250,30 @@ plugins.push([`
`1250`	`1250`	`]);`
`1251`	`1251`
`1252`	`1252`	`/**`
`1253`		-* Prefer that the unordered list marker be an asterisk `*`, but allow discretion to maximize clarity and readability.
	`1253`	+* Require that the unordered list marker be a dash `-`.
`1254`	`1254`	`*`
`1255`	`1255`	`* @see [unordered-list-marker-style]{@link https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-unordered-list-marker-style}`
`1256`	`1256`	`*`
`1257`	`1257`	`* @example`
`1258`		`-* <!-- Okay -->`
	`1258`	`+* <!-- Bad -->`
`1259`	`1259`	`*`
`1260`		`-* * Beep`
`1261`		`-* * Boop`
	`1260`	`+* * Beep`
	`1261`	`+* * Boop`
`1262`	`1262`	`*`
`1263`	`1263`	`* @example`
`1264`	`1264`	`* <!-- Okay -->`
`1265`	`1265`	`*`
`1266`		`-* * Beep`
	`1266`	`+* - Beep`
`1267`	`1267`	`*`
`1268`		`-* - Foo`
`1269`		`-* - Bar`
	`1268`	`+* - Foo`
	`1269`	`+* - Bar`
`1270`	`1270`	`*`
`1271`		`-* * Boop`
	`1271`	`+* - Boop`
`1272`	`1272`	`*`
`1273`	`1273`	`*/`
`1274`	`1274`	`plugins.push([`
`1275`	`1275`	`require( 'remark-lint-unordered-list-marker-style' ),`
`1276`		`- [ 'off', '*' ]`
	`1276`	`+ [ 'error', '-' ]`
`1277`	`1277`	`]);`
`1278`	`1278`
`1279`	`1279`