Merge pull request #57 from serokell/martoon/#55-proper-gitlab-support

[#55] GitLab support

Author: Martoon-00

.stylish-haskell.yaml

@@ -0,0 +1,62 @@
+# SPDX-FileCopyrightText: 2021 Serokell <https://serokell.io>
+#
+# SPDX-License-Identifier: Unlicense
+
+steps:
+  - simple_align:
+      cases: false
+      top_level_patterns: false
+      records: false
+  - imports:
+      align: none
+      list_align: after_alias
+      pad_module_names: false
+      long_list_align: new_line
+      empty_list_align: inherit
+      list_padding: 2
+      separate_lists: true
+      space_surround: false
+  - trailing_whitespace: {}
+columns: 100
+newline: native
+language_extensions:
+  - BangPatterns
+  - BlockArguments
+  - ConstraintKinds
+  - DataKinds
+  - DefaultSignatures
+  - DeriveAnyClass
+  - DeriveDataTypeable
+  - DeriveGeneric
+  - DerivingStrategies
+  - DerivingVia
+  - EmptyCase
+  - ExistentialQuantification
+  - ExplicitNamespaces
+  - FlexibleContexts
+  - FlexibleInstances
+  - FunctionalDependencies
+  - GADTs
+  - GeneralizedNewtypeDeriving
+  - LambdaCase
+  - MultiParamTypeClasses
+  - MultiWayIf
+  - NamedFieldPuns
+  - NoImplicitPrelude
+  - NumericUnderscores
+  - OverloadedLabels
+  - OverloadedStrings
+  - PatternSynonyms
+  - QuantifiedConstraints
+  - RebindableSyntax
+  - RecordWildCards
+  - RecursiveDo
+  - ScopedTypeVariables
+  - StandaloneDeriving
+  - TemplateHaskell
+  - TemplateHaskellQuotes
+  - TupleSections
+  - TypeApplications
+  - TypeFamilies
+  - TypeOperators
+  - ViewPatterns

CHANGES.md

@@ -6,7 +6,10 @@
 
 Unreleased
 ==========
-
+* [#57](https://github.com/serokell/xrefcheck/pull/57)
+  + Added `flavor` field to config.
+    Also see [config sample](tests/configs/github-config.yaml).
+  + Config generated with `dump-config` CLI command now depends on the provided repository type.
 
 0.1.3
 =======

README.md

@@ -153,7 +153,7 @@ xrefcheck --help
 Configuration template (with all options explained) can be dumped with:
 
 ```sh
-xrefcheck dump-config
+xrefcheck dump-config -t GitHub
 ```
 
 Currently supported options include:

exec/Main.hs

@@ -13,15 +13,16 @@ import System.Directory (doesFileExist)
 
 import Xrefcheck.CLI
 import Xrefcheck.Config
+import Xrefcheck.Core
 import Xrefcheck.Progress
 import Xrefcheck.Scan
 import Xrefcheck.Scanners
 import Xrefcheck.System
 import Xrefcheck.Verify
 
-formats :: FormatsSupport
-formats = specificFormatsSupport
-    [ markdownSupport
+formats :: ScannersConfig -> FormatsSupport
+formats ScannersConfig{..} = specificFormatsSupport
+    [ markdownSupport scMarkdown
     ]
 
 defaultAction :: Options -> IO ()
@@ -33,8 +34,10 @@ defaultAction Options{..} = do
         mConfigPath <- findFirstExistingFile defaultConfigPaths
         case mConfigPath of
           Nothing -> do
-            hPutStrLn @Text stderr "Configuration file not found, using default config\n"
-            pure defConfig
+            hPutStrLn @Text stderr
+              "Configuration file not found, using default config \
+              \for GitHub repositories\n"
+            pure $ defConfig GitHub
           Just configPath ->
             readConfig configPath
       Just configPath -> do
@@ -45,7 +48,7 @@ defaultAction Options{..} = do
 
     repoInfo <- allowRewrite showProgressBar $ \rw -> do
         let fullConfig = addTraversalOptions (cTraversal config) oTraversalOptions
-        gatherRepoInfo rw formats fullConfig root
+        gatherRepoInfo rw (formats $ cScanners config) fullConfig root
 
     when oVerbose $
         fmtLn $ "=== Repository data ===\n\n" <> indentF 2 (build repoInfo)
@@ -79,5 +82,5 @@ main = withUtf8 $ do
     case command of
       DefaultCommand options ->
         defaultAction options
-      DumpConfig path ->
-        BS.writeFile path defConfigText
+      DumpConfig repoType path ->
+        BS.writeFile path (defConfigText repoType)

package.yaml

@@ -83,6 +83,7 @@ dependencies:
   - optparse-applicative
   - regex-tdfa
   - req
+  - regex-tdfa
   - roman-numerals
   - template-haskell
   - text

src-files/def-config.yaml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2019 Serokell <https://serokell.io>
+# SPDX-FileCopyrightText: 2019-2021 Serokell <https://serokell.io>
 #
 # SPDX-License-Identifier: Unlicense
 
@@ -26,33 +26,24 @@ verification:
 
   # Prefixes of files, references in which should not be analyzed.
   notScanned:
-    # GitHub-specific files
-    - .github/pull_request_template.md
-    - .github/issue_template.md
-    - .github/PULL_REQUEST_TEMPLATE
-    - .github/ISSUE_TEMPLATE
-
-    # GitLab-specific files
-    - .gitlab/merge_request_templates/
-    - .gitlab/issue_templates/
+    - :PLACEHOLDER:notScanned:
 
   # Glob patterns describing the files which do not physically exist in the
   # repository but should be treated as existing nevertheless.
   virtualFiles:
-    # GitHub pages
-    - ../../../issues
-    - ../../../issues/*
-    - ../../../pulls
-    - ../../../pulls/*
-
-    # GitLab pages
-    - ../../issues
-    - ../../issues/*
-    - ../../merge_requests
-    - ../../merge_requests/*
+    - :PLACEHOLDER:virtualFiles:
 
   # POSIX extended regular expressions that match external references
   # that have to be ignored (not verified).
   # It is an optional parameter, so it can be omitted.
   ignoreRefs:
     []
+
+# Parameters of scanners for various file types.
+scanners:
+
+  markdown:
+    # Flavor of markdown, e.g. GitHub-flavor.
+    #
+    # This affects which anchors are generated for headers.
+    flavor: :PLACEHOLDER:flavor:

src/Xrefcheck/CLI.hs

@@ -17,16 +17,18 @@ module Xrefcheck.CLI
     , getCommand
     ) where
 
+import qualified Data.Char as C
 import qualified Data.List as L
+import qualified Data.Text as T
 import Data.Version (showVersion)
-import Options.Applicative (Parser, ReadM, command, eitherReader, execParser, flag', footerDoc, fullDesc,
-                            help, helper, hsubparser, info, infoOption, long, metavar, option, progDesc,
-                            short, strOption, switch, value)
+import Options.Applicative
+  (Parser, ReadM, command, eitherReader, execParser, flag', footerDoc, fullDesc, help, helper,
+  hsubparser, info, infoOption, long, metavar, option, progDesc, short, strOption, switch, value)
 import Options.Applicative.Help.Pretty (Doc, displayS, fill, fillSep, indent, renderPretty, text)
 
 import Paths_xrefcheck (version)
-import Xrefcheck.Config
 import Xrefcheck.Core
+import Xrefcheck.Scan
 
 modeReadM :: ReadM VerifyMode
 modeReadM = eitherReader $ \s ->
@@ -45,7 +47,7 @@ modeReadM = eitherReader $ \s ->
 
 data Command
   = DefaultCommand Options
-  | DumpConfig FilePath
+  | DumpConfig Flavor FilePath
 
 data Options = Options
     { oConfigPath       :: Maybe FilePath
@@ -71,6 +73,24 @@ addTraversalOptions TraversalConfig{..} (TraversalOptions ignored) =
 defaultConfigPaths :: [FilePath]
 defaultConfigPaths = ["./xrefcheck.yaml", "./.xrefcheck.yaml"]
 
+-- | Strictly speaking, what config we will dump depends on the repository type:
+-- this affects Markdown flavor, things excluded by default, e.t.c.
+--
+-- But at the moment there is one-to-one correspondence between repository types
+-- and flavors, so we write a type alias here.
+type RepoType = Flavor
+
+repoTypeReadM :: ReadM RepoType
+repoTypeReadM = eitherReader $ \name ->
+  maybeToRight (failureText name) $ L.lookup (map C.toLower name) allRepoTypesNamed
+  where
+    allRepoTypesNamed =
+      allRepoTypes <&> \ty -> (toString $ T.toLower (show ty), ty)
+    failureText name =
+      "Unknown repository type: " <> show name <> "\n\
+      \Expected one of: " <> mconcat (intersperse ", " $ map show allRepoTypes)
+    allRepoTypes = allFlavors
+
 optionsParser :: Parser Options
 optionsParser = do
     oConfigPath <- optional . strOption $
@@ -122,13 +142,23 @@ traversalOptionsParser = do
         help "Files and folders which we pretend do not exist."
     return TraversalOptions{..}
 
-dumpConfigOptions :: Parser FilePath
+dumpConfigOptions :: Parser Command
 dumpConfigOptions = hsubparser $
   command "dump-config" $
     info parser $
     progDesc "Dump default configuration into a file."
   where
-    parser = strOption $
+    parser = DumpConfig <$> repoTypeOption <*> outputOption
+
+    repoTypeOption =
+      option repoTypeReadM $
+      short 't' <>
+      long "type" <>
+      metavar "REPOSITORY TYPE" <>
+      help "Git repository type."
+
+    outputOption =
+      strOption $
       short 'o' <>
       long "output" <>
       metavar "FILEPATH" <>
@@ -138,7 +168,7 @@ dumpConfigOptions = hsubparser $
 totalParser :: Parser Command
 totalParser = asum
   [ DefaultCommand <$> optionsParser
-  , DumpConfig <$> dumpConfigOptions
+  , dumpConfigOptions
   ]
 
 versionOption :: Parser (a -> a)