diff --git a/tests/Levenshtein.elm b/tests/Levenshtein.elm new file mode 100644 index 00000000..f9426309 --- /dev/null +++ b/tests/Levenshtein.elm @@ -0,0 +1,348 @@ +module Levenshtein exposing (distance) + +{-| Levenshtein distance is a metric for measuring the difference between two strings. + +@docs distance + +Copied from + +-} + +import Array exposing (Array) + + +{-| Computes the Levenshtein distance between two strings. +-} +distance : String -> String -> Int +distance str1 str2 = + if str1 == str2 then + 0 + + else + distanceHelper + (Array.fromList (String.toList str1)) + (Array.fromList (String.toList str2)) + + +distanceHelper : Array Char -> Array Char -> Int +distanceHelper arr1 arr2 = + let + calculateEditDistanceForChars : Table -> ( Int, Int ) -> ( Table, Int ) + calculateEditDistanceForChars table ( i, j ) = + case ( Array.get (i - 1) arr1, Array.get (j - 1) arr2 ) of + ( Just chr1, Just chr2 ) -> + let + ( table1, dist1 ) = + tableFetch ( i - 1, j ) calculateEditDistanceForChars table + + ( table2, dist2 ) = + tableFetch ( i, j - 1 ) calculateEditDistanceForChars table1 + + ( table3, dist3 ) = + tableFetch ( i - 1, j - 1 ) calculateEditDistanceForChars table2 + in + ( table3 + -- Find the smallest of (dist1 + 1), (dist2 + 1), and (dist3 + distanceIndicator) + , if dist3 < dist1 then + if dist3 < dist2 then + if chr1 /= chr2 then + dist3 + 1 + + else + dist3 + + else + dist1 + 1 + + else if dist1 > dist2 then + dist2 + 1 + + else + dist1 + 1 + ) + + _ -> + ( table, max i j ) + + indecesForLastChars = + ( Array.length arr1, Array.length arr2 ) + in + calculateEditDistanceForChars (tableEmpty indecesForLastChars) indecesForLastChars + |> Tuple.second + + + +--- tableElm +{- + The algorithm goes across the various combinations of characters in the two strings to be compared. + The result of every combination can be looked at like a grid: + + - K I T T E N + - (0,0) (1,0) (2,0) (3,0) (4,0) (5,0) (6,0) + S (0,1) (1,1) (2,1) (3,1) (4,1) (5,1) (6,1) + I (0,2) (1,2) (2,2) (3,2) (4,2) (5,2) (6,2) + T (0,3) (1,3) (2,3) (3,3) (4,3) (5,3) (6,3) + T (0,4) (1,4) (2,4) (3,4) (4,4) (5,4) (6,4) + I (0,5) (1,5) (2,5) (3,5) (4,5) (5,5) (6,5) + N (0,6) (1,6) (2,6) (3,6) (4,6) (5,6) (6,6) + G (0,7) (1,7) (2,7) (3,7) (4,7) (5,7) (6,7) + + Note that each row and column have room for one more element than the length of the string they represent. + To store the result for each comparison efficiently, we use a flat array, where the data looks like this: + + [ (0,0), (1,0), (2,0), (3,0), (4,0), (5,0), (6,0), (0,1), (1,1), (2,1), (3,1), etc.] + + Where the index to read from can be calculated from the key and the "width" of the grid. +-} + + +type Table + = Table Int (Array Int) + + +tableEmpty : ( Int, Int ) -> Table +tableEmpty ( sizeA, sizeB ) = + let + dimension = + sizeB + 1 + + arraySize = + (sizeA + 1) * dimension - 1 + in + Table dimension (Array.repeat arraySize -1) + + +tableFetch : ( Int, Int ) -> (Table -> ( Int, Int ) -> ( Table, Int )) -> Table -> ( Table, Int ) +tableFetch (( iKey, jKey ) as key) builder ((Table dimension distanceStore) as table) = + let + index = + iKey * dimension + jKey + in + case Array.get index distanceStore of + Just editDistance -> + if editDistance == -1 then + let + ( Table _ newStore, actualEditDistance ) = + builder table key + in + ( Table dimension (Array.set index actualEditDistance newStore), actualEditDistance ) + + else + ( table, editDistance ) + + Nothing -> + -- Would only occur if we are out of bounds on the array. This should never happen + ( table, -1 ) + + + +{- LICENSE + + The code was copied from https://github.com/dasch/levenshtein + and including the change in https://github.com/dasch/levenshtein/pull/10 + from https://github.com/KasMA1990/levenshtein + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +-} diff --git a/tests/NoUnknownCssClasses.elm b/tests/NoUnknownCssClasses.elm index 2e59959c..c5cd4e16 100644 --- a/tests/NoUnknownCssClasses.elm +++ b/tests/NoUnknownCssClasses.elm @@ -14,6 +14,7 @@ import Elm.Syntax.Expression as Expression exposing (Expression) import Elm.Syntax.ModuleName exposing (ModuleName) import Elm.Syntax.Node as Node exposing (Node(..)) import Elm.Syntax.Range as Range exposing (Range) +import Levenshtein import NoInconsistentAliases exposing (Config) import Parser exposing ((|.), (|=), Parser) import Review.ModuleNameLookupTable as ModuleNameLookupTable exposing (ModuleNameLookupTable) @@ -265,15 +266,70 @@ reportClasses cssFunctions context fnRange name firstArg restOfArguments = [] -reportError : Range -> String -> Rule.Error {} -reportError range name = +reportError : Set String -> Range -> String -> Rule.Error {} +reportError knownClasses range name = Rule.error { message = "Unknown CSS class \"" ++ name ++ "\"" - , details = [ "I could not find this class in CSS files. Have you made a typo? Here are similarly-named classes: TODO" ] + , details = + "I could not find this class in CSS files. Have you made a typo?" + :: (if Set.isEmpty knownClasses then + [] + + else + [ String.join "\n" + ("Here are similarly-named classes:" + :: List.map (\str -> " - " ++ str) (similarClasses name knownClasses) + ) + ] + ) } range +similarClasses : String -> Set String -> List String +similarClasses targetClass knownClasses = + Set.foldl + (\class ({ first, second } as untouched) -> + let + distance : Int + distance = + computeDistance class targetClass + in + if isSmallerDistance distance first then + { first = Just { class = class, distance = distance } + , second = first + } + + else if isSmallerDistance distance second then + { first = first + , second = Just { class = class, distance = distance } + } + + else + untouched + ) + { first = Nothing, second = Nothing } + knownClasses + |> (\{ first, second } -> List.filterMap (Maybe.map .class) [ first, second ]) + + +isSmallerDistance : Int -> Maybe { a | distance : Int } -> Bool +isSmallerDistance distance maybeElement = + case maybeElement of + Just element -> + distance < element.distance + + Nothing -> + True + + +computeDistance : String -> String -> Int +computeDistance a b = + Basics.min + (Levenshtein.distance a b) + (Levenshtein.distance b a) + + unknownClasses : Set String -> Range -> String -> List (Rule.Error {}) unknownClasses knownClasses range str = let @@ -290,6 +346,7 @@ unknownClasses knownClasses range str = else reportError + knownClasses { start = { row = row, column = column + offset } , end = { row = row, column = column + offset + String.length class } } diff --git a/tests/NoUnknownCssClassesTest.elm b/tests/NoUnknownCssClassesTest.elm index 3658ab49..5b8cde84 100644 --- a/tests/NoUnknownCssClassesTest.elm +++ b/tests/NoUnknownCssClassesTest.elm @@ -34,11 +34,14 @@ import Html.Attributes as Attr view model = Html.span [ Attr.class "unknown" ] [] """ - |> Review.Test.run (rule defaults) + |> Review.Test.run (defaults |> withHardcodedKnownClasses [ "known", "bar", "unknown2" ] |> rule) |> Review.Test.expectErrors [ Review.Test.error { message = "Unknown CSS class \"unknown\"" - , details = [ "I could not find this class in CSS files. Have you made a typo? Here are similarly-named classes: TODO" ] + , details = + [ "I could not find this class in CSS files. Have you made a typo?" + , "Here are similarly-named classes:\n - unknown2\n - known" + ] , under = "unknown" } ] @@ -66,7 +69,7 @@ view model = |> Review.Test.expectErrors [ Review.Test.error { message = "Unknown CSS class \"unknown\"" - , details = [ "I could not find this class in CSS files. Have you made a typo? Here are similarly-named classes: TODO" ] + , details = [ "I could not find this class in CSS files. Have you made a typo?" ] , under = "unknown" } ] @@ -83,7 +86,7 @@ view model = |> Review.Test.expectErrors [ Review.Test.error { message = "Unknown CSS class \"unknown\"" - , details = [ "I could not find this class in CSS files. Have you made a typo? Here are similarly-named classes: TODO" ] + , details = [ "I could not find this class in CSS files. Have you made a typo?" ] , under = "unknown" } ]