milo

module

v0.6.4 Latest Latest Go to latest Published: Nov 12, 2022 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wawandco/milo

Links

Open Source Insights

README ¶

Milo

Milo is a linter tool that will check for both syntax correctness and style recommendations in HTML files. The end goal is to have a single binary that could be used in the context of a CI server which could check the codebase HTML before PR's get merged.

Important Considerations

Milo will check the HTML syntax of HTML only. (see this)
Milo will also check some style best practices and point those as issues to fix.
Rules can be enabled/disabled. (See configuration)
Milo considers html partials and validates the rules that apply to these.
Milo considers erb and plush as part of the HTML.

Installation

You can download the precompiled Milo binary from the releases page.

With Go

If you have Go installed in your system you can build from source:

go install github.com/wawandco/milo/cmd/milo@latest

Github Action

On github you can use Milo action to run in your workflows. For example:

name: Main Workflow
on: [push]
jobs:
  lint:
    name: HTML Linting (Milo)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      # Run the milo 
      - uses: wawandco/milo-action@v0.2.0
        with:
          folder: "templates"
          version: "v0.6.0"

  lint-go:
    ...

See more instructions on the milo-action repo.

Usage

milo review [folder or file]

Example:

milo review templates
milo review templates/file.html

Configuration

By default Milo will run all the linters it has. However, some teams will want to disable some of the linters in the list, if this is your case you can add a .milo.yml file in the root of your codebase. Once you have installed Milo it can generate that file by running:

milo init

That .milo.yml will look like the following example:

output: text # could be `text`, `github` or `silent`
reviewers:
  - doctype/present 
  - ...

This file will be used by the Milo binary to determine which reviewers to run our files against.

Reviewers

Milo uses the following reviewers:

Head

[0001] Doctype must be declared.
[0002] Doctype must be valid.
[0004] <title> must be present inside <head> tag.
[0005] <style> must not be used.

Attributes

[0013] attr-lowercase: All attribute names must be in lowercase.
[0010] attr-no-duplication: Elements cannot have duplicate attributes.
[0019] attr-no-unnecessary-whitespace: No spaces between attribute names and values.
[0016] attr-unsafe-chars: Attribute values cannot contain unsafe chars.
[0018] attr-value-double-quotes: Attribute values must be in double quotes.
[0011] attr-value-not-empty: All attributes must have values.
[0012] alt-require: The alt attribute of an element must be present and alt attribute of area[href] and input[type=image] must have a value.
[0014] id-unique: The value of id attributes must be unique.

Inline

[0003] Inline css is not allowed p.e: style="background-color: red;".
[0009] inline-style-disabled: Inline style cannot be used.
[0017] inline-script-disabled: Inline script cannot be used.

Credits

This repo depends heavily in the following libraries that deserve all the credit for making Milo possible:

golang.org/net/html

We copied this in our source because we needed to make some modifications to it. Our goal long term goal is to contribute back as much as possible.

Copyright

Directories ¶

Path	Synopsis
cmd package cmd holds common things for different executable commands in this package.	package cmd holds common things for different executable commands in this package.
milo Main milo command.	Main milo command.
milo/help
milo/initialize Initialize package is in charge of initializing the repo by generating .milo.yml	Initialize package is in charge of initializing the repo by generating .milo.yml
milo/review Package review is in charge of the review command.	Package review is in charge of the review command.
milo/version
config Configuration package is in charge of loading configuration from `.milo.yml` file.	Configuration package is in charge of loading configuration from `.milo.yml` file.
internal
html Package html implements an HTML5-compliant tokenizer and parser.	Package html implements an HTML5-compliant tokenizer and parser.
html/atom Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".	Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".
html/charset Package charset provides common text encodings for HTML documents.	Package charset provides common text encodings for HTML documents.
output Output package contains different output formats for the result of running different results.	Output package contains different output formats for the result of running different results.
reviewers

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL