Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate *-blacklist/*-requirelist/*-whitelist #4892

Merged
merged 4 commits into from Aug 31, 2020

Commits on Aug 24, 2020

  1. Make copies for *-blacklist/*-requirelist/*-whitelist rules

    As discussed in issue stylelint#4854, the desired approach is to deprecate the
    *-blacklist/*-requirelist/*-whitelist rules. The first step I've taken
    to doing this is to make copies of all the rules. The commands used to
    generate this commit were:
    
    - find . -name '*-allowed-list' -exec sh -c 'cp -R "$1" "${1%-allowed-list}-whitelist"' _ {} \;
    - find . -name '*-disallowed-list' -exec sh -c 'cp -R "$1" "${1%-disallowed-list}-blacklist"' _ {} \;
    - find . -name '*-required-list' -exec sh -c 'cp -R "$1" "${1%-required-list}-requirelist"' _ {} \;
    kevindew committed Aug 24, 2020
    Copy the full SHA
    42c68d6 View commit details
    Browse the repository at this point in the history
  2. Re-instate *-blacklist/*-requirelist/*-whitelist rules

    The aliasing approach taken for these rule renaming presented user
    experience problems [1]. To resolve these problems the preference is to
    revert on the aliasing strategy and instead return to a deprecation
    strategy. The first step towards this is re-instating these rules.
    
    As per the preference of jeddy3 [2] these rules are re-instated using a copy
    and paste strategy, with the expectation these will be removed in the
    next major release. An approach that didn't involve copy and pasting was
    previously introduced in [3] and could be looked at again if maintaining this
    duplicate code proves problematic.
    
    [1]: stylelint#4854 (comment)
    [2]: stylelint#4854 (comment)
    [3]: stylelint@e93e44c
    kevindew committed Aug 24, 2020
    Copy the full SHA
    af05f79 View commit details
    Browse the repository at this point in the history
  3. Deprecate *-blacklist/*-requirelist/*-whitelist rules

    This applies deprecation warnings when these rules are used, tests to
    check there is a deprecation warning and re-includes them in
    documentation.
    kevindew committed Aug 24, 2020
    Copy the full SHA
    99877b6 View commit details
    Browse the repository at this point in the history

Commits on Aug 25, 2020

  1. Deprecation links point to GitHub tag

    This reflects the documentation on deprecating stylelint rules [1] by
    linking to the GitHub website rather than stylelint website, so that the
    link can continue operating indefinitely.
    
    As suggested in the PR [2] these have been linked to the anticipated next
    release of stylelint, so these links will not be actually operational
    until this tag is made.
    
    [1]: https://github.com/stylelint/stylelint/blob/858dcd584224042654d80ce8fa8ad71f41f20808/docs/developer-guide/rules.md#deprecate-a-rule
    [2]: stylelint#4892 (comment)
    kevindew committed Aug 25, 2020
    Copy the full SHA
    2794d6f View commit details
    Browse the repository at this point in the history