stylelint-taro 4.0.0-alpha.0

package/src/rules/declaration-property-value-allowed-list/index.ts

@@ -0,0 +1,98 @@
+import stylelint from 'stylelint'
+import declarationValueIndex from 'stylelint/lib/utils/declarationValueIndex'
+import matchesStringOrRegExp from 'stylelint/lib/utils/matchesStringOrRegExp'
+import optionsMatches from 'stylelint/lib/utils/optionsMatches'
+import validateObjectWithArrayProps from 'stylelint/lib/utils/validateObjectWithArrayProps'
+import validateOptions from 'stylelint/lib/utils/validateOptions'
+import { isBoolean, isRegExp, isString } from 'stylelint/lib/utils/validateTypes'
+import vendor from 'stylelint/lib/utils/vendor'
+
+import { findIntersection, log, nameSpace, report, taroDocsUrl } from '../../utils'
+
+import type { Rule } from 'stylelint'
+
+export const ruleName = nameSpace('declaration-property-value-allowed-list')
+
+export const messages = stylelint.utils.ruleMessages(ruleName, {
+  rejected: (property, value, platfrom) => log(`"${property}" 暂不支持值 "${value}"，受限端: "${platfrom}"`)
+})
+
+const meta = {
+  // TODO： 使用Taro文档的规则
+  url: taroDocsUrl('declaration-property-value-allowed-list'),
+}
+
+const rule: Rule = (primary) => {
+
+  return (root, result) => {
+
+    const validOptions = Object.keys(primary).every((key) => {
+      if (primary[key]) {
+        return validateOptions(result, ruleName, {
+          actual: primary[key],
+          possible: [validateObjectWithArrayProps(isString, isRegExp, isBoolean)],
+        })
+      }
+      return true
+    })
+
+    if (!validOptions) {
+      return
+    }
+
+    const { intersection } = findIntersection(primary)
+		
+    Object.keys(intersection).forEach(key => {
+      if (intersection[key] === true) {
+        delete intersection[key]
+      }
+    })
+    const propKeys = Object.keys(intersection)
+
+    // 在这里可以添加额外的逻辑
+    root.walkDecls(decl => {
+      const { prop, value } = decl
+
+      const unprefixedProp = vendor.unprefixed(prop)
+      const propPatterns = propKeys.filter((key) => matchesStringOrRegExp(unprefixedProp, key))
+
+      if (propPatterns.length === 0) {
+        return
+      }
+
+      if (propPatterns.some((pattern) => optionsMatches(intersection, pattern, value))) {
+        return
+      }
+
+      const platforms = []
+      Object.keys(primary).forEach((platform) => {
+        if (primary[platform]) {
+          if (propPatterns.some((pattern) => {
+            return optionsMatches(primary[platform], pattern, value) || primary[platform][pattern] === true
+          })) {
+            return 
+          }
+          platforms.push(platform)
+        }
+      })
+
+      const index = declarationValueIndex(decl)
+      const endIndex = index + decl.value.length
+			
+      report({
+        message: messages.rejected(prop, value, platforms.join(', ')),
+        node: decl,
+        index,
+        endIndex,
+        result,
+        ruleName,
+      })
+    })
+  }
+}
+
+rule.ruleName = ruleName
+rule.messages = messages
+rule.meta = meta
+
+export default rule

package/src/rules/index.ts

@@ -0,0 +1,11 @@
+import declarationPropertyValueAllowedList from './declaration-property-value-allowed-list'
+import noNestedSelectors from './no-nested-selectors'
+import propertyAllowedList from './property-allowed-list'
+
+const rules = {
+  'no-nested-selectors': noNestedSelectors,
+  'property-allowed-list': propertyAllowedList,
+  'declaration-property-value-allowed-list': declarationPropertyValueAllowedList,
+}
+
+export default rules

package/src/rules/no-nested-selectors/index.ts

@@ -0,0 +1,46 @@
+import stylelint, { utils } from 'stylelint'
+
+import { log, nameSpace, report, taroDocsUrl } from '../../utils'
+
+import type { Rule } from 'stylelint'
+
+export const ruleName = nameSpace('no-nested-selectors')
+
+export const messages = stylelint.utils.ruleMessages(ruleName, {
+  rejected: (selector, platfrom) => log(`"${selector}" 仅能使用单个class选择器，受限端 "${platfrom}"`)
+})
+
+const meta = {
+  // TODO： 使用Taro文档的规则
+  url: taroDocsUrl('no-nested-selectors'),
+}
+
+const rule: Rule = (primary) => {
+  return (root, result) => {
+    const validOptions = utils.validateOptions(result, ruleName, {
+      actual: primary
+    })
+    if (!validOptions)
+      return
+    const platform = ['harmony', 'rn']
+    
+    root.walkRules(ruleNode => {
+      const selector = ruleNode.selector
+      if (!/^[.#]?[a-zA-Z0-9_-]+$/.test(selector)) {
+        report({
+          ruleName,
+          result,
+          node: ruleNode,
+          message: messages.rejected(selector, platform.join(', ')),
+        })
+      }
+          
+    })
+  }
+}
+
+rule.ruleName = ruleName
+rule.messages = messages
+rule.meta = meta
+
+export default rule

package/src/rules/property-allowed-list/index.ts

@@ -0,0 +1,94 @@
+import _ from 'lodash'
+import stylelint from 'stylelint'
+import isCustomProperty from 'stylelint/lib/utils/isCustomProperty'
+import isStandardSyntaxProperty from 'stylelint/lib/utils/isStandardSyntaxProperty'
+import matchesStringOrRegExp from 'stylelint/lib/utils/matchesStringOrRegExp'
+import validateObjectWithArrayProps from 'stylelint/lib/utils/validateObjectWithArrayProps'
+import validateOptions from 'stylelint/lib/utils/validateOptions'
+import { isBoolean, isRegExp, isString } from 'stylelint/lib/utils/validateTypes'
+import vendor from 'stylelint/lib/utils/vendor'
+
+import { log, nameSpace, report, taroDocsUrl } from '../../utils'
+
+import type { Rule } from 'stylelint'
+
+
+export const ruleName = nameSpace('property-allowed-list')
+
+export const messages = stylelint.utils.ruleMessages(ruleName, {
+  rejected: (property, platfrom) => log(`"${property}" 暂不支持该属性，受限端 "${platfrom}"`)
+})
+
+const meta = {
+  // TODO： 使用Taro文档的规则
+  url: taroDocsUrl('property-allowed-list'),
+}
+
+const rule: Rule = (primary) => {
+
+  return (root, result) => {
+    const validOptions = Object.keys(primary).every((key) => {
+      if (primary[key]) {
+        return validateOptions(result, ruleName, {
+          actual: primary[key],
+          possible: [validateObjectWithArrayProps(isString, isRegExp, isBoolean)],
+        })
+      }
+      return true
+    })
+
+    if (!validOptions) {
+      return
+    }
+
+    const _arr = []
+    Object.keys(primary).forEach(key => {
+      _arr.push(...Object.keys(primary[key]))
+    })
+    const intersectionKeys = _.intersection(_arr)
+
+    // 在这里可以添加额外的逻辑
+    root.walkDecls(decl => {
+      const prop = decl.prop
+
+      if (!isStandardSyntaxProperty(prop)) {
+        return
+      }
+
+      if (isCustomProperty(prop)) {
+        return
+      }
+
+      // either the prefix or unprefixed version is in the list
+      if (matchesStringOrRegExp([prop, vendor.unprefixed(prop)], intersectionKeys)) {
+        return
+      }
+
+      const platform = []
+      Object.keys(primary).forEach(key => {
+        if (primary[key]) {
+          const platformKeys = Object.keys(primary[key])
+          if (platformKeys.length > 0) {
+            if (!platformKeys.includes(prop)) {
+              platform.push(key)
+            }
+          }
+        }
+      })
+
+      report({
+        message: messages.rejected(prop, platform.join(', ')),
+        word: prop,
+        node: decl,
+        result,
+        ruleName,
+      })
+    })
+  }
+}
+
+rule.ruleName = ruleName
+rule.messages = messages
+rule.meta = meta
+
+export default rule

package/src/utils/index.ts

@@ -0,0 +1,69 @@
+import { utils } from 'stylelint'
+
+import type { Problem } from 'stylelint'
+
+export function taroDocsUrl(_: string) {
+  return `https://taro-docs.jd.com/docs/`
+}
+
+export function nameSpace(ruleName: string) {
+  // 前缀视个人情况而定
+  return `taro/${ruleName}`
+}
+export function newMessage(ruleName: string, options) {
+  return utils.ruleMessages(ruleName, options)
+}
+
+export function report(problem: Problem) {
+  return utils.report(problem)
+}
+
+export function log(text: string) {
+  // vscode下不添加颜色
+  if (!process.env.TARO_ENV) {
+    return text
+  }
+  return text
+  // return highlightQuotaValue(text)
+}
+
+export function findIntersection(data) {
+  const keys = Object.keys(data)
+  let intersection = {}
+
+  if (keys.length > 1) {
+    const firstKey = keys[0]
+    const firstProps = data[firstKey]
+
+    for (const prop in firstProps) {
+      const firstValues = firstProps[prop]
+      let commonValues = firstValues || []
+
+      for (let i = 1; i < keys.length; i++) {
+        const currentKey = keys[i]
+        const currentProps = data[currentKey]
+        const currentValues = currentProps[prop]
+
+        if (Array.isArray(commonValues)) {
+          if (Array.isArray(currentValues)) {
+            commonValues = commonValues.filter(value => currentValues.includes(value))
+          } else if (currentValues){
+            commonValues = commonValues.filter(value => currentValues === true || currentValues.includes(value))
+          }
+        } else if (commonValues === true) {
+          commonValues = currentValues || []
+        } else {
+          commonValues = []
+        }
+      }
+
+      if (commonValues.length > 0) {
+        intersection[prop] = commonValues
+      }
+    }
+  } else {
+    intersection = data[keys[0]]
+  }
+
+  return { intersection }
+}