unused/unused.cabal

name:                unused
version:             0.1.0.0
synopsis:            A command line tool to identify unused code.
description:         Please see README.md
homepage:            https://github.com/joshuaclayton/unused#readme
license:             MIT
license-file:        LICENSE
author:              Josh Clayton
maintainer:          sayhi@joshuaclayton.me
copyright:           2016 Josh Clayton
category:            Development
build-type:          Simple
-- extra-source-files:
cabal-version:       >=1.10

library
  hs-source-dirs:      src
  exposed-modules:     Unused.TermSearch
                     , Unused.Parser
                     , Unused.Parser.Internal
                     , Unused.Types
                     , Unused.Util
                     , Unused.Regex
                     , Unused.ResponseFilter
                     , Unused.DirectoryGrouping
                     , Unused.LikelihoodCalculator
                     , Unused.CLI
                     , Unused.CLI.Search
                     , Unused.CLI.SearchError
                     , Unused.CLI.SearchResult
                     , Unused.CLI.SearchResult.ColumnFormatter
                     , Unused.CLI.SearchWithProgress
                     , Unused.CLI.SearchWithoutProgress
                     , Unused.CLI.Util
                     , Unused.CLI.Spinner
                     , Unused.CLI.ProgressBar
  build-depends:       base >= 4.7 && < 5
                     , process
                     , parsec
                     , containers
                     , filepath
                     , regex-tdfa
                     , terminal-progress-bar
                     , ansi-terminal
                     , unix
  ghc-options:         -Wall -Werror -O2
  default-language:    Haskell2010

executable unused
  hs-source-dirs:      app
  main-is:             Main.hs
  ghc-options:         -threaded -rtsopts -with-rtsopts=-N -Wall -Werror -O2
  build-depends:       base
                     , unused
                     , optparse-applicative
  default-language:    Haskell2010

test-suite unused-test
  type:                exitcode-stdio-1.0
  hs-source-dirs:      test
  main-is:             Spec.hs
  build-depends:       base
                     , unused
                     , hspec
                     , containers
  other-modules:       Unused.ParserSpec
                     , Unused.Parser.InternalSpec
                     , Unused.ResponseFilterSpec
                     , Unused.TypesSpec
                     , Unused.LikelihoodCalculatorSpec
  ghc-options:         -threaded -rtsopts -with-rtsopts=-N -Wall -Werror
  default-language:    Haskell2010

source-repository head
  type:     git
  location: https://github.com/joshuaclayton/unused
Initial 2016-04-28 12:37:06 +03:00			`name: unused`
			`version: 0.1.0.0`
Update cabal file to reflect proper information 2016-05-11 12:28:01 +03:00			`synopsis: A command line tool to identify unused code.`
Initial 2016-04-28 12:37:06 +03:00			`description: Please see README.md`
			`homepage: https://github.com/joshuaclayton/unused#readme`
			`license: MIT`
			`license-file: LICENSE`
			`author: Josh Clayton`
			`maintainer: sayhi@joshuaclayton.me`
			`copyright: 2016 Josh Clayton`
Update cabal file to reflect proper information 2016-05-11 12:28:01 +03:00			`category: Development`
Initial 2016-04-28 12:37:06 +03:00			`build-type: Simple`
			`-- extra-source-files:`
			`cabal-version: >=1.10`

			`library`
			`hs-source-dirs: src`
Search for terms from a tags file This returns a list of each match, files, and counts based on the current directory. 2016-04-29 00:42:58 +03:00			`exposed-modules: Unused.TermSearch`
Parse results into matches 2016-04-29 05:21:18 +03:00			`, Unused.Parser`
Extract internal parsing handling to separate module Why? ==== Parsing lines of results was somewhat unreliable, and terms with odd characters were causing problems. This: * extracts parsing into an Unused.Parser.Internal module for ease of testing * fixes cases where certain tokens weren't matching 2016-05-12 20:47:32 +03:00			`, Unused.Parser.Internal`
Parse results into matches 2016-04-29 05:21:18 +03:00			`, Unused.Types`
Filter results to matches with one file and one occurrence 2016-04-29 16:58:03 +03:00			`, Unused.Util`
Initial pass at RemovalLikelihood calculator 2016-05-03 13:41:18 +03:00			`, Unused.Regex`
Move additional functionality out of Types and into separate modules 2016-05-07 12:56:46 +03:00			`, Unused.ResponseFilter`
			`, Unused.DirectoryGrouping`
			`, Unused.LikelihoodCalculator`
Add optparse-applicative for flags This introduces the optparse-applicative library for parsing out any subcommands/flags/args. Currently only supports --no-progress (-P). 2016-05-05 05:55:09 +03:00			`, Unused.CLI`
			`, Unused.CLI.Search`
			`, Unused.CLI.SearchError`
			`, Unused.CLI.SearchResult`
Better manage column formatting Why? ==== Formatting each column requires context on the column, as well as information on alignment. This extracts the column formatting logic to a specific formatter. ColumnFormatter is coupled to the order of columns/data displayed to the user. 2016-05-09 16:31:06 +03:00			`, Unused.CLI.SearchResult.ColumnFormatter`
Add optparse-applicative for flags This introduces the optparse-applicative library for parsing out any subcommands/flags/args. Currently only supports --no-progress (-P). 2016-05-05 05:55:09 +03:00			`, Unused.CLI.SearchWithProgress`
			`, Unused.CLI.SearchWithoutProgress`
			`, Unused.CLI.Util`
Introduce a Spinner when no progress bar is displayed Why? ==== With a spinner in place, there's visual indication that something's happening. 2016-05-06 23:11:09 +03:00			`, Unused.CLI.Spinner`
Extract ProgressBar to have a similar interface to Spinner 2016-05-07 00:22:27 +03:00			`, Unused.CLI.ProgressBar`
Initial 2016-04-28 12:37:06 +03:00			`build-depends: base >= 4.7 && < 5`
Search for terms from a tags file This returns a list of each match, files, and counts based on the current directory. 2016-04-29 00:42:58 +03:00			`, process`
Parse results into matches 2016-04-29 05:21:18 +03:00			`, parsec`
Reorganize data structure to handle parsing errors This extracts the previous data structure from groupBy into an actual Data.Map.Strict String [TermMatch], as well as another type (ParseResponse) capturing invalid and valid responses. 2016-04-29 12:28:03 +03:00			`, containers`
Improve output by grouping by directory structure 2016-04-30 23:05:12 +03:00			`, filepath`
Initial pass at RemovalLikelihood calculator 2016-05-03 13:41:18 +03:00			`, regex-tdfa`
Add optparse-applicative for flags This introduces the optparse-applicative library for parsing out any subcommands/flags/args. Currently only supports --no-progress (-P). 2016-05-05 05:55:09 +03:00			`, terminal-progress-bar`
			`, ansi-terminal`
Hook into interrupt to trigger other behavior Why? ==== Unused hides the cursor and potentially does other things to the window that may leave it in an odd state. This introduces a hook to run any state cleanup, including re-enabling the cursor, when a user sends a SIGINT to the program. 2016-05-10 00:45:42 +03:00			`, unix`
Warn on everything, error on anything 2016-05-11 12:32:42 +03:00			`ghc-options: -Wall -Werror -O2`
Initial 2016-04-28 12:37:06 +03:00			`default-language: Haskell2010`

			`executable unused`
			`hs-source-dirs: app`
			`main-is: Main.hs`
Run optimizations 2016-05-09 15:29:09 +03:00			`ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall -Werror -O2`
Initial 2016-04-28 12:37:06 +03:00			`build-depends: base`
			`, unused`
Add optparse-applicative for flags This introduces the optparse-applicative library for parsing out any subcommands/flags/args. Currently only supports --no-progress (-P). 2016-05-05 05:55:09 +03:00			`, optparse-applicative`
Initial 2016-04-28 12:37:06 +03:00			`default-language: Haskell2010`

			`test-suite unused-test`
			`type: exitcode-stdio-1.0`
			`hs-source-dirs: test`
			`main-is: Spec.hs`
			`build-depends: base`
			`, unused`
Add Hspec and tests around parsing 2016-05-08 13:29:55 +03:00			`, hspec`
			`, containers`
			`other-modules: Unused.ParserSpec`
Extract internal parsing handling to separate module Why? ==== Parsing lines of results was somewhat unreliable, and terms with odd characters were causing problems. This: * extracts parsing into an Unused.Parser.Internal module for ease of testing * fixes cases where certain tokens weren't matching 2016-05-12 20:47:32 +03:00			`, Unused.Parser.InternalSpec`
Add Hspec and tests around parsing 2016-05-08 13:29:55 +03:00			`, Unused.ResponseFilterSpec`
			`, Unused.TypesSpec`
Improve likelihood calculation and include reasons for evaluation Why? ==== A simple calculation ("yes, this should be removed" or "no, this is probably fine") is frankly not enough information for someone evaluating their codebase to understand why we made the decision. This introduces a removal reason, so a user understands why we ranked it the way we did, and adds additional logic around a method and its tests to determine if a method exists and is only being used in the tests (if so, it should probably be deleted). This is done with an Occurrances record, which is created for total files, test code, and non-test code. The test code logic is somewhat naive but works in most cases. It doesn't ensure a particular directory, in the case that tests live alongside source code (e.g. Go), and captures RSpec cases as well. 2016-05-08 15:16:32 +03:00			`, Unused.LikelihoodCalculatorSpec`
Error on warnings 2016-05-07 13:23:38 +03:00			`ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall -Werror`
Initial 2016-04-28 12:37:06 +03:00			`default-language: Haskell2010`

			`source-repository head`
			`type: git`
			`location: https://github.com/joshuaclayton/unused`