joshuaclayton/unused
1
1
Fork 0
mirror of https://github.com/joshuaclayton/unused.git synced 2024-09-11 04:45:28 +03:00
Code Issues Projects Releases Wiki Activity
789d91b5d9
unused/unused.cabal

126 lines
4.8 KiB
Plaintext
Raw Normal View History

Initial
2016-04-28 12:37:06 +03:00
name: unused
Bump version to 0.7.0.0
2017-01-12 16:38:00 +03:00
version: 0.7.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
Bump years
2017-04-25 00:29:05 +03:00
copyright: 2016-2017 Josh Clayton
Update Cabal category to CLI
2016-06-10 14:04:14 +03:00
category: CLI
Initial
2016-04-28 12:37:06 +03:00
build-type: Simple
-- extra-source-files:
cabal-version: >=1.10
Ensure data/config.yml is distributed with the package This resolves an issue where data/config.yml is unavailable with an error similar to: /private/tmp/stack66398/unused-0.6.1.0/src/Unused/ResultsClassifier/Config.hs:22:23: Exception when trying to run compile-time code: data/config.yml: openBinaryFile: does not exist (No such file or directory) Code: FE.embedFile "data/config.yml" In the splice: $(FE.embedFile "data/config.yml")
2016-08-30 13:31:09 +03:00
data-files: data/config.yml
Initial
2016-04-28 12:37:06 +03:00
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
Simplify parsing and caching of results Why? ==== Parsec is overkill when all that's really needed is splitting on semicolons and converting a string to a non-negative Int. One side-effect of this is to convert the caching mechanism from flat text to CSV, with cassava handling (de-)serialization. Additional ========== Introduce ReaderT to calculate sha once per cache interaction Previously, we were calculating the fingerprint (SHA) for match results potentially twice, once when reading from the cache, and a second time if no cache was found. This introduces a ReaderT to manage cache interaction with a single fingerprint calculation. This also abstracts what's being cached to only care about the fact that the data can be converted to/from csv.
2016-05-24 00:21:08 +03:00
, Unused.TermSearch.Types
Use regex in ag for simple words Why? ==== ag supports using regular expressions for searches; however, the -Q flag, which was previously always used, resulted in literal search results. By searching literal matches, it would potentially return too many results. For example, with a `me` method in a controller, it'd match words like `awesome` or `method`. This introduces a check where, if the token being searched is only composed of word characters (`[A-Za-z0-9_]`), it'll switch over to use regular expressions with ag and surround the token with non-word matches on either end. The goal here is to reduce false-positives in matches.
2016-05-14 15:04:35 +03:00
, Unused.TermSearch.Internal
Parse results into matches
2016-04-29 05:21:18 +03:00
, Unused.Parser
, Unused.Types
Display recent git SHAs per token This creates a new "list" output format that includes a certain number of git SHAs per token. This allows for perusal of the most recent changes for a given token to understand what changed.
2016-06-18 01:44:27 +03:00
, Unused.GitContext
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
Initial support of aliases based on wildcard matching Why? ==== Dynamic languages, and Rails in particular, support some fun method creation. One common pattern is, within RSpec, to create matchers dynamically based on predicate methods. Two common examples are: * `#admin?` gets converted to the matcher `#be_admin` * `#has_active_todos?` gets converted to the matcher `#have_active_todos` This especially comes into play when writing page objects with predicate methods. This change introduces the concept of aliases, a way to describe the before/after for these transformations. This introduces a direct swap with a wildcard value (%s), although this may change in the future to support other transformations for pluralization, camel-casing, etc. Externally, aliases are not grouped together by term; however, the underlying counts are summed together, increasing the total occurrences and likely pushing the individual method out of "high" likelihood into "medium" or "low" likelihood. Closes #19.
2016-05-29 14:49:22 +03:00
, Unused.Aliases
Support projections-style transformations to reduce false-positives Basic aliases (e.g. `admin?`/`be_admin`) can be represented easily with simple wildcards, but more complex transformations require a different mechanism. Instead of using `%s` to represent strings that can be replaced 1:1, this introduces a syntax inspired by https://github.com/tpope/vim-projectionist, as such: - name: Rails aliases: - from: "*Validator" to: "{snakecase}" This would find `AbsoluteUriValidator` and also match `absolute_uri`, which would be found if the validation was in use. This currently supports the `camelcase` and `snakecase` transformations, as well as no transformation. Closes #18
2016-07-16 14:45:21 +03:00
, Unused.Projection
, Unused.Projection.Transform
Move additional functionality out of Types and into separate modules
2016-05-07 12:56:46 +03:00
, Unused.ResponseFilter
Introduce internal yaml configuration of auto low likelihood match handling Why? ==== Handling low likelihood configuration was previously a huge pain, because the syntax in Haskell was fairly terse. This introduces a yaml format internally that ships with the app covering basic cases for Rails, Phoenix, and Haskell. I could imagine getting baselines in here for other languages and frameworks (especially ones I've used and am comfortable with) as a baseline. This also paves the way for searching for user-provided additions and loading those configurations in addition to what we have here.
2016-05-18 18:11:49 +03:00
, Unused.ResultsClassifier
, Unused.ResultsClassifier.Types
, Unused.ResultsClassifier.Config
Allow search result grouping Why? ==== Grouping results can be helpful to view information differently, e.g. to see highest-offending files or to remove grouping entirely. This introduces a flag to allow overriding the default group (two levels of directory)
2016-05-13 22:57:07 +03:00
, Unused.Grouping
, Unused.Grouping.Internal
, Unused.Grouping.Types
Move additional functionality out of Types and into separate modules
2016-05-07 12:56:46 +03:00
, Unused.LikelihoodCalculator
Read unchanged results from the cache At some point, this also needs to md5 the tags list itself and factor that in (since if the tagging algorithm changes, and new tokens get uncovered, it'd invalidate the cache)
2016-05-15 14:51:54 +03:00
, Unused.Cache
, Unused.Cache.DirectoryFingerprint
Use .gitignore to determine files for fingerprinting a project Why? ==== Because a .gitignore file captures a fair number of project-specific directories and files to ignore, we can use this list to reduce the number of files to look at when determining a fingerprint for a project. Because the fingerprint should be based on files we care about changing, the project-specific .gitignore is a great place to start. This drastically reduces fingerprint timing - for larger projects, or projects with a massive number of files (e.g. anything doing anything significant with NPM and a front-end framework), this will help make caching usable. For normal projects, this cuts fingerprint calculation to 10%-20% of what it was previously. Closes #38
2016-05-26 22:25:43 +03:00
, Unused.Cache.FindArgsFromIgnoredPaths
Attempt to find and load tags automatically Why? ==== Frequency of a tool's usage is determined by how easy it is to use the tool. By having to pipe in ctags files all the time, and not provide any guidance to the user, this program is merely a toy, since it's hard to get right, and harder to explore. This modifies the default behavior to look for a ctags file in a few common locations, and lets the user choose a custom location if she so chooses. Resolves #35
2016-05-21 17:20:25 +03:00
, Unused.TagsSource
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
Display recent git SHAs per token This creates a new "list" output format that includes a certain number of git SHAs per token. This allows for perusal of the most recent changes for a given token to understand what changed.
2016-06-18 01:44:27 +03:00
, Unused.CLI.GitContext
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.Util
Extract views to a Views module Why? ==== View logic was scattered all over the place; this introduces a views module to encapsulate any corresponding view work into one spot.
2016-05-27 12:52:56 +03:00
, Unused.CLI.Views
Extract error headers
2016-06-24 05:44:23 +03:00
, Unused.CLI.Views.Error
Extract views to a Views module Why? ==== View logic was scattered all over the place; this introduces a views module to encapsulate any corresponding view work into one spot.
2016-05-27 12:52:56 +03:00
, Unused.CLI.Views.NoResultsFound
, Unused.CLI.Views.AnalysisHeader
Display recent git SHAs per token This creates a new "list" output format that includes a certain number of git SHAs per token. This allows for perusal of the most recent changes for a given token to understand what changed.
2016-06-18 01:44:27 +03:00
, Unused.CLI.Views.GitSHAsHeader
Extract views to a Views module Why? ==== View logic was scattered all over the place; this introduces a views module to encapsulate any corresponding view work into one spot.
2016-05-27 12:52:56 +03:00
, Unused.CLI.Views.MissingTagsFileError
Allow developer-authored configurations This enables per-user and per-project configs, located in: * ~/.unused.yml * APP_ROOT/.unused.yml Configurations stack upon each other, not replace; unused provides a very base config, but additional configurations can be defined. Per-user configs are best used to suit common types of projects at a generic level. For example, a developer commonly working in Rails applications might have a config at ~/.unused.yml for patterns like Policy objects from Pundit, ActiveModel::Serializers, etc. Per-project config would be less-generic patterns, ones where re-use isn't likely or applicable. See unused's global config: https://github.com/joshuaclayton/unused/blob/master/data/config.yml The structure is as follows: - name: Rails autoLowLikelihood: - name: Pundit pathStartsWith: app/policies pathEndsWith: .rb termEndsWith: Policy classOrModule: true - name: Pundit Helpers pathStartsWith: app/policies allowedTerms: - Scope - index? - new? - create? - show? - edit? - destroy? - resolve - name: Other Language autoLowLikelihood: - name: Thing pathEndsWith: .ex classOrModule: true Name each item, and include an autoLowLikelihood key with multiple named matchers. Each matcher can look for various formatting aspects, including termStartsWith, termEndsWith, pathStartsWith, pathEndsWith, classOrModule, and allowedTerms.
2016-06-05 14:40:47 +03:00
, Unused.CLI.Views.InvalidConfigError
Support digesting on Linux with md5sum This introduces behavior searching for an available program to calculate digests across directories. OS X ships with md5, but on *nix-based systems, it's md5sum. The output is largely the same, apart from the final digest calculation, which includes a "file path": da52a1a5d5a3c9672371746e4d32708a - This strips the trailing whitespace and dash: da52a1a5d5a3c9672371746e4d32708a Closes #49
2016-06-22 13:14:00 +03:00
, Unused.CLI.Views.FingerprintError
Extract views to a Views module Why? ==== View logic was scattered all over the place; this introduces a views module to encapsulate any corresponding view work into one spot.
2016-05-27 12:52:56 +03:00
, Unused.CLI.Views.SearchResult
, Unused.CLI.Views.SearchResult.ColumnFormatter
Display recent git SHAs per token This creates a new "list" output format that includes a certain number of git SHAs per token. This allows for perusal of the most recent changes for a given token to understand what changed.
2016-06-18 01:44:27 +03:00
, Unused.CLI.Views.SearchResult.Internal
, Unused.CLI.Views.SearchResult.ListResult
, Unused.CLI.Views.SearchResult.TableResult
, Unused.CLI.Views.SearchResult.Types
Consolidate progress indicator handling
2016-05-13 15:03:26 +03:00
, Unused.CLI.ProgressIndicator
, Unused.CLI.ProgressIndicator.Internal
, Unused.CLI.ProgressIndicator.Types
Conditionally import Data.Monoid.<> depending on version of base Fixes #64
2016-08-19 11:57:32 +03:00
, Common
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
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
Read unchanged results from the cache At some point, this also needs to md5 the tags list itself and factor that in (since if the tagging algorithm changes, and new tokens get uncovered, it'd invalidate the cache)
2016-05-15 14:51:54 +03:00
, directory
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
Parallelize search Why? ==== Searching hundreds or thousands of tokens with ag can be slow; this introduces parallel processing of search so results are returned more quickly.
2016-05-13 21:46:23 +03:00
, parallel-io
Introduce internal yaml configuration of auto low likelihood match handling Why? ==== Handling low likelihood configuration was previously a huge pain, because the syntax in Haskell was fairly terse. This introduces a yaml format internally that ships with the app covering basic cases for Rails, Phoenix, and Haskell. I could imagine getting baselines in here for other languages and frameworks (especially ones I've used and am comfortable with) as a baseline. This also paves the way for searching for user-provided additions and loading those configurations in addition to what we have here.
2016-05-18 18:11:49 +03:00
, yaml
, bytestring
, text
, unordered-containers
Update version dependencies for various packages * Update the inflections package * Better lock down megaparsec and cassava
2017-01-12 14:34:27 +03:00
, cassava >= 0.4.5.0 && < 0.5
Simplify parsing and caching of results Why? ==== Parsec is overkill when all that's really needed is splitting on semicolons and converting a string to a non-negative Int. One side-effect of this is to convert the caching mechanism from flat text to CSV, with cassava handling (de-)serialization. Additional ========== Introduce ReaderT to calculate sha once per cache interaction Previously, we were calculating the fingerprint (SHA) for match results potentially twice, once when reading from the cache, and a second time if no cache was found. This introduces a ReaderT to manage cache interaction with a single fingerprint calculation. This also abstracts what's being cached to only care about the fact that the data can be converted to/from csv.
2016-05-24 00:21:08 +03:00
, vector
, mtl
, transformers
Update version dependencies for various packages * Update the inflections package * Better lock down megaparsec and cassava
2017-01-12 14:34:27 +03:00
, megaparsec >= 5.1.2 && < 6
, inflections >= 0.3.0.0 && < 0.4
Replace Cabal-managed config loading with FileEmbed This uses the file-embed package and TemplateHaskell to load custom configuration during compilation instead of loading it at runtime.
2016-08-19 00:59:12 +03:00
, file-embed
Remove -O flag entirely for Hackage upload
2016-06-24 15:29:32 +03:00
ghc-options: -Wall
Initial
2016-04-28 12:37:06 +03:00
default-language: Haskell2010
Configure default extensions (namely, OverloadedStrings)
2017-01-24 02:23:00 +03:00
default-extensions: OverloadedStrings
Initial
2016-04-28 12:37:06 +03:00
executable unused
hs-source-dirs: app
main-is: Main.hs
Remove -O flag entirely for Hackage upload
2016-06-24 15:29:32 +03:00
ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall
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
Allow developer-authored configurations This enables per-user and per-project configs, located in: * ~/.unused.yml * APP_ROOT/.unused.yml Configurations stack upon each other, not replace; unused provides a very base config, but additional configurations can be defined. Per-user configs are best used to suit common types of projects at a generic level. For example, a developer commonly working in Rails applications might have a config at ~/.unused.yml for patterns like Policy objects from Pundit, ActiveModel::Serializers, etc. Per-project config would be less-generic patterns, ones where re-use isn't likely or applicable. See unused's global config: https://github.com/joshuaclayton/unused/blob/master/data/config.yml The structure is as follows: - name: Rails autoLowLikelihood: - name: Pundit pathStartsWith: app/policies pathEndsWith: .rb termEndsWith: Policy classOrModule: true - name: Pundit Helpers pathStartsWith: app/policies allowedTerms: - Scope - index? - new? - create? - show? - edit? - destroy? - resolve - name: Other Language autoLowLikelihood: - name: Thing pathEndsWith: .ex classOrModule: true Name each item, and include an autoLowLikelihood key with multiple named matchers. Each matcher can look for various formatting aspects, including termStartsWith, termEndsWith, pathStartsWith, pathEndsWith, classOrModule, and allowedTerms.
2016-06-05 14:40:47 +03:00
, mtl
, transformers
Roll up App into a monad transformer stack This introduces a monad transformer stack to cover our reader (options from the CLI) and except (for handling failure cases, initially missing tags or invalid config). This ensures errors are bubbled up appropriately (and halt program execution) and the Options are available in the correct locations within the app. This also separates options parsing (which remains in app/Main.) from translating those options into the correctly executed runner and generated output.
2016-06-11 14:15:22 +03:00
other-modules: App
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
Support projections-style transformations to reduce false-positives Basic aliases (e.g. `admin?`/`be_admin`) can be represented easily with simple wildcards, but more complex transformations require a different mechanism. Instead of using `%s` to represent strings that can be replaced 1:1, this introduces a syntax inspired by https://github.com/tpope/vim-projectionist, as such: - name: Rails aliases: - from: "*Validator" to: "{snakecase}" This would find `AbsoluteUriValidator` and also match `absolute_uri`, which would be found if the validation was in use. This currently supports the `camelcase` and `snakecase` transformations, as well as no transformation. Closes #18
2016-07-16 14:45:21 +03:00
, text
Add Hspec and tests around parsing
2016-05-08 13:29:55 +03:00
other-modules: Unused.ParserSpec
, 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
Allow search result grouping Why? ==== Grouping results can be helpful to view information differently, e.g. to see highest-offending files or to remove grouping entirely. This introduces a flag to allow overriding the default group (two levels of directory)
2016-05-13 22:57:07 +03:00
, Unused.Grouping.InternalSpec
Use regex in ag for simple words Why? ==== ag supports using regular expressions for searches; however, the -Q flag, which was previously always used, resulted in literal search results. By searching literal matches, it would potentially return too many results. For example, with a `me` method in a controller, it'd match words like `awesome` or `method`. This introduces a check where, if the token being searched is only composed of word characters (`[A-Za-z0-9_]`), it'll switch over to use regular expressions with ag and surround the token with non-word matches on either end. The goal here is to reduce false-positives in matches.
2016-05-14 15:04:35 +03:00
, Unused.TermSearch.InternalSpec
Test Util.groupBy
2016-05-15 12:53:29 +03:00
, Unused.UtilSpec
Add missing spec name to unused.cabal
2016-06-05 14:42:18 +03:00
, Unused.Cache.FindArgsFromIgnoredPathsSpec
Ensure results work when no config can be loaded Why? ==== If no config can be loaded correctly, unused should still function correctly, albeit with likely more false positives.
2016-06-05 15:09:02 +03:00
, Unused.AliasesSpec
Remove final -Werror setting
2016-06-24 15:31:14 +03:00
ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall
Initial
2016-04-28 12:37:06 +03:00
default-language: Haskell2010
Configure default extensions (namely, OverloadedStrings)
2017-01-24 02:23:00 +03:00
default-extensions: OverloadedStrings
Initial
2016-04-28 12:37:06 +03:00
source-repository head
type: git
location: https://github.com/joshuaclayton/unused
Reference in New Issue Copy Permalink