Skip to content
Parsing, analyzing, and comparing source code across many languages
Haskell Other
  1. Haskell 99.0%
  2. Other 1.0%
Branch: master
Clone or download
Latest commit f590d0d Dec 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.licenses/semantic/cabal Merge branch 'master' into sinister-orphan-machinations Sep 24, 2019
app Move semanticd into it's own directory, update builds May 22, 2018
bench Enable hard-mode warnings project-wide. Oct 30, 2019
bin Keep a bin directory around for deployments Feb 2, 2016
docs Add --language to examples Dec 6, 2019
notices Remove docker section from third-party notice Feb 21, 2019
proto First pass at switching from proto3 to proto-lens Sep 27, 2019
script Add script to fix corrupted tree-sitter Cabal stores. Dec 12, 2019
semantic-analysis 🔥 ConstraintKinds. Dec 12, 2019
semantic-ast Depend on newer tree-sitter. Dec 11, 2019
semantic-core Fix Generators module. Dec 11, 2019
semantic-java Depend on newer tree-sitter. Dec 11, 2019
semantic-json ++tree-sitter 0.7 Dec 10, 2019
semantic-python Emacs misfire. Dec 13, 2019
semantic-source Define `cabal.project` in `semantic-source` dir Oct 29, 2019
semantic-tags PureC is gone. Nov 8, 2019
src Re-export the effect module last. Dec 12, 2019
test Fix parse-examples. Dec 11, 2019
.dockerignore Exclude a bunch of one-off files. Oct 30, 2019
.ghci.sample Enable pretty-printing immediately. Nov 1, 2019
.ghci.semantic Move the build products dirs into script/ghci-flags. Nov 1, 2019
.gitattributes The fixtures are binary files, don't diff them. Jun 20, 2019
.gitignore Merge pull request #377 from github/sha-sha-sha-cha-cha-cha Nov 7, 2019
.gitmodules Kill tree-sitter-python submodule. Sep 8, 2019
.hlint.yaml Correct how we silence a lint. Oct 30, 2019
.hspec Add .hspec for depths default, make sure hspec version supports Feb 17, 2017
.stylish-haskell.yaml Merge remote-tracking branch 'origin/indexer-prototype' into deploy-t… Feb 20, 2019
.travis.yml Change directories after running semantic-source specific commands Oct 29, 2019
CODE_OF_CONDUCT.md Add code of conduct May 31, 2019
CONTRIBUTING.md v2-. Oct 30, 2019
Dockerfile Try a different approach for embedding the git commit sha Nov 7, 2019
LICENSE Use MIT license for code May 31, 2019
README.md Mention that semantic doesn't yet build on Windows. Dec 10, 2019
Setup.hs Use the simple build type. Jul 23, 2017
cabal.project 🔥 the local inclusion of haskell-tree-sitter. Dec 10, 2019
hie.yaml Tell hie-bios about the dependencies. Nov 1, 2019
semantic.cabal Depend on newer tree-sitter. Dec 11, 2019

README.md

Semantic

semantic is a Haskell library and command line tool for parsing, analyzing, and comparing source code.

In a hurry? Check out our documentation of example uses for the semantic command line tool.

Table of Contents
Usage
Language support
Development
Technology and architecture
Licensing

Usage

Run semantic --help for complete list of up-to-date options.

Parse

Usage: semantic parse ([--sexpression] | [--json] | [--json-graph] | [--symbols]
                      | [--dot] | [--show] | [--quiet]) [FILES...]
  Generate parse trees for path(s)

Available options:
  --sexpression            Output s-expression parse trees (default)
  --json                   Output JSON parse trees
  --json-graph             Output JSON adjacency list
  --symbols                Output JSON symbol list
  --dot                    Output DOT graph parse trees
  --show                   Output using the Show instance (debug only, format
                           subject to change without notice)
  --quiet                  Don't produce output, but show timing stats

Diff

Usage: semantic diff ([--sexpression] | [--json] | [--json-graph] | [--toc] |
                     [--dot] | [--show]) [FILE_A] [FILE_B]
  Compute changes between paths

Available options:
  --sexpression            Output s-expression diff tree (default)
  --json                   Output JSON diff trees
  --json-graph             Output JSON diff trees
  --toc                    Output JSON table of contents diff summary
  --dot                    Output the diff as a DOT graph
  --show                   Output using the Show instance (debug only, format
                           subject to change without notice)

Graph

Usage: semantic graph ([--imports] | [--calls]) [--packages] ([--dot] | [--json]
                      | [--show]) ([--root DIR] [--exclude-dir DIR]
                      DIR:LANGUAGE | FILE | --language ARG (FILES... | --stdin))
  Compute a graph for a directory or from a top-level entry point module

Available options:
  --imports                Compute an import graph (default)
  --calls                  Compute a call graph
  --packages               Include a vertex for the package, with edges from it
                           to each module
  --dot                    Output in DOT graph format (default)
  --json                   Output JSON graph
  --show                   Output using the Show instance (debug only, format
                           subject to change without notice)
  --root DIR               Root directory of project. Optional, defaults to
                           entry file/directory.
  --exclude-dir DIR        Exclude a directory (e.g. vendor)
  --language ARG           The language for the analysis.
  --stdin                  Read a list of newline-separated paths to analyze
                           from stdin.

Language support

Priority Language Parse Assign Diff ToC Symbols Import graph Call graph Control flow graph
1 Ruby 🚧
2 JavaScript 🚧
3 TypeScript 🚧
4 Python 🚧
5 Go 🚧
PHP
Java 🚧 🚧 🚧 🔶
JSON N/A N/A N/A N/A
JSX 🔶
Haskell 🚧 🚧 🚧 🔶 🚧
Markdown 🔶 N/A N/A N/A  
  • — Supported
  • 🔶 — Partial support
  • 🚧 — Under development

Development

semantic requires at least GHC 8.6.4 and Cabal 2.4. We strongly recommend using ghcup to sandbox GHC versions, as GHC packages installed through your OS's package manager may not install statically-linked versions of the GHC boot libraries. semantic currently builds only on Unix systems; users of other operating systems may wish to use the Docker images.

We use cabal's Nix-style local builds for development. To get started quickly:

git clone git@github.com:github/semantic.git
cd semantic
script/bootstrap
cabal v2-build
cabal v2-test
cabal v2-run semantic -- --help

stack as a build tool is not officially supported; there is an unofficial stack.yaml available, though we cannot make guarantees as to its stability.

Technology and architecture

Architecturally, semantic:

  1. Reads blobs.
  2. Generates parse trees for those blobs with tree-sitter (an incremental parsing system for programming tools).
  3. Assigns those trees into a generalized representation of syntax.
  4. Performs analysis, computes diffs, or just returns parse trees.
  5. Renders output in one of many supported formats.

Semantic leverages a number of interesting algorithms and techniques:

Contributions

Contributions are welcome! Please see our contribution guidelines and our code of conduct for details on how to participate in our community.

Licensing

Semantic is licensed under the MIT license.

You can’t perform that action at this time.