Enable additional elm-review-documentation rule

This commit is contained in:
Jeroen Engels 2021-10-02 10:10:56 +02:00
parent 34798e3f49
commit 8c8e708403
4 changed files with 16 additions and 3 deletions

File diff suppressed because one or more lines are too long

View File

@ -11,6 +11,9 @@ when inside the directory containing this file.
-}
import Docs.NoMissing exposing (exposedModules, onlyExposed)
import Docs.ReviewAtDocs
import Docs.ReviewLinksAndSections
import Docs.UpToDateReadmeLinks
import NoDebug.Log
import NoDebug.TodoOrToString
@ -33,6 +36,11 @@ import Review.Rule as Rule exposing (Rule)
config : List Rule
config =
[ Docs.UpToDateReadmeLinks.rule
, Docs.ReviewLinksAndSections.rule
|> Rule.ignoreErrorsForDirectories [ "tests/" ]
, Docs.ReviewAtDocs.rule
|> Rule.ignoreErrorsForDirectories [ "tests/" ]
, Docs.NoMissing.rule { document = onlyExposed, from = exposedModules }
, NoDebug.Log.rule
, NoDebug.TodoOrToString.rule
|> Rule.ignoreErrorsForDirectories [ "tests/" ]

View File

@ -22,7 +22,7 @@ does not look at the project's dependencies.
@docs name, elmJson, modules
# Create
# Creation
@docs create

View File

@ -4,7 +4,9 @@ module Review.Test.FailureMessage exposing
, underMismatch, expectedMoreErrors, tooManyErrors, locationNotFound, underMayNotBeEmpty, locationIsAmbiguousInSourceCode
, needToUsedExpectErrorsForModules, missingSources, duplicateModuleName, unknownModulesInExpectedErrors
, missingFixes, unexpectedFixes, fixedCodeMismatch, unchangedSourceAfterFix, invalidSourceAfterFix, hasCollisionsInFixRanges
, didNotExpectGlobalErrors, expectedMoreGlobalErrors, fixedCodeWhitespaceMismatch, messageMismatchForConfigurationError, messageMismatchForGlobalError, missingConfigurationError, tooManyGlobalErrors, unexpectedConfigurationError, unexpectedConfigurationErrorDetails, unexpectedGlobalErrorDetails
, didNotExpectGlobalErrors, expectedMoreGlobalErrors, fixedCodeWhitespaceMismatch, messageMismatchForConfigurationError
, messageMismatchForGlobalError, missingConfigurationError, tooManyGlobalErrors
, unexpectedConfigurationError, unexpectedConfigurationErrorDetails, unexpectedGlobalErrorDetails
)
{-| Failure messages for the `Review.Test` module.
@ -17,6 +19,9 @@ module Review.Test.FailureMessage exposing
@docs underMismatch, expectedMoreErrors, tooManyErrors, locationNotFound, underMayNotBeEmpty, locationIsAmbiguousInSourceCode
@docs needToUsedExpectErrorsForModules, missingSources, duplicateModuleName, unknownModulesInExpectedErrors
@docs missingFixes, unexpectedFixes, fixedCodeMismatch, unchangedSourceAfterFix, invalidSourceAfterFix, hasCollisionsInFixRanges
@docs didNotExpectGlobalErrors, expectedMoreGlobalErrors, fixedCodeWhitespaceMismatch, messageMismatchForConfigurationError
@docs messageMismatchForGlobalError, missingConfigurationError, tooManyGlobalErrors
@docs unexpectedConfigurationError, unexpectedConfigurationErrorDetails, unexpectedGlobalErrorDetails
-}