avs-origami / kiss-lint Goto Github PK

|-------------------------|
| KISS LINT               |     ,   ,
|-------------------------|    { \w/ }
| A package linter for    |     `>!<`
| Kiss Linux.             |     (/^\)
|-------------------------|     '   '
|=~=~=~=~=~=~=~=~=~=~=~=~=|

Kiss Lint is a WIP linter for Kiss Linux packages based on the style guide
(https://kisscommunity.bvnf.space/kiss/style-guide).

=== Building
============

Run 'cargo build --release'.

=== Testing
===========

The included 'test_pkg' is designed to throw every possible error that a package
could generate. Try running '../target/release/kiss-lint' from inside it.

=== Progress
============

This is a list of all parts of the style guide that are currently intended to
be added. This may extend to other parts in future, but at the moment these are
the parts that seem to be verifiable and/or are not covered by 'kiss c'.

[ ] Build
    [x] Shellcheck (#0201)
    [x] Indentation (#0202)
    [x] Line length (#0203)
    [x] POSIX shell shebang (#0204)
    [x] Quote entire strings (#0209)
    [x] Prefer $CC (#0212)
    [x] Use -p with mkdir (#0213)
    [x] Printf instead of echo (#0214)
    [ ] Build styles (#0400 thru #1150)

[x] Depends
    [x] Always available dependencies (#1202)
    [x] Make dependencies (#1203)
    [x] Sorted depends file (#1205)
    [x] Empty depends file (#1206)

[x] Sources
    [x] HTTPS sources (#1401)
    [x] Remote patches (#1402)
    [x] Git repositories (#1403)
    [x] Sources with www. and .git (#1404)

[x] Version
    [x] Git instead of 9999 (#1602)
    [x] Upstream and relative versions (#1603)

=== Contributing
================

Feel free to open an issue or pull request.