Add analysis for practice exercise for split-second-stopwatch

.github/workflows/elm_tests.yml

@@ -16,7 +16,7 @@ jobs:
       # Re-use node_modules between runs until package.json or package-lock.json changes.
       - name: Cache node_modules
         id: cache-node_modules
-        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        uses: actions/cache@7de21022a7b6824c106a9847befcbd8154b45b6a
         with:
           path: node_modules
           key: node_modules-${{ hashFiles('package.json', 'package-lock.json') }}
@@ -28,7 +28,7 @@ jobs:
       # review/elm.json changes. The Elm compiler saves downloaded Elm packages
       # to ~/.elm, and elm-tooling saves downloaded tool executables there.
       - name: Cache ~/.elm
-        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        uses: actions/cache@7de21022a7b6824c106a9847befcbd8154b45b6a
         with:
           path: ~/.elm
           key: elm-${{ hashFiles('elm-tooling.json', 'elm.json', 'review/elm.json') }}
@@ -83,7 +83,7 @@ jobs:
 
       - name: Cache node_modules
         id: cache-node_modules
-        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        uses: actions/cache@7de21022a7b6824c106a9847befcbd8154b45b6a
         with:
           path: node_modules
           key: node_modules-${{ hashFiles('package.json', 'package-lock.json') }}
@@ -92,7 +92,7 @@ jobs:
             node_modules-
 
       - name: Cache ~/.elm
-        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        uses: actions/cache@7de21022a7b6824c106a9847befcbd8154b45b6a
         with:
           path: ~/.elm
           key: elm-${{ hashFiles('elm-tooling.json', 'elm.json', 'review/elm.json') }}

src/Exercise/SplitSecondStopwatch.elm

@@ -0,0 +1,93 @@
+module Exercise.SplitSecondStopwatch exposing (forbidStopwatchExportAll, forbidStopwatchTypeAlias, ruleConfig)
+
+import Comment exposing (Comment, CommentType(..))
+import Dict
+import Elm.Syntax.Declaration exposing (Declaration(..))
+import Elm.Syntax.Exposing as Exposing exposing (TopLevelExpose(..))
+import Elm.Syntax.Module exposing (Module(..))
+import Elm.Syntax.Node as Node exposing (Node(..))
+import List.Extra
+import Review.Rule exposing (Error, Rule)
+import RuleConfig exposing (AnalyzerRule(..), RuleConfig)
+
+
+ruleConfig : RuleConfig
+ruleConfig =
+    { restrictToFiles = Just [ "src/SplitSecondStopwatch.elm" ]
+    , rules =
+        [ CustomRule forbidStopwatchTypeAlias
+            (Comment "elm.split-second-stopwatch.no_stopwatch_type_alias" Essential Dict.empty)
+        , CustomRule forbidStopwatchExportAll
+            (Comment "elm.split-second-stopwatch.no_stopwatch_export_all" Essential Dict.empty)
+        ]
+    }
+
+
+forbidStopwatchTypeAlias : Comment -> Rule
+forbidStopwatchTypeAlias comment =
+    Review.Rule.newModuleRuleSchema comment.path ()
+        |> Review.Rule.withSimpleDeclarationVisitor (hasStopwatchTypeAliasVisitor comment)
+        |> Review.Rule.fromModuleRuleSchema
+
+
+hasStopwatchTypeAliasVisitor : Comment -> Node Declaration -> List (Error {})
+hasStopwatchTypeAliasVisitor comment node =
+    case Node.value node of
+        AliasDeclaration { name } ->
+            if Node.value name == "Stopwatch" then
+                [ Comment.createError comment (Node.range name) ]
+
+            else
+                []
+
+        _ ->
+            []
+
+
+forbidStopwatchExportAll : Comment -> Rule
+forbidStopwatchExportAll comment =
+    Review.Rule.newModuleRuleSchema comment.path ()
+        |> Review.Rule.withSimpleModuleDefinitionVisitor (hasStopwatchExportAllVisitor comment)
+        |> Review.Rule.fromModuleRuleSchema
+
+
+hasStopwatchExportAllVisitor : Comment -> Node Module -> List (Error {})
+hasStopwatchExportAllVisitor comment node =
+    let
+        hasStopwatchExposed =
+            List.Extra.findMap
+                (\(Node range expose) ->
+                    case expose of
+                        TypeExpose { name } ->
+                            if name == "Stopwatch" then
+                                Just range
+
+                            else
+                                Nothing
+
+                        _ ->
+                            Nothing
+                )
+
+        checkExposing exposingList =
+            case Node.value exposingList of
+                Exposing.All _ ->
+                    []
+
+                Exposing.Explicit exposed ->
+                    case hasStopwatchExposed exposed of
+                        Just range ->
+                            [ Comment.createError comment range ]
+
+                        Nothing ->
+                            []
+    in
+    case Node.value node of
+        NormalModule { exposingList } ->
+            checkExposing exposingList
+
+        PortModule { exposingList } ->
+            checkExposing exposingList
+
+        EffectModule { exposingList } ->
+            checkExposing exposingList

src/ReviewConfig.elm

@@ -16,6 +16,7 @@ import Exercise.MariosMarvellousLasagna
 import Exercise.MazeMaker
 import Exercise.RolePlayingGame
 import Exercise.Sieve
+import Exercise.SplitSecondStopwatch
 import Exercise.Strain
 import Exercise.TicketPlease
 import Exercise.TisburyTreasureHunt
@@ -63,6 +64,7 @@ ruleConfigs =
     , Exercise.ListOps.ruleConfig
     , Exercise.ZebraPuzzle.ruleConfig
     , Exercise.Sieve.ruleConfig
+    , Exercise.SplitSecondStopwatch.ruleConfig
     ]
 
 

tests/Exercise/BettysBikeShopTest.elm

@@ -15,7 +15,7 @@ tests =
     describe "BettysBikeShopTest"
         [ exemplar
         , otherSolutions
-        , noFuctionSignature
+        , noFunctionSignature
         , noImportString
         ]
 
@@ -103,8 +103,8 @@ addPoundsSymbol =
         ]
 
 
-noFuctionSignature : Test
-noFuctionSignature =
+noFunctionSignature : Test
+noFunctionSignature =
     let
         comment =
             Comment "elm.bettys-bike-shop.use_signature" Essential Dict.empty