# 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
```
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/jhu-assembly-linter/",
"name": "jhu-assembly-linter",
"maintainer": "Paul Logston",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "pbulkle1@jh.edu",
"keywords": "jhu,assembly,linter",
"author": "Paul Logston",
"author_email": "pbulkle1@jh.edu",
"download_url": "https://files.pythonhosted.org/packages/1f/08/f2124eeca5fff66d4e7a4ed881fb5f863eed15226fdf5d46c4ec0f20061a/jhu_assembly_linter-0.1.7.tar.gz",
"platform": null,
"description": "# Assembly Style Linter\n\nThis linter was designed with Prof. Charles Kann's Computer Organization\n(EN.605.204) course in mind. It performs a strict but non-exhaustive lint;\nmeaning it will not catch all errors but will be noisy and exacting about those\nthat it does.\n\n## Install\n\n```\npip install jhu-assembly-linter\n```\n\n## Usage\n\n```\n$ jhu-assembly-linter ./path/to/file.s\n\nE:: Tab found. Only spaces allowed.\n18: LDR x0, =helloWorld\n ^\nE:: Instruction is not uppercase.\n19: mov w8, #64 /* write is syscall #64 */\n ^\nE:: Non-functional whitespace found.\n20: \n ^^^^^\nE:: File name does not end with \"Main\" when it should.\n21: main:\n```\n\nTo lint a whole directory:\n\n```\nfind . -name \"*.s\" | xargs -I{} jhu-assembly-linter {}\n```\n\nTo add a pre-commit hook to you repo:\n```\nrepos:\n- repo: https://github.com/LogstonGradSchool/JhuAssemblyStyleLinter\n rev: <latest version>\n hooks:\n - id: jhu-assembly-linter\n```\n\n### Tests\n\n```\ntox\n```\n\n### Deployment\n\n```\npoetry build\npoetry publish\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Linter for JHU's Assembly Classes",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://pypi.org/project/jhu-assembly-linter/",
"Repository": "https://github.com/LogstonGradSchool/JhuAssemblyStyleLinter"
},
"split_keywords": [
"jhu",
"assembly",
"linter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8fd8853d65eb7a6f090c522c57302f60faebc732fee5b01f5f783f109bfaeda6",
"md5": "5c9fe91640916d1ad2a7df764c4c9f78",
"sha256": "870fb5b559568ad1a2a87ce5afcd568d8b9b01d4049a100aac7492e6bed55608"
},
"downloads": -1,
"filename": "jhu_assembly_linter-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c9fe91640916d1ad2a7df764c4c9f78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5514,
"upload_time": "2023-06-25T18:03:03",
"upload_time_iso_8601": "2023-06-25T18:03:03.692256Z",
"url": "https://files.pythonhosted.org/packages/8f/d8/853d65eb7a6f090c522c57302f60faebc732fee5b01f5f783f109bfaeda6/jhu_assembly_linter-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f08f2124eeca5fff66d4e7a4ed881fb5f863eed15226fdf5d46c4ec0f20061a",
"md5": "8bc21a9415f648808b4aba1f5d29e969",
"sha256": "be158a9942ee6836bf0730dde31b473a636b03d9e0780b95d584acd677424b7d"
},
"downloads": -1,
"filename": "jhu_assembly_linter-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "8bc21a9415f648808b4aba1f5d29e969",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4607,
"upload_time": "2023-06-25T18:03:05",
"upload_time_iso_8601": "2023-06-25T18:03:05.472619Z",
"url": "https://files.pythonhosted.org/packages/1f/08/f2124eeca5fff66d4e7a4ed881fb5f863eed15226fdf5d46c4ec0f20061a/jhu_assembly_linter-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-25 18:03:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LogstonGradSchool",
"github_project": "JhuAssemblyStyleLinter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "jhu-assembly-linter"
}
JSON
