jhu-assembly-linter 0.1.7

A Linter for JHU's Assembly Classes

Assembly Style Linter

This linter was designed with Prof. Charles Kann's Computer Organization (EN.605.204) course in mind. It performs a strict but non-exhaustive lint; meaning it will not catch all errors but will be noisy and exacting about those that it does.

Install

pip install jhu-assembly-linter

Usage

$ jhu-assembly-linter ./path/to/file.s

E:: Tab found. Only spaces allowed.
18:     LDR x0, =helloWorld
    ^
E:: Instruction is not uppercase.
19:     mov     w8, #64     /* write is syscall #64 */
        ^
E:: Non-functional whitespace found.
20: 
    ^^^^^
E:: File name does not end with "Main" when it should.
21: main:

To lint a whole directory:

find . -name "*.s" | xargs -I{} jhu-assembly-linter  {}

To add a pre-commit hook to you repo:

repos:
-   repo: https://github.com/LogstonGradSchool/JhuAssemblyStyleLinter
    rev: <latest version>
    hooks:
    -   id: jhu-assembly-linter

Tests

tox

Deployment

poetry build
poetry publish