Important

This repository is now archived. Users are encouraged to use individual linting instead

These standards have been split out into their own repositories and exist within the LintKit group

Liquid Light Linter

Lint your code against Liquid Light conventions (yes, we use tabs and not spaces).

• Liquid Light Linter
  • Usage
    • lint run
    • self-update
  • Docker
    • CI
  • Installation
  • Adding Linters
  • Releasing
• Credits

Usage

Once installed, run the lint command to see the linters available. Most linters have functionality to fix most of the issues found, this can be run by adding --fix to the command

e.g.

lint php:coding-standards --fix

lint run

Out of the box, running a lint run will run

• scss:lint
• js:lint
• php:coding-standards
• lint composer:normalize

If, however, you want to run different linters (or lints with specific parameters), add a lint array to a scripts block in your composer.json. An example can be seen in this git repository's composer.json.

self-update

To update the linter once installed, run self-update

lint self-update

If you wish to be on the bleeding edge (or a feature branch), you can use the --dev option

The following will put you on the main branch

lint self-update --dev

Or you can go onto an active feature branch with the following:

lint self-update --dev [branch name]

e.g.

lint self-update --dev develop

Docker

The linker builds and makes available several docker containers. Should you wish to use these instead, you can run something like the following:

export DOCKER_DEFAULT_PLATFORM=linux/amd64; docker run -it --rm -v $(pwd):/app ghcr.io/liquidlight/lint/phpstan

This will use the latest tagged image, you can see all the linters in the Container Registry.

CI

To use the linter in Gitlab CI, you can use the following (where $IMAGE_NAME is the docker image)

lint:
  image: $IMAGE_NAME
  script:
    - /lint/lint run

All the linters can be found at /lint/lint run, it is just the image name which needs updating

Installation

To use the Git repo as the source, you will need to download & install dependencies, which requires composer and npm running.

git clone [email protected]:liquidlight/lint.git
cd lint
composer install --no-dev && npm i

You can then move to the directory you wish to lint and run

/path/to/lint/cloned/directory/lint.php

If you wish for this to be globally runnable, you can symlink the lint.php file

cd /usr/local/bin
ln -s  /path/to/lint/directory/lint.php lint

Then it can be used as above.

Adding Linters

When adding a new linter please:

• Name the linter the name of the tool it is using, rather than a generic "lint" name (e.g. php:coding-standards instead of php:lint)
• If it is the only, or most common linter for that language, feel free to alias lint
• The linter should report by default and fix if --fix is added (sometimes is involves adding --dry-run by default and removing if fixing is required)

Releasing

Before the release run the following:

• composer update - commit
• ncu and then npm update - commit
• Then prepare the release:
  • Move UPCOMING to CHANGELOG, set version & add date
  • Update the version in composer.json
  • Update the version package.json
  • Run a composer update
  • Run a npm update
  • Commit the result as release(major|minor|patch): X.X.X
  • Git tag
  • Run the pipelines

Once you have released, set the version in composer.json back to dev-main and commit

Credits

Lint roller icon created by Freepik - Flaticon