.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / stylelint / lib / rules / comment-whitespace-inside / README.md
diff --git a/.config/coc/extensions/node_modules/coc-prettier/node_modules/stylelint/lib/rules/comment-whitespace-inside/README.md b/.config/coc/extensions/node_modules/coc-prettier/node_modules/stylelint/lib/rules/comment-whitespace-inside/README.md
new file mode 100644 (file)
index 0000000..2091b61
--- /dev/null
@@ -0,0 +1,84 @@
+# comment-whitespace-inside
+
+Require or disallow whitespace on the inside of comment markers.
+
+```css
+    /* comment */
+/**  ↑         ↑
+ * The space inside these two markers */
+```
+
+Any number of asterisks are allowed at the beginning or end of the comment. So `/** comment **/` is treated the same way as `/* comment */`.
+
+**Caveat:** Comments within *selector and value lists* are currently ignored.
+
+## Options
+
+`string`: `"always"|"never"`
+
+### `"always"`
+
+There *must always* be whitespace inside the markers.
+
+The following patterns are considered violations:
+
+```css
+/*comment*/
+```
+
+```css
+/*comment */
+```
+
+```css
+/** comment**/
+```
+
+The following patterns are *not* considered violations:
+
+```css
+/* comment */
+```
+
+```css
+/** comment **/
+```
+
+```css
+/**
+ * comment
+ */
+```
+
+```css
+/*     comment
+*/
+```
+
+### `"never"`
+
+There *must never* be whitespace on the inside the markers.
+
+The following patterns are considered violations:
+
+```css
+/* comment */
+```
+
+```css
+/*comment */
+```
+
+```css
+/** comment**/
+```
+
+The following patterns are *not* considered violations:
+
+```css
+/*comment*/
+```
+
+```css
+/****comment****/
+```