Initial commit

node_modules/stylelint/lib/rules/function-name-case/README.md

@@ -0,0 +1,225 @@
+# function-name-case
+
+Specify lowercase or uppercase for function names.
+
+```css
+a { width: calc(5% - 10em); }
+/**        ↑
+ * These functions */
+```
+
+Camel case function names, e.g. `translateX`, are accounted for when the `lower` option is used.
+
+## Options
+
+`string`: `"lower"|"upper"`
+
+### `"lower"`
+
+The following patterns are considered warnings:
+
+```css
+a {
+  width: Calc(5% - 10em);
+}
+```
+
+```css
+a {
+  width: cAlC(5% - 10em);
+}
+```
+
+```css
+a {
+  width: CALC(5% - 10em);
+}
+```
+
+```css
+a {
+  background: -WEBKIT-RADIAL-GRADIENT(red, green, blue);
+}
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a {
+  width: calc(5% - 10em);
+}
+```
+
+```css
+a {
+  background: -webkit-radial-gradient(red, green, blue);
+}
+```
+
+### `"upper"`
+
+The following patterns are considered warnings:
+
+```css
+a {
+  width: Calc(5% - 10em);
+}
+```
+
+```css
+a {
+  width: cAlC(5% - 10em);
+}
+```
+
+```css
+a {
+  width: calc(5% - 10em);
+}
+```
+
+```css
+a {
+  background: -webkit-radial-gradient(red, green, blue);
+}
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a {
+  width: CALC(5% - 10em);
+}
+```
+
+```css
+a {
+  background: -WEBKIT-RADIAL-GRADIENT(red, green, blue);
+}
+```
+
+## Optional secondary options
+
+### `ignoreFunctions: ["/regex/", "non-regex"]`
+
+Ignore case of function names.
+
+For example, with `"lower"`.
+
+Given:
+
+```js
+["SOME-FUNCTION", "/^get.*$/"]
+```
+
+The following patterns are considered warnings:
+
+```css
+a {
+  color: sOmE-FuNcTiOn();
+}
+```
+
+```css
+a {
+  color: OTHER-SOME-FUNCTION();
+}
+```
+
+```css
+a {
+  color: GetColor();
+}
+```
+
+```css
+a {
+  color: GET_COLOR();
+}
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a {
+  display: some-function();
+}
+```
+
+```css
+a {
+  display: SOME-FUNCTION();
+}
+```
+
+```css
+a {
+  display: getColor();
+}
+```
+
+```css
+a {
+  display: get_color();
+}
+```
+
+For example, with `"upper"`.
+
+Given:
+
+```js
+["some-function", "/^get.*$/"]
+```
+
+The following patterns are considered warnings:
+
+```css
+a {
+  color: sOmE-FuNcTiOn();
+}
+```
+
+```css
+a {
+  color: other-some-function();
+}
+```
+
+```css
+a {
+  color: GetColor();
+}
+```
+
+```css
+a {
+  color: GET_COLOR();
+}
+```
+
+The following patterns are *not* considered warnings:
+
+```css
+a {
+  display: some-function();
+}
+```
+
+```css
+a {
+  display: SOME-FUNCTION();
+}
+```
+
+```css
+a {
+  display: getColor();
+}
+```
+
+```css
+a {
+  display: get_color();
+}
+```