ESP32 Platform Documentation

StyleLint

This platform integrates StyleLint.

A mighty CSS linter that helps you avoid errors and enforce conventions.

Configuration

File `stylelint.config.js` in the root folder contains settings and code convention rules

Inline PHP

A custom plugin is included that removes inline PHP syntax

CI-CD

There is a CI-CD workflow `path/to/my/project/github/workflows/docs.yml` in place containing a step that automaticly scans the codebase. The output report is processed in a auto-generated .rst file which stores in `path/to/my/project/docs/report/` and included in the phpdocs guide when a push or pull request event triggers and is uploaded to the `gh-pages` branch.

Run locally

Follow these steps to run StyleLint locally

  1. Make sure npm packages are installed.
  2. If it is missing
    # cd to the root directory of the project folder

# This will install the dependencies set in package.json
npm install
  3. Open a terminal of choice and change current directory to the root directory.
  4. Run the following command
    npx stylelint "app/Views/**/*.php" --formatter tap

    This will report directly to the terminal

Search results