code.consxy.com Git - wolf/blob - README.md

   1 # Common Lisp Style Checker
   2 Enforcement of my guidelines for common lisp style.
   3
   4 If you like, you can [download it](https://github.com/frankduncan/style-checker/releases/download/0.1/style-checker_0.1.tar.gz)
   5
   6 ## Syntax Checking Rules
   7 * Elements on new line in each form must be indented the same amount
   8 * No space/newline after open parens
   9 * No form longer than 50 lines
  10 * Top level multiline forms must be separated by exactly one space
  11 * No line longer than 120 characters
  12 * No use of unexported symbols in other packages
  13 * No tabs
  14 * Only one space between elements in a form on a single line
  15 * in-package must be first line in file unless file is package.lisp
  16 * No whitespace at end of line
  17 * No lines that are only whitespace
  18 * No empty lines at end of file
  19 * Never have two empty lines in a row
  20 * Only one in-package per file
  21 * No hanging close parens
  22
  23 ### Exceptions
  24 * comments
  25 * multiline strings
  26 * exclude in-package check from package.lisp
  27
  28 ## Usage
  29
  30 ```
  31 (check-file file)
  32
  33 (check-directory dir)
  34
  35 (check-directory pretty-print-check-directory)
  36 ```